From 2e55aea584e11f7155636f2d30ebebc4d8dabc90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=8B=E3=81=B2=E3=82=8F=E3=81=974=EF=BC=88=E3=83=90?= =?UTF-8?q?=E3=83=BC=E3=82=B8=E3=83=A7=E3=83=B31=EF=BC=89?= <khws4v1@gmail.com> Date: Wed, 17 Apr 2019 02:15:27 +0900 Subject: [PATCH] Doc: Update setup documents (#4680) * Doc: Update setup documents Use GitHub api to checkout latest release instead of "git tag" command which cannot accurately determine prerelease tag. Also, Changed numbered list format because the shell command is too long to fit on one line. * Doc: Use tab instead of spaces * Doc: Use master branch as latest release tag master branch and latest release is the same. master branch merges develop branch with each latest release. --- docs/docker.en.md | 20 +++++++---- docs/docker.fr.md | 44 ++++++++++++++++++------ docs/docker.ja.md | 20 +++++++---- docs/setup.en.md | 85 +++++++++++++++++++++++++++++---------------- docs/setup.fr.md | 85 +++++++++++++++++++++++++++++---------------- docs/setup.ja.md | 88 ++++++++++++++++++++++++++++++----------------- 6 files changed, 228 insertions(+), 114 deletions(-) diff --git a/docs/docker.en.md b/docs/docker.en.md index 344279083b..701514e45f 100644 --- a/docs/docker.en.md +++ b/docs/docker.en.md @@ -9,9 +9,17 @@ This guide describes how to install and setup Misskey with Docker. *1.* Download Misskey ---------------------------------------------------------------- -1. `git clone -b master git://github.com/syuilo/misskey.git` Clone Misskey repository's master branch. -2. `cd misskey` Move to misskey directory. -3. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` Checkout to the [latest release](https://github.com/syuilo/misskey/releases/latest) tag. +1. Clone Misskey repository's master branch. + + `git clone -b master git://github.com/syuilo/misskey.git` + +2. Move to misskey directory. + + `cd misskey` + +3. Checkout to the [latest release](https://github.com/syuilo/misskey/releases/latest) tag. + + `git checkout master` *2.* Configure Misskey ---------------------------------------------------------------- @@ -71,9 +79,9 @@ Well done! Now you have an environment to run Misskey. Just `docker-compose up -d`. GLHF! ### How to update your Misskey server to the latest version -1. `git fetch` -2. `git stash` -3. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` +1. `git stash` +2. `git checkout master` +3. `git pull` 4. `git stash pop` 5. `docker-compose build` 6. Check [ChangeLog](../CHANGELOG.md) for migration information diff --git a/docs/docker.fr.md b/docs/docker.fr.md index e89a8f1b15..c43ab4f650 100644 --- a/docs/docker.fr.md +++ b/docs/docker.fr.md @@ -10,9 +10,17 @@ Ce guide explique comment installer et configurer Misskey avec Docker. *1.* Télécharger Misskey ---------------------------------------------------------------- -1. `git clone -b master git://github.com/syuilo/misskey.git` Clone le dépôt de Misskey sur la branche master. -2. `cd misskey` Naviguez dans le dossier du dépôt. -3. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` Checkout sur le tag de la [dernière version](https://github.com/syuilo/misskey/releases/latest). +1. Clone le dépôt de Misskey sur la branche master. + + `git clone -b master git://github.com/syuilo/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/syuilo/misskey/releases/latest). + + `git checkout master` *2.* Configuration de Misskey ---------------------------------------------------------------- @@ -38,9 +46,9 @@ Parfait, Vous avez un environnement prêt pour démarrer Misskey. Utilisez la commande `docker-compose up -d`. GLHF! ### How to update your Misskey server to the latest version -1. `git fetch` -2. `git stash` -3. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` +1. `git stash` +2. `git checkout master` +3. `git pull` 4. `git stash pop` 5. `docker-compose build` 6. Consultez le [ChangeLog](../CHANGELOG.md) pour avoir les éventuelles informations de migration @@ -52,14 +60,28 @@ Utilisez la commande `docker-compose up -d`. GLHF! ### Configuration d'ElasticSearch (pour la fonction de recherche) *1.* Préparation de l'environnement ---------------------------------------------------------------- -1. `mkdir elasticsearch && chown 1000:1000 elasticsearch` Permet de créer le dossier d'accueil de la base ElasticSearch aves les bons droits -2. `sysctl -w vm.max_map_count=262144` Augmente la valeur max du paramètre map_count du système (valeur minimum pour pouvoir lancer ES) +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. `docker-compose -it web /bin/sh` Connexion dans le conteneur web -2. `apk add curl` Ajout du paquet curl -3. `curl -X PUT "es:9200/misskey" -H 'Content-Type: application/json' -d'{ "settings" : { "index" : { } }}'` Création de la base ES +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` ---------------------------------------------------------------- diff --git a/docs/docker.ja.md b/docs/docker.ja.md index 9d702fa795..4aa84675e0 100644 --- a/docs/docker.ja.md +++ b/docs/docker.ja.md @@ -9,9 +9,17 @@ Dockerを使ã£ãŸMisskey構築方法 *1.* Misskeyã®ãƒ€ã‚¦ãƒ³ãƒãƒ¼ãƒ‰ ---------------------------------------------------------------- -1. `git clone -b master git://github.com/syuilo/misskey.git` masterブランãƒã‹ã‚‰Misskeyレãƒã‚¸ãƒˆãƒªã‚’クãƒãƒ¼ãƒ³ -2. `cd misskey` misskeyディレクトリã«ç§»å‹• -3. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` [最新ã®ãƒªãƒªãƒ¼ã‚¹](https://github.com/syuilo/misskey/releases/latest)ã‚’ç¢ºèª +1. masterブランãƒã‹ã‚‰Misskeyレãƒã‚¸ãƒˆãƒªã‚’クãƒãƒ¼ãƒ³ + + `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.* è¨å®šãƒ•ã‚¡ã‚¤ãƒ«ã®ä½œæˆã¨ç·¨é›† ---------------------------------------------------------------- @@ -71,9 +79,9 @@ docker-compose run --rm web npm run init `docker-compose up -d`ã™ã‚‹ã ã‘ã§ã™ã€‚GLHF! ### Misskeyを最新ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã«ã‚¢ãƒƒãƒ—デートã™ã‚‹æ–¹æ³•: -1. `git fetch` -2. `git stash` -3. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` +1. `git stash` +2. `git checkout master` +3. `git pull` 4. `git stash pop` 5. `docker-compose build` 6. [ChangeLog](../CHANGELOG.md)ã§ãƒžã‚¤ã‚°ãƒ¬ãƒ¼ã‚·ãƒ§ãƒ³æƒ…å ±ã‚’ç¢ºèªã™ã‚‹ diff --git a/docs/setup.en.md b/docs/setup.en.md index 45e3e2c68b..b38ef64a02 100644 --- a/docs/setup.en.md +++ b/docs/setup.en.md @@ -32,15 +32,32 @@ Please install and setup these softwares: *3.* Install Misskey ---------------------------------------------------------------- -1. `su - misskey` Connect to misskey user. -2. `git clone -b master git://github.com/syuilo/misskey.git` Clone the misskey repo from master branch. -3. `cd misskey` Navigate to misskey directory -4. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` Checkout to the [latest release](https://github.com/syuilo/misskey/releases/latest) -5. `npm install` Install misskey dependencies. +1. Connect to misskey user. + + `su - misskey` + +2. Clone the misskey repo from master branch. + + `git clone -b master git://github.com/syuilo/misskey.git` + +3. Navigate to misskey directory + + `cd misskey` + +4. Checkout to the [latest release](https://github.com/syuilo/misskey/releases/latest) + + `git checkout master` + +5. Install misskey dependencies. + + `npm install` *4.* Configure Misskey ---------------------------------------------------------------- -1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`. +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 @@ -74,37 +91,45 @@ Just `NODE_ENV=production npm start`. GLHF! ### Launch with systemd -1. Create a systemd service here: `/etc/systemd/system/misskey.service` +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 -``` + ``` + [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. -3. `systemctl daemon-reload ; systemctl enable misskey` Reload systemd and enable the misskey service. -4. `systemctl start misskey` 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 fetch` -2. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` +1. `git checkout master` +2. `git pull` 3. `npm install` 4. `NODE_ENV=production npm run build` 5. Check [ChangeLog](../CHANGELOG.md) for migration information diff --git a/docs/setup.fr.md b/docs/setup.fr.md index e6d36aeff8..7ab88a6cde 100644 --- a/docs/setup.fr.md +++ b/docs/setup.fr.md @@ -32,15 +32,32 @@ Installez les paquets suivants : *3.* Installation de Misskey ---------------------------------------------------------------- -1. `su - misskey` Basculez vers l'utilisateur misskey. -2. `git clone -b master git://github.com/syuilo/misskey.git` Clonez la branche master du dépôt misskey. -3. `cd misskey` Accédez au dossier misskey. -4. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` Checkout sur le tag de la [version la plus récente](https://github.com/syuilo/misskey/releases/latest) -5. `npm install` Installez les dépendances de misskey. +1. Basculez vers l'utilisateur misskey. + + `su - misskey` + +2. Clonez la branche master du dépôt misskey. + + `git clone -b master git://github.com/syuilo/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/syuilo/misskey/releases/latest) + + `git checkout master` + +5. Installez les dépendances de misskey. + + `npm install` *4.* Création du fichier de configuration ---------------------------------------------------------------- -1. `cp .config/example.yml .config/default.yml` Copiez le fichier `.config/example.yml` et renommez-le`default.yml`. +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 @@ -68,37 +85,45 @@ Lancez tout simplement `NODE_ENV=production npm start`. Bonne chance et amusez-v ### Démarrage avec systemd -1. Créez un service systemd sur : `/etc/systemd/system/misskey.service` +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 -``` + ``` + [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. -3. `systemctl daemon-reload ; systemctl enable misskey` Redémarre systemd et active le service misskey. -4. `systemctl start misskey` 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 fetch` -2. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` +1. `git checkout master` +2. `git pull` 3. `npm install` 4. `NODE_ENV=production npm run build` 5. Consultez [ChangeLog](../CHANGELOG.md) pour les information de migration. diff --git a/docs/setup.ja.md b/docs/setup.ja.md index 1b1730b69e..fcbef2af13 100644 --- a/docs/setup.ja.md +++ b/docs/setup.ja.md @@ -33,15 +33,32 @@ adduser --disabled-password --disabled-login misskey *3.* Misskeyã®ã‚¤ãƒ³ã‚¹ãƒˆãƒ¼ãƒ« ---------------------------------------------------------------- -1. `su - misskey` misskeyユーザーを使用 -2. `git clone -b master git://github.com/syuilo/misskey.git` masterブランãƒã‹ã‚‰Misskeyレãƒã‚¸ãƒˆãƒªã‚’クãƒãƒ¼ãƒ³ -3. `cd misskey` misskeyディレクトリã«ç§»å‹• -4. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` [最新ã®ãƒªãƒªãƒ¼ã‚¹](https://github.com/syuilo/misskey/releases/latest)ã‚’ç¢ºèª -5. `npm install` Misskeyã®ä¾å˜ãƒ‘ッケージをインストール +1. misskeyユーザーを使用 + + `su - misskey` + +2. masterブランãƒã‹ã‚‰Misskeyレãƒã‚¸ãƒˆãƒªã‚’クãƒãƒ¼ãƒ³ + + `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ã®ä¾å˜ãƒ‘ッケージをインストール + + `npm install` *4.* è¨å®šãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã™ã‚‹ ---------------------------------------------------------------- -1. `cp .config/example.yml .config/default.yml` `.config/example.yml`をコピーã—åå‰ã‚’`default.yml`ã«ã™ã‚‹ã€‚ +1. `.config/example.yml`をコピーã—åå‰ã‚’`default.yml`ã«ã™ã‚‹ã€‚ + + `cp .config/example.yml .config/default.yml` + 2. `default.yml` を編集ã™ã‚‹ã€‚ *5.* Misskeyã®ãƒ“ルド @@ -73,38 +90,47 @@ npm run init `NODE_ENV=production npm start`ã™ã‚‹ã ã‘ã§ã™ã€‚GLHF! ### systemdを用ã„ãŸèµ·å‹• -1. systemdサービスã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆ: `/etc/systemd/system/misskey.service` +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`ã«å¤‰æ›´ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ + ``` + [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サービスã®èµ·å‹• -3. `systemctl daemon-reload ; systemctl enable misskey` systemdã‚’å†èªã¿è¾¼ã¿ã—misskeyサービスを有効化 -4. `systemctl start misskey` misskeyサービスã®èµ·å‹• + `systemctl start misskey` `systemctl status misskey`ã¨å…¥åŠ›ã™ã‚‹ã¨ã€ã‚µãƒ¼ãƒ“スã®çŠ¶æ…‹ã‚’調ã¹ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ ### Misskeyを最新ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã«ã‚¢ãƒƒãƒ—デートã™ã‚‹æ–¹æ³•: -1. `git fetch` -2. `git checkout $(git tag -l | grep -Ev -- '-(rc|alpha)\.[0-9]+$' | sort -V | tail -n 1)` +1. `git checkout master` +2. `git pull` 3. `npm install` 4. `NODE_ENV=production npm run build` 5. [ChangeLog](../CHANGELOG.md)ã§ãƒžã‚¤ã‚°ãƒ¬ãƒ¼ã‚·ãƒ§ãƒ³æƒ…å ±ã‚’ç¢ºèªã™ã‚‹ -- GitLab