diff --git a/README.md b/README.md index 0aae1b332..ce0aa0941 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ Organize and store your files! Want to post a picture you have already uploaded? :package: Create your own instance ---------------------------------------------------------------- -Please see the [Setup and Installation Guide](./docs/setup.en.md). +Please see the [Setup and Installation Guide](https://misskey-hub.net/docs/install/install.html). :wrench: Contribution ---------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 87b100772..000000000 --- a/docs/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Docs -These docs are for contributors of Misskey or admins of instance of Misskey. -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 deleted file mode 100644 index adeafe3d3..000000000 --- a/docs/docker.en.md +++ /dev/null @@ -1,97 +0,0 @@ -Docker Guide -================================================================ - -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) - ----------------------------------------------------------------- - -*1.* Download Misskey ----------------------------------------------------------------- -1. Clone Misskey repository's master branch. - - `git clone -b master git://github.com/misskey-dev/misskey.git` - -2. Move to misskey directory. - - `cd misskey` - -3. Checkout to the [latest release](https://github.com/misskey-dev/misskey/releases/latest) tag. - - `git checkout master` - -*2.* Configure Misskey ----------------------------------------------------------------- - -Create configuration files with following: - -```bash -cd .config -cp example.yml default.yml -cp docker_example.env docker.env -``` - -### `default.yml` - -Edit this file the same as non-Docker environment. -However hostname of Postgresql, Redis and Elasticsearch are not `localhost`, they are set in `docker-compose.yml`. -The following is default hostname: - -| Service | Hostname | -|---------------|----------| -| Postgresql | `db` | -| Redis | `redis` | -| Elasticsearch | `es` | - -### `docker.env` - -Configure Postgresql in this file. -The minimum required settings are: - -| name | Description | -|---------------------|---------------| -| `POSTGRES_PASSWORD` | Password | -| `POSTGRES_USER` | Username | -| `POSTGRES_DB` | Database name | - -*3.* Configure Docker ----------------------------------------------------------------- -Edit `docker-compose.yml`. - -*4.* Build Misskey ----------------------------------------------------------------- -Build misskey with the following: - -`docker-compose build` - -*5.* Init DB ----------------------------------------------------------------- -``` shell -docker-compose run --rm web yarn run init -``` - -*6.* That is it. ----------------------------------------------------------------- -Well done! Now you have an environment to run Misskey. - -### Launch normally -Just `docker-compose up -d`. GLHF! - -### How to update your Misskey server to the latest version -1. `git stash` -2. `git checkout master` -3. `git pull` -4. `git submodule update --init` -5. `git stash pop` -6. `docker-compose build` -7. Check [ChangeLog](../CHANGELOG.md) for migration information -8. `docker-compose stop && docker-compose up -d` - -### How to execute [cli commands](manage.en.md): -`docker-compose run --rm web node built/tools/mark-admin @example` - ----------------------------------------------------------------- - -If you have any questions or trouble, feel free to contact us! diff --git a/docs/docker.fr.md b/docs/docker.fr.md deleted file mode 100644 index 840e5b5a2..000000000 --- a/docs/docker.fr.md +++ /dev/null @@ -1,91 +0,0 @@ -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 Chinois simplifié également disponible - Simplified Chinese version also available - 简体中文版同样可用](./docker.zh.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` - -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). - - `git checkout master` - -*2.* Configuration de Misskey ----------------------------------------------------------------- -1. `cp .config/example.yml .config/default.yml` Copiez le fichier `.config/example.yml` et renommez-le `default.yml`. -2. `cp .config/mongo_initdb_example.js .config/mongo_initdb.js` Copie le fichier `.config/mongo_initdb_example.js` et le renomme en `mongo_initdb.js`. -3. Editez `default.yml` et `mongo_initdb.js`. - -*3.* Configurer Docker ----------------------------------------------------------------- -Editez `docker-compose.yml`. - -*4.* Contruire Misskey ----------------------------------------------------------------- -Contruire l'image Docker avec: - -`docker-compose build` - -*5.* C'est tout ! ----------------------------------------------------------------- -Parfait, Vous avez un environnement prêt pour démarrer Misskey. - -### Lancer normalement -Utilisez la commande `docker-compose up -d`. GLHF! - -### How to update your Misskey server to the latest version -1. `git stash` -2. `git checkout master` -3. `git pull` -4. `git submodule update --init` -5. `git stash pop` -6. `docker-compose build` -7. Consultez le [ChangeLog](../CHANGELOG.md) pour avoir les éventuelles informations de migration -8. `docker-compose stop && docker-compose up -d` - -### Comment exécuter des [commandes](manage.fr.md) -`docker-compose run --rm web node built/tools/mark-admin @example` - -### Configuration d'ElasticSearch (pour la fonction de recherche) -*1.* Préparation de l'environnement ----------------------------------------------------------------- -1. Permet de créer le dossier d'accueil de la base ElasticSearch aves les bons droits - - `mkdir elasticsearch && chown 1000:1000 elasticsearch` - -2. Augmente la valeur max du paramètre map_count du système (valeur minimum pour pouvoir lancer ES) - - `sysctl -w vm.max_map_count=262144` - -*2.* Après lancement du docker-compose, initialisation de la base ElasticSearch ----------------------------------------------------------------- -1. Connexion dans le conteneur web - - `docker-compose -it web /bin/sh` - -2. Ajout du paquet curl - - `apk add curl` - -3. Création de la base ES - - `curl -X PUT "es:9200/misskey" -H 'Content-Type: application/json' -d'{ "settings" : { "index" : { } }}'` - -4. `exit` - ----------------------------------------------------------------- - -Si vous avez des questions ou des problèmes, n'hésitez pas à nous contacter ! diff --git a/docs/docker.ja.md b/docs/docker.ja.md deleted file mode 100644 index c660a9041..000000000 --- a/docs/docker.ja.md +++ /dev/null @@ -1,98 +0,0 @@ -Dockerを使ったMisskey構築方法 -================================================================ - -このガイドはDockerを使ったMisskeyセットアップ方法について解説します。 - -- [英語版もあります - 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/misskey-dev/misskey.git` - -2. misskeyディレクトリに移動 - - `cd misskey` - -3. [最新のリリース](https://github.com/misskey-dev/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 submodule update --init` -5. `git stash pop` -6. `docker-compose build` -7. [ChangeLog](../CHANGELOG.md)でマイグレーション情報を確認する -8. `docker-compose stop && docker-compose up -d` - -### cliコマンドを実行する方法: - -`docker-compose run --rm web node built/tools/mark-admin @example` - ----------------------------------------------------------------- - -なにかお困りのことがありましたらお気軽にご連絡ください。 diff --git a/docs/docker.zh.md b/docs/docker.zh.md deleted file mode 100644 index 5a494ea11..000000000 --- a/docs/docker.zh.md +++ /dev/null @@ -1,97 +0,0 @@ -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/misskey-dev/misskey.git` - -2. 进入 misskey 文件夹。 - - `cd misskey` - -3. 检查 [最新发布版](https://github.com/misskey-dev/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 submodule update --init` -5. `git stash pop` -6. `docker-compose build` -7. 检查 [更新日志](../CHANGELOG.md) 以获取升级迁移信息。 -8. `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/examples/misskey.nginx b/docs/examples/misskey.nginx deleted file mode 100644 index b558fb023..000000000 --- a/docs/examples/misskey.nginx +++ /dev/null @@ -1,71 +0,0 @@ -# Sample nginx configuration for Misskey -# -# 1. Replace example.tld to your domain -# 2. Copy to /etc/nginx/sites-available/ and then symlink from /etc/nginx/sites-enabled/ -# or copy to /etc/nginx/conf.d/ - -# For WebSocket -map $http_upgrade $connection_upgrade { - default upgrade; - '' close; -} - -proxy_cache_path /tmp/nginx_cache levels=1:2 keys_zone=cache1:16m max_size=1g inactive=720m use_temp_path=off; - -server { - listen 80; - listen [::]:80; - server_name example.tld; - - # For SSL domain validation - root /var/www/html; - location /.well-known/acme-challenge/ { allow all; } - location /.well-known/pki-validation/ { allow all; } - location / { return 301 https://$server_name$request_uri; } -} - -server { - listen 443 ssl http2; - listen [::]:443 ssl http2; - server_name example.tld; - ssl_session_cache shared:ssl_session_cache:10m; - - # To use Let's Encrypt certificate - ssl_certificate /etc/letsencrypt/live/example.tld/fullchain.pem; - ssl_certificate_key /etc/letsencrypt/live/example.tld/privkey.pem; - - # To use Debian/Ubuntu's self-signed certificate (For testing or before issuing a certificate) - #ssl_certificate /etc/ssl/certs/ssl-cert-snakeoil.pem; - #ssl_certificate_key /etc/ssl/private/ssl-cert-snakeoil.key; - - # SSL protocol settings - ssl_protocols TLSv1.2; - ssl_ciphers ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:AES128-SHA; - ssl_prefer_server_ciphers on; - - # Change to your upload limit - client_max_body_size 80m; - - # Proxy to Node - location / { - proxy_pass http://127.0.0.1:3000; - proxy_set_header Host $host; - proxy_http_version 1.1; - proxy_redirect off; - - # If it's behind another reverse proxy or CDN, remove the following. - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto https; - - # For WebSocket - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection $connection_upgrade; - - # Cache settings - proxy_cache cache1; - proxy_cache_lock on; - proxy_cache_use_stale updating; - add_header X-Cache $upstream_cache_status; - } -} diff --git a/docs/manage.en.md b/docs/manage.en.md deleted file mode 100644 index d310e9531..000000000 --- a/docs/manage.en.md +++ /dev/null @@ -1,14 +0,0 @@ -# Management guide - -## Check the status of the job queue -coming soon - -## Mark as 'admin' user -``` shell -node built/tools/mark-admin (Username) -``` - -e.g. -``` shell -node built/tools/mark-admin @syuilo -``` diff --git a/docs/manage.fr.md b/docs/manage.fr.md deleted file mode 100644 index 0b2b7ffc1..000000000 --- a/docs/manage.fr.md +++ /dev/null @@ -1,14 +0,0 @@ -# Guide d'administration - -## Vérifier le status de la file d'attente des taches -coming soon - -## Marquer un utilisateur en tant que 'admin' -``` shell -node built/tools/mark-admin (nom d'utilisateur) -``` - -Exemple : -``` shell -node built/tools/mark-admin @syuilo -``` diff --git a/docs/manage.ja.md b/docs/manage.ja.md deleted file mode 100644 index 55596add1..000000000 --- a/docs/manage.ja.md +++ /dev/null @@ -1,14 +0,0 @@ -# 運営ガイド - -## ジョブキューの状態を調べる -coming soon - -## 管理者ユーザーを設定する -``` shell -node built/tools/mark-admin (ユーザー名) -``` - -例: -``` shell -node built/tools/mark-admin @syuilo -``` diff --git a/docs/manage.zh.md b/docs/manage.zh.md deleted file mode 100644 index 520d15020..000000000 --- a/docs/manage.zh.md +++ /dev/null @@ -1,14 +0,0 @@ -# 运营指南 - -## 检查任务队列的状态 -即将到来…… - -## 设置用户为管理员 -``` shell -node built/tools/mark-admin (用户名) -``` - -样例 -``` shell -node built/tools/mark-admin @syuilo -``` diff --git a/docs/push-docker-hub.ja.md b/docs/push-docker-hub.ja.md deleted file mode 100644 index 923e4c16e..000000000 --- a/docs/push-docker-hub.ja.md +++ /dev/null @@ -1,28 +0,0 @@ -GitHub Actionsを使用してDocker Hubへpushする方法 -================================================================ - -[/.github/workflows/docker.yml](/.github/workflows/docker.yml) に -GitHub ActionによりDocker Hubへpushするワークフローが記述されています。 - -オリジナルリポジトリでは、リリースされたタイミングで `latest`, `<リリース名>` それぞれのタグでDocker Hubにpushされます。 -※ Docker Hub に`<ブランチ名>`のようなタグがあるかもしれませんが、こちらは自動push対象ではありません。 - -Fork先でこのワークフローを実行すると失敗します。 - -以下では、Fork先で自分のDocker Hubリポジトリにpushするようにする方法を記述します。 - -## 自分のDocker Hubリポジトリにpushするように設定する方法 - -1. Docker Hubでリポジトリを作成します。 -2. ワークフローファイルの [images](https://github.com/misskey-dev/misskey/blob/53f3b779bf16abcda4f6e026c51384f3b8fbcc62/.github/workflows/docker.yml#L20) を作成したリポジトリに置き換えます。 -3. GitHubにて [暗号化されたシークレット](https://docs.github.com/ja/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) を作成します。 - 作成が必要なのは `DOCKER_USERNAME` と `DOCKER_PASSWORD` で、それぞれDocker Hubのユーザーとパスワードになります。 - -## pushする方法 - -上記設定によりリリース時に自動的にDocker Hubにpushされるようになります。 -具体的には、GitHubのリリース機能でリリースしたタイミングで `latest`, `<リリース名>` それぞれのタグでDocker Hubにpushされます。 - -また、GitHub上から手動でpushすることも出来ます。 -それを行うには、Actions => Publish Docker image => Run workflow からbranchを選択してワークフローを実行します。 -ただし、この場合作成されるタグは`<ブランチ名>`になります。 diff --git a/docs/setup.en.md b/docs/setup.en.md deleted file mode 100644 index af6b2de9e..000000000 --- a/docs/setup.en.md +++ /dev/null @@ -1,147 +0,0 @@ -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) -- [Simplified Chinese version also available - 简体中文版同样可用](./setup.zh.md) - ----------------------------------------------------------------- - -*1.* Create Misskey user ----------------------------------------------------------------- -Running misskey as root is not a good idea so we create a user for that. -In debian for exemple : - -``` -adduser --disabled-password --disabled-login misskey -``` - -*2.* Install dependencies ----------------------------------------------------------------- -Please install and setup these softwares: - -#### Dependencies :package: -* **[Node.js](https://nodejs.org/en/)** (12.x, 14.x) -* **[PostgreSQL](https://www.postgresql.org/)** (12.x / 13.x is preferred) -* **[Redis](https://redis.io/)** - -##### Optional -* [Yarn](https://yarnpkg.com/) *Optional but recommended for security reason. If you won't install it, use `npx yarn` instead of `yarn`.* -* [Elasticsearch](https://www.elastic.co/) - required to enable the search feature -* [FFmpeg](https://www.ffmpeg.org/) - -*3.* Install Misskey ----------------------------------------------------------------- -1. Connect to misskey user. - - `su - misskey` - -2. Clone the misskey repo from master branch. - - `git clone --recursive -b master git://github.com/misskey-dev/misskey.git` - -3. Navigate to misskey directory - - `cd misskey` - -4. Checkout to the [latest release](https://github.com/misskey-dev/misskey/releases/latest) - - `git checkout master` - -5. Install misskey dependencies. - - `yarn` - -*4.* Configure Misskey ----------------------------------------------------------------- -1. Copy the `.config/example.yml` and rename it to `default.yml`. - - `cp .config/example.yml .config/default.yml` - -2. Edit `default.yml` - -*5.* Build Misskey ----------------------------------------------------------------- - -Build misskey with the following: - -`NODE_ENV=production yarn build` - -If you're on Debian, you will need to install the `build-essential`, `python` package. - -If you're still encountering errors about some modules, use node-gyp: - -1. `npx node-gyp configure` -2. `npx node-gyp build` -3. `NODE_ENV=production yarn build` - -*6.* Init DB ----------------------------------------------------------------- -``` shell -yarn run init -``` - -*7.* That is it. ----------------------------------------------------------------- -Well done! Now, you have an environment that run to Misskey. - -### Launch normally -Just `NODE_ENV=production npm start`. GLHF! - -### Launch with systemd - -1. Create a systemd service here - - `/etc/systemd/system/misskey.service` - -2. Edit it, and paste this and save: - - ``` - [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. Reload systemd and enable the misskey service. - - `systemctl daemon-reload ; systemctl enable misskey` - -4. Start the misskey service. - - `systemctl start misskey` - -You can check if the service is running with `systemctl status misskey`. - -### How to update your Misskey server to the latest version -1. `git checkout master` -2. `git pull` -3. `git submodule update --init` -4. `yarn install` -5. `NODE_ENV=production yarn build` -6. `yarn migrate` -7. Restart your Misskey process to apply changes -8. Enjoy - -If you encounter any problems with updating, please try the following: -1. `yarn clean` or `yarn cleanall` -2. Retry update (Don't forget `yarn install` - ----------------------------------------------------------------- - -If you have any questions or troubles, feel free to contact us! diff --git a/docs/setup.fr.md b/docs/setup.fr.md deleted file mode 100644 index d26ebe285..000000000 --- a/docs/setup.fr.md +++ /dev/null @@ -1,136 +0,0 @@ -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) -- [Version anglaise également disponible - English version also available - 英語版もあります](./setup.en.md) -- [Version Chinois simplifié également disponible - Simplified Chinese version also available - 简体中文版同样可用](./setup.zh.md) - ----------------------------------------------------------------- - -*1.* Création de l'utilisateur Misskey ----------------------------------------------------------------- -Executer misskey en tant que super-utilisateur étant une mauvaise idée, nous allons créer un utilisateur dédié. -Sous Debian, par exemple : - -``` -adduser --disabled-password --disabled-login misskey -``` - -*2.* Installation des dépendances ----------------------------------------------------------------- -Installez les paquets suivants : - -#### Dépendences :package: -* **[Node.js](https://nodejs.org/en/)** (12.x, 14.x) -* **[PostgreSQL](https://www.postgresql.org/)** (>= 10) -* **[Redis](https://redis.io/)** - -##### Optionnels -* [Yarn](https://yarnpkg.com/) - *recommander pour des raisons de sécurité. Si vous ne l'installez pas, utilisez `npx yarn` au lieu de` yarn`.* -* [Elasticsearch](https://www.elastic.co/) - *requis pour pouvoir activer la fonctionnalité de recherche.* -* [FFmpeg](https://www.ffmpeg.org/) - -*3.* Installation de Misskey ----------------------------------------------------------------- -1. Basculez vers l'utilisateur misskey. - - `su - misskey` - -2. Clonez la branche master du dépôt misskey. - - `git clone --recursive -b master git://github.com/misskey-dev/misskey.git` - -3. Accédez au dossier misskey. - - `cd misskey` - -4. Checkout sur le tag de la [version la plus récente](https://github.com/misskey-dev/misskey/releases/latest) - - `git checkout master` - -5. Installez les dépendances de misskey. - - `yarn install` - -*4.* Création du fichier de configuration ----------------------------------------------------------------- -1. Copiez le fichier `.config/example.yml` et renommez-le`default.yml`. - - `cp .config/example.yml .config/default.yml` - -2. Editez le fichier `default.yml` - -*5.* Construction de Misskey ----------------------------------------------------------------- - -Construisez Misskey comme ceci : - -`NODE_ENV=production yarn build` - -Si vous êtes sous Debian, vous serez amené à installer les paquets `build-essential` et `python`. - -Si vous rencontrez des erreurs concernant certains modules, utilisez node-gyp: - -1. `npx node-gyp configure` -2. `npx node-gyp build` -3. `NODE_ENV=production yarn build` - -*6.* C'est tout. ----------------------------------------------------------------- -Excellent ! Maintenant, vous avez un environnement prêt pour lancer Misskey - -### Lancement conventionnel -Lancez tout simplement `NODE_ENV=production yarn start`. Bonne chance et amusez-vous bien ! - -### Démarrage avec systemd - -1. Créez un service systemd sur - - `/etc/systemd/system/misskey.service` - -2. Editez-le puis copiez et coller ceci dans le fichier : - - ``` - [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. Redémarre systemd et active le service misskey. - - `systemctl daemon-reload ; systemctl enable misskey` - -4. Démarre le service misskey. - - `systemctl start misskey` - -Vous pouvez vérifier si le service a démarré en utilisant la commande `systemctl status misskey`. - -### Méthode de mise à jour vers la plus récente version de Misskey -1. `git checkout master` -2. `git pull` -3. `git submodule update --init` -4. `yarn install` -5. `NODE_ENV=production yarn build` -6. `yarn migrate` - ----------------------------------------------------------------- - -Si vous rencontrez des difficultés ou avez d'autres questions, n'hésitez pas à nous contacter ! diff --git a/docs/setup.ja.md b/docs/setup.ja.md deleted file mode 100644 index 6e1cbda87..000000000 --- a/docs/setup.ja.md +++ /dev/null @@ -1,145 +0,0 @@ -Misskey構築の手引き -================================================================ - -Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます！ -このガイドではMisskeyのインストール・セットアップ方法について解説します。 - -- [英語版もあります - English version also available](./setup.en.md) -- [简体中文版同样可用 - Simplified Chinese version also available](./setup.zh.md) - ----------------------------------------------------------------- - -*1.* Misskeyユーザーの作成 ----------------------------------------------------------------- -Misskeyはrootユーザーで実行しない方がよいため、代わりにユーザーを作成します。 -Debianの例: - -``` -adduser --disabled-password --disabled-login misskey -``` - -*2.* 依存関係をインストールする ----------------------------------------------------------------- -これらのソフトウェアをインストール・設定してください: - -#### 依存関係 :package: -* **[Node.js](https://nodejs.org/en/)** (12.x, 14.x) -* **[PostgreSQL](https://www.postgresql.org/)** (10以上) -* **[Redis](https://redis.io/)** - -##### オプション -* [Yarn](https://yarnpkg.com/) - * セキュリティの観点から推奨されます。 yarn をインストールしない方針の場合は、文章中の `yarn` を適宜 `npx yarn` と読み替えてください。 -* [Elasticsearch](https://www.elastic.co/) - * 検索機能を有効にするためにはインストールが必要です。 -* [FFmpeg](https://www.ffmpeg.org/) - -*3.* Misskeyのインストール ----------------------------------------------------------------- -1. misskeyユーザーを使用 - - `su - misskey` - -2. masterブランチからMisskeyレポジトリをクローン - - `git clone --recursive -b master git://github.com/misskey-dev/misskey.git` - -3. misskeyディレクトリに移動 - - `cd misskey` - -4. [最新のリリース](https://github.com/misskey-dev/misskey/releases/latest)を確認 - - `git checkout master` - -5. Misskeyの依存パッケージをインストール - - `yarn install` - -*4.* 設定ファイルを作成する ----------------------------------------------------------------- -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`パッケージをインストールする必要があります。 - -何らかのモジュールでエラーが発生する場合はnode-gypを使ってください: -1. `npx node-gyp configure` -2. `npx node-gyp build` -3. `NODE_ENV=production yarn build` - -*6.* データベースを初期化 ----------------------------------------------------------------- -``` shell -yarn run init -``` - -*7.* 以上です！ ----------------------------------------------------------------- -お疲れ様でした。これでMisskeyを動かす準備は整いました。 - -### 通常起動 -`NODE_ENV=production yarn start`するだけです。GLHF! - -### 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 - ``` - - CentOSで1024以下のポートを使用してMisskeyを使用する場合は`ExecStart=/usr/bin/sudo /usr/bin/npm start`に変更する必要があります。 - -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. `git submodule update --init` -4. `yarn install` -5. `NODE_ENV=production yarn build` -6. `yarn migrate` - -なにか問題が発生した場合は、`yarn clean`または`yarn cleanall`すると直る場合があります。 - ----------------------------------------------------------------- - -なにかお困りのことがありましたらお気軽にご連絡ください。 diff --git a/docs/setup.zh.md b/docs/setup.zh.md deleted file mode 100644 index 7a6c38b35..000000000 --- a/docs/setup.zh.md +++ /dev/null @@ -1,147 +0,0 @@ -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 --recursive -b master git://github.com/misskey-dev/misskey.git` - -3. 进入 misskey 文件夹。 - - `cd misskey` - -4. 检查 [最新发布版](https://github.com/misskey-dev/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. `git submodule update --init` -4. `yarn install` -5. `NODE_ENV=production yarn build` -6. `yarn migrate` -7. 重启您的 Misskey 进程来应用改变。 -8. 尽情享受吧！ - -如果您在更新时遇到任何问题，请尝试以下操作： -1. `yarn clean` 或是 `yarn cleanall` -2. 重试升级 （请不要忘记 `yarn install` ） - ----------------------------------------------------------------- - -如果您有任何疑问或是困惑，欢迎与我们联系！