Merge pull request #242 from bugsysop/documentation

Documentation
2024-09-03 20:15:59 +02:00 · 2023-04-19 20:25:13 +02:00 · 2023-04-19 20:25:13 +02:00 · 433e209fc2
commit 433e209fc2
parent f970013ac1 f737997a5f
5 changed files with 89 additions and 11 deletions
--- a/doc/DESCRIPTION_fr.md
+++ b/doc/DESCRIPTION_fr.md
@ -0,0 +1,5 @@
+Pleroma est un logiciel serveur de microblog qui peut fédérer (c’est à dire échanger des messages) avec d’autres serveurs qui supportent le protocole ActivityPub. Cela signifie que vous pouvez héberger un serveur pour vous ou vos amis et garder le contrôle de votre identité en ligne, tout en communiquant avec des personnes hébergées sur des serveurs différents et plus importants tel que Friendica, GNU Social, Hubzilla, Mastodon, Misskey, Peertube, ou Pixelfed.
+
+Pour des informations plus détaillées sur Pleroma voir [What is Pleroma](https://blog.soykaf.com/post/what-is-pleroma/)
+
+**Interface utilisateur Mastodon pour Pleroma :** Ajouter `/web` à la fin du nom de domaine (URL) de votre installation, par exemple : `https://pleroma.domain.tld/web`
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
@ -7,28 +7,32 @@
 - LDAP supported but HTTP auth not.

 ## Admin Tasks
-Go to **cd /var/www/pleroma/live**.
+
+Connect with SSH to your Yunohost server as YNH admin user.
+For the commands syntax, have in mind the specificities of [Yunohost Pleroma install](./doc/yunohost.md).
+

 ### Adding users

-**Run:**
-
-    $ ( cd /var/www/pleroma/live && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user new <NICKNAME> <EMAIL> )
+```
+sudo su pleroma -s $SHELL -lc "/var/www/pleroma/live/bin/pleroma_ctl user new <userName> <userEmail>"
+```

 ### Password reset

-**Run:** 
-
-    $ ( cd /var/www/pleroma/live && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user reset_password <NICKNAME> )
+```
+sudo su pleroma -s $SHELL -lc "/var/www/pleroma/live/bin/pleroma_ctl user reset_password <userName>"
+```

 This will generate a **password reset link** that you can then send to the user.

 ### Moderators

-You can make users **moderators**. They will then be able to **delete any post**.
+You can make users **moderators**. They will then be able to _delete any post_.

-**Run:**

-    $ ( cd /var/www/pleroma/live && sudo -u pleroma MIX_ENV=prod ./bin/pleroma_ctl user set <NICKNAME> --[no-]admin )
+```
+sudo su pleroma -s $SHELL -lc "/var/www/pleroma/live/bin/pleroma_ctl user set <userName> --admin"
+```

-**--admin** option will **make the user moderator** and **--no-admin** will **take away the moderator privileges** from the user.
+Note: `--admin` option will _make the user moderator_ and `--no-admin` will _take away_ the moderator privileges from the user.
--- a/doc/DISCLAIMER_fr.md
+++ b/doc/DISCLAIMER_fr.md
@ -0,0 +1,37 @@
+## Limitations
+
+- Pleroma doit impérativement s’installer sur son propre **nom de domaine dédié** (ou sous-domaine), par ex. pleroma.domain.tld
+- Pleroma nécessite par ailleurs un **certificat SSL** valide activé sur ce domaine. Yunohost peut installer et configurer un **certificat Letsencrypt** pour le domaine depuis l’interface d'administration de Yunohost ou avec la ligne de commande.
+- Ce paquet est actuellement configuré pour une **instance unique**, c’est-à-dire que l’on ne peut installer _qu’une seule instance_ de Pleroma sur un même serveur Yunohost.
+- Le **mot de passe** saisi durant l’installation ne doit _en aucun cas_ contenir de **caractères spéciaux**. (Voir [issue #132](https://github.com/YunoHost-Apps/pleroma_ynh/issues/132))
+- L’authentification LDAP fonctionne, mais pas `HTTP auth` en revanche.
+
+## Tâches d’administration
+
+Se connecter avec SSH à votre serveur Yunohost avec le compte admin (nous parlons ici de l’admin YNH pas de l’admin de Pleroma).
+Pour la syntaxe des commandes, garder en tête les spécificités d’une installations de [Pleroma avec Yunohost](./doc/yunohost_fr.md).
+
+
+### Ajouter un utilisateur ou utilisatrice
+
+```
+sudo su pleroma -s $SHELL -lc "/var/www/pleroma/live/bin/pleroma_ctl user new <userName> <userEmail>"
+```
+
+### Changer de mot de passe
+
+```
+sudo su pleroma -s $SHELL -lc "/var/www/pleroma/live/bin/pleroma_ctl user reset_password <userName>"
+```
+
+Ceci générera un **lien de réinitialisation** (URL) du mot de passe, que vous pouvez envoyer à l’utilisateur ou utilisatrice.
+
+### Modérateurs
+
+Vous pouvez donner à des utilisateurs ou utilisatrices les droits de **modération**. Ils ou elles pourront alors _supprimer_ n’importe quel billet publié par n’importe quel autre compte.
+
+```
+sudo su pleroma -s $SHELL -lc "/var/www/pleroma/live/bin/pleroma_ctl user set <userName> --admin"
+```
+
+Note : l’option `--admin` donne au compte _les droits de moderation_ et avec l’option `--no-admin` à l’inverse on _enlève_ les privilèges de modération de celui-ci.
--- a/doc/yunohost.md
+++ b/doc/yunohost.md
@ -0,0 +1,16 @@
+# Pleroma and Yunohost
+
+Some information, for all intents and purposes, on the differences between a direct installation of Pleroma (from the _releases_) and installation with the Yunohost application package.
+
+|                             | Official Package           | With Yunohost                           |
+| --------------------------- | -------------------------- | --------------------------------------- |
+| Install directory           | `/opt/pleroma`              | `/var/www/pleroma/live/`                 |
+| Static directory            | `/var/lib/pleroma/static`   | `/etc/pleroma/config.exs`                |
+| Configuration file          | `/etc/pleroma/config.exs`   | `/etc/pleroma/config.exs`                |
+| Command line path           | `/bin/pleroma_ctl`         | `/var/www/pleroma/live/bin/pleroma_ctl`  |
+
+## Things to remember
+
+- The installation of Pleroma with Yunohost is a so-called OTP installation (and not MIX, i.e. from the sources). Have this in mind, as the administration _commands_ are not the same in either case.
+
+- All commands must be run as the `pleroma` user, who is _not_ part of Yunohost `admin` group, it’s not possible to invoque these commands directly with `sudo`.
--- a/doc/yunohost_fr.md
+++ b/doc/yunohost_fr.md
@ -0,0 +1,16 @@
+# Pleroma et Yunohost
+
+Quelques informations, à toutes fins utiles, sur les différences entre une installation directe de Pleroma (depuis les _releases_ du dépôt officiel) et l’installation avec le package d’application de Yunohost.
+
+|                             | Package officiel           | Avec Yunohost                           |
+| --------------------------- | -------------------------- | --------------------------------------- |
+| Répertoire d’installation   | `/opt/pleroma`              | `/var/www/pleroma/live/`                 |
+| Répertoire statique         | `/var/lib/pleroma/static`   | `/etc/pleroma/config.exs`                |
+| Fichier de configuration    | `/etc/pleroma/config.exs`   | `/etc/pleroma/config.exs`                |
+| Ligne de commandes          | `/bin/pleroma_ctl`         | `/var/www/pleroma/live/bin/pleroma_ctl`  |
+
+## A noter
+
+- L’installation de Pleroma avec Yunohost est une installation dite OTP (et non MIX, c’est à dire à partir des sources). Information à mémoriser, dans la mesure où les commandes d’administration ne sont pas les mêmes dans l’un ou l’autre cas.
+
+- Toutes les commandes doivent être exécutées en tant qu’utilisateur `pleroma`, qui n’est _pas_ membre du groupe `admin` de Yunohost, celle-ci ne peuvent donc être invoquées directement avec `sudo`.