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>
2020-07-30 17:05:26 +08:00 · 2020-07-30 17:05:26 +08:00 · f5d43b1f25
parent 770e7378be
commit f5d43b1f25
10 changed files with 297 additions and 7 deletions
--- 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)
--- 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)

 ----------------------------------------------------------------

--- 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)

 ----------------------------------------------------------------

--- 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)

 ----------------------------------------------------------------

--- a/docs/docker.zh.md
+++ 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`
+
+----------------------------------------------------------------
+
+如果您有任何疑问或是困惑，欢迎与我们联系！
--- a/docs/manage.zh.md
+++ b/docs/manage.zh.md
@ -0,0 +1,14 @@
+# 运营指南
+
+## 检查任务队列的状态
+即将到来……
+
+## 设置用户为管理员
+``` shell
+node built/tools/mark-admin (用户名)
+```
+
+样例
+``` shell
+node built/tools/mark-admin @syuilo
+```
--- 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)

 ----------------------------------------------------------------

--- 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)

 ----------------------------------------------------------------

--- 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)

 ----------------------------------------------------------------

--- a/docs/setup.zh.md
+++ 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` ）
+
+----------------------------------------------------------------
+
+如果您有任何疑问或是困惑，欢迎与我们联系！