Create setup.fr.md (#3225)

2024-11-23 05:43:07 +02:00 · 2018-11-13 15:15:33 +00:00 · 2018-11-13 15:15:33 +00:00 · ebfaa18f12
commit ebfaa18f12
parent cc81d41a05
1 changed files with 126 additions and 0 deletions
--- a/docs/setup.fr.md
+++ b/docs/setup.fr.md
@ -0,0 +1,126 @@
+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)
+
+----------------------------------------------------------------
+
+*1.* Création de l'utilisateur Misskey
+----------------------------------------------------------------
+Lancer misskey en tant qu'utilisateur est une mauvaise idée, nous avons besoin de créer un utilisateur dédié.
+Sur Debian, à titre d'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/)** >= 10.0.0
+* **[MongoDB](https://www.mongodb.com/)** >= 3.6
+
+##### Optionnels
+* [Redis](https://redis.io/)
+  * Redis est optionnel mais nous vous recommandons vivement de l'installer
+* [Elasticsearch](https://www.elastic.co/) - requis pour pouvoir activer la fonctionnalité de recherche
+
+*3.* Paramètrage de MongoDB
+----------------------------------------------------------------
+En mode root :
+1. `mongo` Accédez au shell de mango
+2. `use misskey` Utilisez la base de données misskey
+3. `db.users.save( {dummy:"dummy"} )` Write dummy data to initialize the db.
+4. `db.createUser( { user: "misskey", pwd: "<password>", roles: [ { role: "readWrite", db: "misskey" } ] } )` Créez l'utilisateur misskey.
+5. `exit` Vous avez terminé !
+
+*4.* 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 -v 'rc[0-9]*$' | sort -V | tail -n 1)` Télécharge la [version la plus récente](https://github.com/syuilo/misskey/releases/latest)
+5. `npm install` Installez les dépendances de misskey.
+
+*(optionnel)* Génération des clés VAPID
+----------------------------------------------------------------
+Si vous désirez activer ServiceWorker, vous devez générer les clés VAPID :
+Unless you have set your global node_modules location elsewhere, vous devez lancer ceci en mode root.
+
+``` shell
+npm install web-push -g
+web-push generate-vapid-keys
+```
+
+*5.* 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`.
+2. Editez le fichier `default.yml`
+
+*6.* Construction de Misskey
+----------------------------------------------------------------
+
+Construisez Misskey comme ceci :
+
+`npm run build`
+
+Si vous êtes sous Debian, vous serez amené à installer les paquets `build-essential`, `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. `npm run build`
+
+*7.* C'est tout.
+----------------------------------------------------------------
+Excellent ! Maintenant, vous avez un environnement prêt pour lancer Misskey
+
+### Lancement conventionnel
+Lancez tout simplement `npm start`. Bonne chance et amusez-vous bien !
+
+### Démarrage avec systemd
+
+1. Créez une 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
+TimeoutSec=60
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=misskey
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
+```
+
+3. `systemctl daemon-reload ; systemctl enable misskey` Redémarre systemd et active le service misskey.
+4. `systemctl start misskey` Démarre le service 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 -v 'rc[0-9]*$' | sort -V | tail -n 1)`
+3. `npm install`
+4. `npm run build`
+5. Consultez [ChangeLog](../CHANGELOG.md) pour les information de migration.
+
+----------------------------------------------------------------
+
+Si vous rencontrez des difficultés ou avez d'autres questions, n'hésitez pas à nous contacter !