From 0a0e76679e574727fbaa5251e415aee036e287de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Burdin?= Date: Thu, 10 Jan 2019 02:24:04 +0100 Subject: [PATCH] Add manage and docker docs in french and correct mistake in english (#3863) --- docs/docker.en.md | 2 +- docs/docker.fr.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++ docs/manage.fr.md | 18 +++++++++++++ 3 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 docs/docker.fr.md create mode 100644 docs/manage.fr.md diff --git a/docs/docker.en.md b/docs/docker.en.md index d1ca144f2..f0fcdb66d 100644 --- a/docs/docker.en.md +++ b/docs/docker.en.md @@ -17,7 +17,7 @@ This guide describes how to install and setup Misskey with Docker. ---------------------------------------------------------------- 1. `cp .config/example.yml .config/default.yml` Copy the `.config/example.yml` and rename it to `default.yml`. 2. `cp .config/mongo_initdb_example.js .config/mongo_initdb.js` Copy the `.config/mongo_initdb_example.js` and rename it to `mongo_initdb.js`. -2. Edit `default.yml` and `mongo_initdb.js`. +3. Edit `default.yml` and `mongo_initdb.js`. *3.* Configure Docker ---------------------------------------------------------------- diff --git a/docs/docker.fr.md b/docs/docker.fr.md new file mode 100644 index 000000000..c8eb54c7d --- /dev/null +++ b/docs/docker.fr.md @@ -0,0 +1,67 @@ +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) + +---------------------------------------------------------------- + +*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` Permet de se déplacer dans le dossier du dépôt. +3. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` Checkout sur le tag de la [dernière version](https://github.com/syuilo/misskey/releases/latest). + +*2.* Configuration de Misskey +---------------------------------------------------------------- +1. `cp .config/example.yml .config/default.yml` Copie le fichier `.config/example.yml` et le renommer en `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. Editer `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 fetch` +2. `git stash` +3. `git checkout $(git tag -l | grep -v 'rc[0-9]*$' | sort -V | tail -n 1)` +4. `git stash pop` +5. `docker-compose build` +6. Consultez le [ChangeLog](../CHANGELOG.md) pour avoir les éventuelles informations de migration +7. `docker-compose stop && docker-compose up -d` + +### Comment exécuter des [commandes](manage.fr.md) +`docker-compose run --rm web node cli/mark-admin @example` + +### 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) + +*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 +4. `exit` + +---------------------------------------------------------------- + +Si vous avez des questions ou des problèmes, n'hésitez pas à nous contacter ! \ No newline at end of file diff --git a/docs/manage.fr.md b/docs/manage.fr.md new file mode 100644 index 000000000..bf38e5ed9 --- /dev/null +++ b/docs/manage.fr.md @@ -0,0 +1,18 @@ +# 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 cli/mark-admin (ID utilisateur ou nom d'utilisateur) +``` + +Exemple : +``` shell +# Par id +node cli/mark-admin 57d01a501fdf2d07be417afe + +# Par nom d'utilisateur +node cli/suspend @syuilo +```