Add Korean document and edit git url

kokonect-link · May 31, 2021 · 18ef21b · 18ef21b
1 parent a64da5a
commit 18ef21b
Show file tree

Hide file tree

Showing 8 changed files with 133 additions and 10 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -8,6 +8,9 @@ Docs for users are located in `src/docs`.
 这些文档是为 Misskey 的贡献者，或是 Misskey 实例的管理者准备的。
 为用户准备的文档放置在 `src/docs` 文件夹中。
 
+이 문서는 Misskey의 개발자 또는 Misskey 인스턴스 운영자용입니다.
+이용자용 문서는 `src/docs`에 있습니다.
+
 ## 日本語版
 
 - [Misskey構築の手引き](./setup.ja.md)
@@ -31,3 +34,9 @@ Docs for users are located in `src/docs`.
 - [Misskey 设置和安装指南](./setup.zh.md)
 - [运营指南](./manage.zh.md)
 - [Docker 部署指南](./docker.zh.md)
+
+## 한국어 버전
+
+- [Misskey 설치 가이드](./setup.ko.md)
+- [운영 가이드](./manage.ko.md)
+- [Docker 가이드](./docker.ko.md)
diff --git a/docs/docker.en.md b/docs/docker.en.md
@@ -5,20 +5,21 @@ This guide describes how to install and setup Misskey with Docker.
 
 - [Japanese version also available - 日本語版もあります](./docker.ja.md)
 - [Simplified Chinese version also available - 简体中文版同样可用](./docker.zh.md)
+- [Korean version also available - 韓国語版もあります](./docker.ko.md)
 
 ----------------------------------------------------------------
 
 *1.* Download Misskey
 ----------------------------------------------------------------
 1. Clone Misskey repository's master branch.
 
-	`git clone -b master git://github.com/misskey-dev/misskey.git`
+	`git clone -b master git://github.com/kokonect-link/misskey.git`
 
 2. Move to misskey directory.
 
 	`cd misskey`
 
-3. Checkout to the [latest release](https://github.com/misskey-dev/misskey/releases/latest) tag.
+3. Checkout to the [latest release](https://github.com/kokonect-link/misskey/releases/latest) tag.
 
 	`git checkout master`
 

diff --git a/docs/docker.fr.md b/docs/docker.fr.md
@@ -6,20 +6,21 @@ Ce guide explique comment installer et configurer Misskey avec Docker.
 - [Version japonaise également disponible - Japanese version also available - 日本語版もあります](./docker.ja.md)  
 - [Version anglaise également disponible - English version also available - 英語版もあります](./docker.en.md)
 - [Version Chinois simplifié également disponible - Simplified Chinese version also available - 简体中文版同样可用](./docker.zh.md)
+- [Il existe également une version coréenne - Korean version also available - 한국어판도 있어요!](./docker.ko.md)
 
 ----------------------------------------------------------------
 
 *1.* Télécharger Misskey
 ----------------------------------------------------------------
 1. Clone le dépôt de Misskey sur la branche master.
 
-	`git clone -b master git://github.com/misskey-dev/misskey.git`
+	`git clone -b master git://github.com/kokonect-link/misskey.git`
 
 2. Naviguez dans le dossier du dépôt.
 
 	`cd misskey`
 
-3. Checkout sur le tag de la [dernière version](https://github.com/misskey-dev/misskey/releases/latest).
+3. Checkout sur le tag de la [dernière version](https://github.com/kokonect-link/misskey/releases/latest).
 
 	`git checkout master`
 

diff --git a/docs/docker.ja.md b/docs/docker.ja.md
@@ -5,20 +5,21 @@ Dockerを使ったMisskey構築方法
 
 - [英語版もあります - English version also available](./docker.en.md)
 - [简体中文版同样可用 - Simplified Chinese version also available](./docker.zh.md)
+- [韓国語版もあります - Korean version also available](./docker.ko.md)
 
 ----------------------------------------------------------------
 
 *1.* Misskeyのダウンロード
 ----------------------------------------------------------------
 1. masterブランチからMisskeyレポジトリをクローン
 
-	`git clone -b master git://github.com/misskey-dev/misskey.git`
+	`git clone -b master git://github.com/kokonect-link/misskey.git`
 
 2. misskeyディレクトリに移動
 
 	`cd misskey`
 
-3. [最新のリリース](https://github.com/misskey-dev/misskey/releases/latest)を確認
+3. [最新のリリース](https://github.com/kokonect-link/misskey/releases/latest)を確認
 
 	`git checkout master`
 

diff --git a/docs/docker.ko.md b/docs/docker.ko.md
@@ -0,0 +1,97 @@
+Docker를 사용해서 Misskey 구축
+================================================================
+
+이 가이드는 Docker를 사용해서 Misskey를 설정하는 방법에 대해 설명합니다.
+
+- [일본어 버전도 있어요 - Japanese version also available - 日本語版もあります](./docker.ja.md)
+- [영어 버전도 있어요 - English version also available - 英語版もあります](./docker.en.md)
+- [중국어 버전도 있어요 - Simplified Chinese version also available - 简体中文版同样可用](./docker.zh.md)
+
+----------------------------------------------------------------
+
+*1.* Misskey 다운로드
+----------------------------------------------------------------
+1. master 브랜치에서 Misskey 저장소 클론
+
+	`git clone -b master git://github.com/kokonect-link/misskey.git`
+
+2. misskey 디렉토리로 이동
+
+	`cd misskey`
+
+3. [최신 릴리즈](https://github.com/kokonect-link/misskey/releases/latest) 확인
+
+	`git checkout master`
+
+*2.* 설정 파일 작성
+----------------------------------------------------------------
+
+아래 명령으로 설정 파일을 작성합니다.
+
+```bash
+cd .config
+cp example.yml default.yml
+cp docker_example.env docker.env
+```
+
+### `default.yml` 편집
+
+비 Docker 환경과 동일하게 편집합니다.  
+단, Postgresql, Redis와 Elasticsearch의 호스트는 `localhost`가 아니고, `docker-compose.yml`로 설정된 서비스명으로 되어 있습니다.  
+표준 설정에서는 다음과 같습니다.
+
+| 서비스          | 호스트명  |
+|---------------|---------|
+| Postgresql    |`db`     |
+| Redis         |`redis`  |
+| Elasticsearch |`es`     |
+
+### `docker.env` 편집
+
+이 파일은 Postgresql 설정을 정의합니다.  
+반드시 정의해야 하는 설정은 다음과 같습니다.
+
+| 설정                 | 내용          |
+|---------------------|--------------|
+| `POSTGRES_PASSWORD` | 비밀번호       |
+| `POSTGRES_USER`     | 유저명         |
+| `POSTGRES_DB`       | 데이터베이스명   |
+
+*3.* Docker 설정
+----------------------------------------------------------------
+`docker-compose.yml`를 편집합니다.
+
+*4.* Misskey 빌드
+----------------------------------------------------------------
+다음 명령으로 Misskey를 빌드할 수 있습니다:
+
+`docker-compose build`
+
+*5.* 데이터베이스 초기화
+----------------------------------------------------------------
+``` shell
+docker-compose run --rm web yarn run init
+```
+
+*6.* 끝났어요!
+----------------------------------------------------------------
+수고 많으셨습니다. 이것으로 Misskey를 사용할 준비가 되었습니다.
+
+### 실행
+`docker-compose up -d`만 입력하면 됩니다. GLHF!
+
+### Misskey를 최신 버전으로 업데이트 하는 방법:
+1. `git stash`
+2. `git checkout master`
+3. `git pull`
+4. `git stash pop`
+5. `docker-compose build`
+6. [ChangeLog](../CHANGELOG.md)에서 마이그레이션 정보 확인
+7. `docker-compose stop && docker-compose up -d`
+
+### [cli 명령](manage.ko.md)을 실행하는 방법:
+`docker-compose run --rm web node built/tools/mark-admin @example`
+
+----------------------------------------------------------------
+
+해결하기 어려운 문제가 발생한 경우, 부담없이 연락 주세요 :D
diff --git a/docs/docker.zh.md b/docs/docker.zh.md
@@ -12,13 +12,13 @@ Docker 部署指南
 ----------------------------------------------------------------
 1. 克隆 Misskey 项目的 master 分支。
 
-	`git clone -b master git://github.com/misskey-dev/misskey.git`
+	`git clone -b master git://github.com/kokonect-link/misskey.git`
 
 2. 进入 misskey 文件夹。
 
 	`cd misskey`
 
-3. 检查 [最新发布版](https://github.com/misskey-dev/misskey/releases/latest) 标签。
+3. 检查 [最新发布版](https://github.com/kokonect-link/misskey/releases/latest) 标签。
 
 	`git checkout master`
 

diff --git a/docs/manage.ko.md b/docs/manage.ko.md
@@ -0,0 +1,14 @@
+# 운영 가이드
+
+## 작업 대기열의 상태 확인
+coming soon
+
+## 관리자로 사용할 유저 설정
+``` shell
+node built/tools/mark-admin (유저 이름)
+```
+
+예:
+``` shell
+node built/tools/mark-admin @syuilo
+```
diff --git a/docs/setup.ko.md b/docs/setup.ko.md
@@ -42,15 +42,15 @@ adduser --disabled-password --disabled-login misskey
 
 	`su - misskey`
 
-2. master 브랜치에서 Misskey 저장소를 클론
+2. master 브랜치에서 Misskey 저장소 클론
 
 	`git clone -b master git://github.com/kokonect-link/misskey.git`
 
 3. misskey 디렉토리로 이동
 
 	`cd misskey`
 
-4. [최신 릴리즈](https://github.com/kokonect-link/misskey/releases/latest)를 확인
+4. [최신 릴리즈](https://github.com/kokonect-link/misskey/releases/latest) 확인
 
 	`git checkout master`