From f5d43b1f2595a0fd8a86373be59a55497a465c6d Mon Sep 17 00:00:00 2001 From: Nya Candy <20502130+Candinya@users.noreply.github.com> Date: Thu, 30 Jul 2020 17:05:26 +0800 Subject: [PATCH] Simplified Chinese Install & Setup Guides Added (#6604) * Simplified Chinese Install & Setup Guides Added * Using lists in navigation between languages * (Delete a closing bracket added by mistake Co-authored-by: Candinya <dev@lcy.moe> --- docs/README.md | 27 +++++++++ docs/docker.en.md | 3 +- docs/docker.fr.md | 5 +- docs/docker.ja.md | 3 +- docs/docker.zh.md | 96 ++++++++++++++++++++++++++++++ docs/manage.zh.md | 14 +++++ docs/setup.en.md | 3 +- docs/setup.fr.md | 4 +- docs/setup.ja.md | 3 +- docs/setup.zh.md | 146 ++++++++++++++++++++++++++++++++++++++++++++++ 10 files changed, 297 insertions(+), 7 deletions(-) create mode 100644 docs/docker.zh.md create mode 100644 docs/manage.zh.md create mode 100644 docs/setup.zh.md diff --git a/docs/README.md b/docs/README.md index b4ba573439..87b100772f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,3 +4,30 @@ Docs for users are located in `src/docs`. ã“れらã®ãƒ‰ã‚ュメントã¯Misskeyã®é–‹ç™ºè€…ã¾ãŸã¯Misskeyインスタンスé‹å–¶è€…å‘ã‘ã§ã™ã€‚ 利用者å‘ã‘ã®ãƒ‰ã‚ュメントã¯`src/docs`ã«ã‚ã‚Šã¾ã™ã€‚ + +这些文档是为 Misskey 的贡献者,或是 Misskey 实例的管ç†è€…准备的。 +为用户准备的文档放置在 `src/docs` 文件夹ä¸ã€‚ + +## 日本語版 + +- [Misskey構築ã®æ‰‹å¼•ã](./setup.ja.md) +- [é‹å–¶ã‚¬ã‚¤ãƒ‰](./manage.ja.md) +- [Dockerを使ã£ãŸMisskey構築方法](./docker.ja.md) + +## English Version + +- [Misskey Setup and Installation Guide](./setup.en.md) +- [Management guide](./manage.en.md) +- [Docker Guide](./docker.en.md) + +## Française Version + +- [Guide d'installation et de configuration de Misskey](./setup.fr.md) +- [Guide d'administration](./manage.fr.md) +- [Guide Docker](./docker.fr.md) + +## 简体ä¸æ–‡ç‰ˆ + +- [Misskey 设置和安装指å—](./setup.zh.md) +- [è¿è¥æŒ‡å—](./manage.zh.md) +- [Docker 部署指å—](./docker.zh.md) diff --git a/docs/docker.en.md b/docs/docker.en.md index 8920feb60b..965c89a513 100644 --- a/docs/docker.en.md +++ b/docs/docker.en.md @@ -3,7 +3,8 @@ Docker Guide This guide describes how to install and setup Misskey with Docker. -[Japanese version also available - 日本語版もã‚ã‚Šã¾ã™](./docker.ja.md) +- [Japanese version also available - 日本語版もã‚ã‚Šã¾ã™](./docker.ja.md) +- [Simplified Chinese version also available - 简体ä¸æ–‡ç‰ˆåŒæ ·å¯ç”¨](./docker.zh.md) ---------------------------------------------------------------- diff --git a/docs/docker.fr.md b/docs/docker.fr.md index d2795a5908..52d42ff2e6 100644 --- a/docs/docker.fr.md +++ b/docs/docker.fr.md @@ -3,8 +3,9 @@ Guide Docker 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 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) ---------------------------------------------------------------- diff --git a/docs/docker.ja.md b/docs/docker.ja.md index 2e2abfbed7..befcc9116b 100644 --- a/docs/docker.ja.md +++ b/docs/docker.ja.md @@ -3,7 +3,8 @@ Dockerを使ã£ãŸMisskey構築方法 ã“ã®ã‚¬ã‚¤ãƒ‰ã¯Dockerを使ã£ãŸMisskeyセットアップ方法ã«ã¤ã„ã¦è§£èª¬ã—ã¾ã™ã€‚ -[英語版もã‚ã‚Šã¾ã™ - English version also available](./docker.en.md) +- [英語版もã‚ã‚Šã¾ã™ - English version also available](./docker.en.md) +- [简体ä¸æ–‡ç‰ˆåŒæ ·å¯ç”¨ - Simplified Chinese version also available](./docker.zh.md) ---------------------------------------------------------------- diff --git a/docs/docker.zh.md b/docs/docker.zh.md new file mode 100644 index 0000000000..a9d050e95a --- /dev/null +++ b/docs/docker.zh.md @@ -0,0 +1,96 @@ +Docker éƒ¨ç½²æŒ‡å— +================================================================ + +这份指å—æ述了如何使用Docker安装并设置 Misskey 。 + +- [日本語版もã‚ã‚Šã¾ã™ - Japanese version also available](./docker.ja.md) +- [英語版もã‚ã‚Šã¾ã™ - English version also available](./docker.en.md) + +---------------------------------------------------------------- + +*1.* 下载 Misskey +---------------------------------------------------------------- +1. 克隆 Misskey 项目的 master 分支。 + + `git clone -b master git://github.com/syuilo/misskey.git` + +2. 进入 misskey 文件夹。 + + `cd misskey` + +3. 检查 [最新å‘布版](https://github.com/syuilo/misskey/releases/latest) æ ‡ç¾ã€‚ + + `git checkout master` + +*2.* é…ç½® Misskey +---------------------------------------------------------------- + +å¯ä»¥æŒ‰ç…§å¦‚下方å¼åˆ›å»ºé…置文件: + +``` bash +cd .config +cp example.yml default.yml +cp docker_example.env docker.env +``` + +### `default.yml` + +è¿™ä¸ªæ–‡ä»¶çš„ç¼–è¾‘å·¥ä½œåŸºæœ¬ä¸Žéž Docker 环境的版本相åŒã€‚ +但请注æ„, Postgresql〠Redis å’Œ Elasticsearch çš„ **主机å(hostname)** é…ç½®ä¸åº”该是 `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.* åˆå§‹åŒ–æ•°æ®åº“ +---------------------------------------------------------------- +``` bash +docker-compose run --rm web yarn run init +``` + +*6.* 完æˆäº†ï¼ +---------------------------------------------------------------- +干得ä¸é”™ï¼çŽ°åœ¨æ‚¨æ‹¥æœ‰äº†ä¸€ä¸ªå¯ä»¥è¿è¡ŒMisskey的环境啦。 + +### æ£å¸¸å¯åŠ¨ +åªéœ€è¦ `docker-compose up -d` å³å¯ã€‚玩得愉快! + +### 如何将您的 Misskey æœåŠ¡å™¨å‡çº§è‡³æœ€æ–°ç‰ˆæœ¬ +1. `git stash` +2. `git checkout master` +3. `git pull` +4. `git stash pop` +5. `docker-compose build` +6. 检查 [更新日志](../CHANGELOG.md) 以获å–å‡çº§è¿ç§»ä¿¡æ¯ã€‚ +7. `docker-compose stop && docker-compose up -d` + +### 如何执行 [控制å°æŒ‡ä»¤](manage.zh.md): +`docker-compose run --rm web node built/tools/mark-admin @example` + +---------------------------------------------------------------- + +如果您有任何疑问或是困惑,欢迎与我们è”ç³»ï¼ diff --git a/docs/manage.zh.md b/docs/manage.zh.md new file mode 100644 index 0000000000..520d150203 --- /dev/null +++ b/docs/manage.zh.md @@ -0,0 +1,14 @@ +# è¿è¥æŒ‡å— + +## æ£€æŸ¥ä»»åŠ¡é˜Ÿåˆ—çš„çŠ¶æ€ +å³å°†åˆ°æ¥â€¦â€¦ + +## 设置用户为管ç†å‘˜ +``` shell +node built/tools/mark-admin (用户å) +``` + +æ ·ä¾‹ +``` shell +node built/tools/mark-admin @syuilo +``` diff --git a/docs/setup.en.md b/docs/setup.en.md index f658b67c15..a68e369945 100644 --- a/docs/setup.en.md +++ b/docs/setup.en.md @@ -4,7 +4,8 @@ Misskey Setup and Installation Guide We thank you for your interest in setting up your Misskey server! This guide describes how to install and setup Misskey. -[Japanese version also available - 日本語版もã‚ã‚Šã¾ã™](./setup.ja.md) +- [Japanese version also available - 日本語版もã‚ã‚Šã¾ã™](./setup.ja.md) +- [Simplified Chinese version also available - 简体ä¸æ–‡ç‰ˆåŒæ ·å¯ç”¨](./setup.zh.md) ---------------------------------------------------------------- diff --git a/docs/setup.fr.md b/docs/setup.fr.md index 3bb33a491e..b16447c4f8 100644 --- a/docs/setup.fr.md +++ b/docs/setup.fr.md @@ -4,7 +4,9 @@ Guide d'installation et de configuration de Misskey Nous vous remerçions de l'intrêt que vous manifestez pour l'installation de votre propre instance Misskey ! Ce guide décrit les étapes à suivre afin d'installer et de configurer une instance Misskey. -[La version en japonnais est également disponible sur - 日本語版もã‚ã‚Šã¾ã™](./setup.ja.md) +- [La version en japonnais est également disponible sur - 日本語版もã‚ã‚Šã¾ã™](./setup.ja.md) +- [Version anglaise également disponible - English version also available - 英語版もã‚ã‚Šã¾ã™](./setup.en.md) +- [Version Chinois simplifié également disponible - Simplified Chinese version also available - 简体ä¸æ–‡ç‰ˆåŒæ ·å¯ç”¨](./setup.zh.md) ---------------------------------------------------------------- diff --git a/docs/setup.ja.md b/docs/setup.ja.md index 252858cf97..7f4ab69995 100644 --- a/docs/setup.ja.md +++ b/docs/setup.ja.md @@ -4,7 +4,8 @@ Misskey構築ã®æ‰‹å¼•ã Misskeyサーãƒãƒ¼ã®æ§‹ç¯‰ã«ã”関心をãŠå¯„ã›ã„ãŸã ãã‚ã‚ŠãŒã¨ã†ã”ã–ã„ã¾ã™ï¼ ã“ã®ã‚¬ã‚¤ãƒ‰ã§ã¯Misskeyã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ«ãƒ»ã‚»ãƒƒãƒˆã‚¢ãƒƒãƒ—方法ã«ã¤ã„ã¦è§£èª¬ã—ã¾ã™ã€‚ -[英語版もã‚ã‚Šã¾ã™ - English version also available](./setup.en.md) +- [英語版もã‚ã‚Šã¾ã™ - English version also available](./setup.en.md) +- [简体ä¸æ–‡ç‰ˆåŒæ ·å¯ç”¨ - Simplified Chinese version also available](./setup.zh.md) ---------------------------------------------------------------- diff --git a/docs/setup.zh.md b/docs/setup.zh.md new file mode 100644 index 0000000000..196e8a541d --- /dev/null +++ b/docs/setup.zh.md @@ -0,0 +1,146 @@ +Misskey è®¾ç½®å’Œå®‰è£…æŒ‡å— +================================================================ + +éžå¸¸æ„Ÿè°¢æ‚¨å¯¹æž„建 Misskey æœåŠ¡å™¨çš„å…³æ³¨ï¼ +这份指å—æ述了 Misskey 的安装与设置æµç¨‹ã€‚ + +- [日本語版もã‚ã‚Šã¾ã™ - Japanese version also available](./setup.ja.md) +- [英語版もã‚ã‚Šã¾ã™ - English version also available](./setup.en.md) + +---------------------------------------------------------------- + +*1.* 创建 Misskey 用户 +---------------------------------------------------------------- +直接使用 root 用户æ¥è¿è¡Œ misskey 也许并ä¸æ˜¯ä¸€ä¸ªå¥½ä¸»æ„ï¼Œå› æ¤æˆ‘们有必è¦åˆ›å»ºä¸€ä¸ªä¸“用的用户。 +以 Debian 为例: + +``` bash +adduser --disabled-password --disabled-login misskey +``` + +*2.* 安装ä¾èµ– +---------------------------------------------------------------- +请安装并设置如下这些软件: + +#### Dependencies :package: +* **[Node.js](https://nodejs.org/en/)** (12.x, 14.x) +* **[PostgreSQL](https://www.postgresql.org/)** (>= 10) +* **[Redis](https://redis.io/)** + +##### Optional +* [Yarn](https://yarnpkg.com/) *å¯é€‰ï¼Œä½†å‡ºäºŽå®‰å…¨å› ç´ è€ƒè™‘è¿˜æ˜¯æŽ¨è安装。如果您没有安装, 您需è¦ä½¿ç”¨ `npx yarn` æ¥ä»£æ›¿ `yarn`.* +* [Elasticsearch](https://www.elastic.co/) - 为了å¯ç”¨æœç´¢åŠŸèƒ½ï¼Œè¿™ä¸ªæœç´¢å¼•æ“Žæ˜¯æœ‰å¿…è¦çš„。 +* [FFmpeg](https://www.ffmpeg.org/) + +*3.* 安装 Misskey +---------------------------------------------------------------- +1. 连接至 misskey 用户. + + `su - misskey` + +2. 克隆 Misskey 项目的 master 分支。 + + `git clone -b master git://github.com/syuilo/misskey.git` + +3. 进入 misskey 文件夹。 + + `cd misskey` + +4. 检查 [最新å‘布版](https://github.com/syuilo/misskey/releases/latest) æ ‡ç¾ã€‚ + + `git checkout master` + +5. 安装 Misskey çš„ä¾èµ–。 + + `yarn` + +*4.* é…ç½® Misskey +---------------------------------------------------------------- +1. å¤åˆ¶ `.config/example.yml` 并é‡å‘½å为 `default.yml`。 + + `cp .config/example.yml .config/default.yml` + +2. 编辑 `default.yml` + +*5.* 构建 Misskey +---------------------------------------------------------------- + +使用如下的指令构建 Misskey : + +`NODE_ENV=production yarn build` + +如果您使用的是 Debian , 您需è¦å®‰è£… `build-essential`, `python` 环境包。 + +如果您ä»ç„¶é‡åˆ°æœ‰å…³æŸäº›æ¨¡å—的错误,您å¯ä»¥ä½¿ç”¨ node-gyp: + +1. `npx node-gyp configure` +2. `npx node-gyp build` +3. `NODE_ENV=production yarn build` + +*6.* åˆå§‹åŒ–æ•°æ®åº“ +---------------------------------------------------------------- +``` bash +yarn run init +``` + +*7.* 完æˆäº†ï¼ +---------------------------------------------------------------- +干得ä¸é”™ï¼çŽ°åœ¨æ‚¨æ‹¥æœ‰äº†ä¸€ä¸ªå¯ä»¥è¿è¡ŒMisskey的环境啦。 + +### æ£å¸¸å¯åŠ¨ +åªéœ€è¦ `NODE_ENV=production npm start` å³å¯ã€‚玩得愉快! + +### 使用 systemd æ¥å¯åŠ¨ + +1. 在æ¤å¤„创建一个 systemd æœåŠ¡ï¼š + + `/etc/systemd/system/misskey.service` + +2. 编辑它,粘贴如下内容并ä¿å˜ï¼š + + ``` + [Unit] + Description=Misskey daemon + + [Service] + Type=simple + User=misskey + ExecStart=/usr/bin/npm start + WorkingDirectory=/home/misskey/misskey + Environment="NODE_ENV=production" + TimeoutSec=60 + StandardOutput=syslog + StandardError=syslog + SyslogIdentifier=misskey + Restart=always + + [Install] + WantedBy=multi-user.target + ``` + +3. é‡å¯ systemd 并设置 misskey æœåŠ¡è‡ªåŠ¨å¯åŠ¨ï¼š + + `systemctl daemon-reload ; systemctl enable misskey` + +4. å¯åŠ¨ misskey æœåŠ¡ï¼š + + `systemctl start misskey` + +您å¯ä»¥ä½¿ç”¨ `systemctl status misskey` æ¥æ£€æŸ¥æœåŠ¡æ˜¯å¦æ£åœ¨è¿è¡Œã€‚ + +### 如何将您的 Misskey æœåŠ¡å™¨å‡çº§è‡³æœ€æ–°ç‰ˆæœ¬ +1. `git checkout master` +2. `git pull` +3. `yarn install` +4. `NODE_ENV=production yarn build` +5. `yarn migrate` +6. é‡å¯æ‚¨çš„ Misskey 进程æ¥åº”用改å˜ã€‚ +7. 尽情享å—å§ï¼ + +如果您在更新时é‡åˆ°ä»»ä½•é—®é¢˜ï¼Œè¯·å°è¯•ä»¥ä¸‹æ“作: +1. `yarn clean` 或是 `yarn cleanall` +2. é‡è¯•å‡çº§ (请ä¸è¦å¿˜è®° `yarn install` ) + +---------------------------------------------------------------- + +如果您有任何疑问或是困惑,欢迎与我们è”ç³»ï¼ -- GitLab