diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docker.en.md | 2 | ||||
| -rw-r--r-- | docs/docker.ja.md | 2 | ||||
| -rw-r--r-- | docs/setup.en.md | 24 | ||||
| -rw-r--r-- | docs/setup.fr.md | 22 | ||||
| -rw-r--r-- | docs/setup.ja.md | 27 |
5 files changed, 41 insertions, 36 deletions
diff --git a/docs/docker.en.md b/docs/docker.en.md index 701514e45f..a1ddecf62b 100644 --- a/docs/docker.en.md +++ b/docs/docker.en.md @@ -68,7 +68,7 @@ Build misskey with the following: *5.* Init DB ---------------------------------------------------------------- ``` shell -docker-compose run --rm web npm run init +docker-compose run --rm web yarn run init ``` *6.* That is it. diff --git a/docs/docker.ja.md b/docs/docker.ja.md index 4aa84675e0..cc26caadf4 100644 --- a/docs/docker.ja.md +++ b/docs/docker.ja.md @@ -68,7 +68,7 @@ cp docker_example.env docker.env *5.* データベースを初期化 ---------------------------------------------------------------- ``` shell -docker-compose run --rm web npm run init +docker-compose run --rm web yarn run init ``` *6.* 以上です！ diff --git a/docs/setup.en.md b/docs/setup.en.md index 3020380037..6dfbdbfeac 100644 --- a/docs/setup.en.md +++ b/docs/setup.en.md @@ -27,6 +27,7 @@ Please install and setup these softwares: * **[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/) @@ -50,7 +51,7 @@ Please install and setup these softwares: 5. Install misskey dependencies. - `npm install` + `yarn` *4.* Configure Misskey ---------------------------------------------------------------- @@ -65,21 +66,20 @@ Please install and setup these softwares: Build misskey with the following: -`NODE_ENV=production npm run build` +`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. `npm install -g node-gyp` -2. `node-gyp configure` -3. `node-gyp build` -4. `NODE_ENV=production npm run build` +1. `npx node-gyp configure` +2. `npx node-gyp build` +3. `NODE_ENV=production yarn build` *6.* Init DB ---------------------------------------------------------------- ``` shell -npm run init +yarn run init ``` *7.* That is it. @@ -130,12 +130,16 @@ 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. `npm install` -4. `NODE_ENV=production npm run build` -5. `npm run migrate` +3. `yarn install` +4. `NODE_ENV=production yarn build` +5. `yarn migrate` 6. Restart your Misskey process to apply changes 7. 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 index 09ab305b43..4ee0442c95 100644 --- a/docs/setup.fr.md +++ b/docs/setup.fr.md @@ -27,7 +27,8 @@ Installez les paquets suivants : * **[Redis](https://redis.io/)** ##### Optionnels -* [Elasticsearch](https://www.elastic.co/) - requis pour pouvoir activer la fonctionnalité de recherche +* [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 @@ -50,7 +51,7 @@ Installez les paquets suivants : 5. Installez les dépendances de misskey. - `npm install` + `yarn install` *4.* Création du fichier de configuration ---------------------------------------------------------------- @@ -65,23 +66,22 @@ Installez les paquets suivants : Construisez Misskey comme ceci : -`NODE_ENV=production npm run build` +`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. `npm install -g node-gyp` -2. `node-gyp configure` -3. `node-gyp build` -4. `NODE_ENV=production npm run build` +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 npm start`. Bonne chance et amusez-vous bien ! +Lancez tout simplement `NODE_ENV=production yarn start`. Bonne chance et amusez-vous bien ! ### Démarrage avec systemd @@ -124,9 +124,9 @@ Vous pouvez vérifier si le service a démarré en utilisant la commande `system ### Méthode de mise à jour vers la plus récente version de Misskey 1. `git checkout master` 2. `git pull` -3. `npm install` -4. `NODE_ENV=production npm run build` -5. `npm run migrate` +3. `yarn install` +4. `NODE_ENV=production yarn build` +5. `yarn migrate` ---------------------------------------------------------------- diff --git a/docs/setup.ja.md b/docs/setup.ja.md index e8a11de69b..444827e1f1 100644 --- a/docs/setup.ja.md +++ b/docs/setup.ja.md @@ -27,6 +27,8 @@ adduser --disabled-password --disabled-login misskey * **[Redis](https://redis.io/)** ##### オプション +* [Yarn](https://yarnpkg.com/) + * セキュリティの観点から推奨されます。 yarn をインストールしない方針の場合は、文章中の `yarn` を適宜 `npx yarn` と読み替えてください。 * [Elasticsearch](https://www.elastic.co/) * 検索機能を有効にするためにはインストールが必要です。 * [FFmpeg](https://www.ffmpeg.org/) @@ -51,7 +53,7 @@ adduser --disabled-password --disabled-login misskey 5. Misskeyの依存パッケージをインストール - `npm install` + `yarn install` *4.* 設定ファイルを作成する ---------------------------------------------------------------- @@ -66,20 +68,19 @@ adduser --disabled-password --disabled-login misskey 次のコマンドでMisskeyをビルドしてください: -`NODE_ENV=production npm run build` +`NODE_ENV=production yarn build` Debianをお使いであれば、`build-essential`パッケージをインストールする必要があります。 何らかのモジュールでエラーが発生する場合はnode-gypを使ってください: -1. `npm install -g node-gyp` -2. `node-gyp configure` -3. `node-gyp build` -4. `NODE_ENV=production npm run build` +1. `npx node-gyp configure` +2. `npx node-gyp build` +3. `NODE_ENV=production yarn build` *6.* データベースを初期化 ---------------------------------------------------------------- ``` shell -npm run init +yarn run init ``` *7.* 以上です！ @@ -87,7 +88,7 @@ npm run init お疲れ様でした。これでMisskeyを動かす準備は整いました。 ### 通常起動 -`NODE_ENV=production npm start`するだけです。GLHF! +`NODE_ENV=production yarn start`するだけです。GLHF! ### systemdを用いた起動 1. systemdサービスのファイルを作成 @@ -120,7 +121,7 @@ npm run init 3. systemdを再読み込みしmisskeyサービスを有効化 - `systemctl daemon-reload ; systemctl enable misskey` + `systemctl daemon-reload; systemctl enable misskey` 4. misskeyサービスの起動 @@ -131,11 +132,11 @@ npm run init ### Misskeyを最新バージョンにアップデートする方法: 1. `git checkout master` 2. `git pull` -3. `npm install` -4. `NODE_ENV=production npm run build` -5. `npm run migrate` +3. `yarn install` +4. `NODE_ENV=production yarn build` +5. `yarn migrate` -なにか問題が発生した場合は、`npm run clean`または`npm run cleanall`すると直る場合があります。 +なにか問題が発生した場合は、`yarn clean`または`yarn cleanall`すると直る場合があります。 ---------------------------------------------------------------- |