aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ADMIN.md63
-rw-r--r--doc/ADMIN_fr.md63
-rw-r--r--doc/DESCRIPTION.md2
-rw-r--r--doc/DISCLAIMER.md40
-rw-r--r--doc/DISCLAIMER_fr.md45
-rw-r--r--doc/PRE_INSTALL.md23
-rw-r--r--doc/PRE_INSTALL_fr.md23
7 files changed, 173 insertions, 86 deletions
diff --git a/doc/ADMIN.md b/doc/ADMIN.md
new file mode 100644
index 0000000..6cb69e2
--- /dev/null
+++ b/doc/ADMIN.md
@@ -0,0 +1,63 @@
+## Administrate with tooctl
+
+`$ (cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help)`
+
+## Update
+
+**`screen` (or `tmux`) can be used to make sure your session is not interrupted in case of connection problems.**
+See [tutorial](https://www.howtogeek.com/662422/how-to-use-linuxs-screen-command/) for more background information.
+
+```bash
+screen
+sudo yunohost app upgrade mastodon
+```
+
+## Backups
+
+First of all: Mastodon uses a local cache to save media (such as posted images, videos etc.). This cache can grow huge.
+You could consider cleaning up your local cache first as otherwise your backup will be very big and you might run out of disk space:
+
+To check your space usage, on a command line run:
+
+```bash
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media usage
+```
+
+If your cache is too big to backup, you can run the following command to clean up Attachments (the first line).
+Substitute X by the number of days you want to keep, e.g. 1 day.
+All older images will be deleted but will be refetched from the original server if necessary.
+
+First dry-run to see how much space is freed up (without actually removing):
+
+```bash
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media remove --days=X --dry-run`
+```
+
+If all looks good commit the cleanup:
+
+```bash
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media remove --days=X`
+```
+
+Check [the official documentation](https://docs.joinmastodon.org/admin/tootctl/#media-remove) for more details.
+
+## Before your Mastodon instance deletion
+
+Before definitively uninstalling Mastodon, you have to run `tootctl self-destruct` to broadcast your users and instance deletion to the federation.
+Otherwise your data will remain in federation cache for ever.
+
+⚠️ Make sure you know exactly what you are doing before running this command.
+⚠️ This operation is NOT reversible, and it can take a long time.
+⚠️ The server will be in a BROKEN STATE after this command finishes.
+⚠️ A running Sidekiq process is required, so do not shut down the server until the queues are fully cleared.
+
+```bash
+screen
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl self-destruct
+```
+
+Check [the official documentation](https://docs.joinmastodon.org/admin/tootctl/#self-destruct) for more details.
+
+## Known Bugs
+
+- Log-out from YunoHost's portal doesn't log out from Mastodon. See <https://github.com/YunoHost/issues/issues/501>
diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md
new file mode 100644
index 0000000..91125ba
--- /dev/null
+++ b/doc/ADMIN_fr.md
@@ -0,0 +1,63 @@
+## Administration avec tooctl
+
+`$ cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help`
+
+## Mise à jour
+
+**`screen` (ou `tmux`) peut être utilisé pour vous assurer que votre session n'est pas interrompue en cas de problème de connection.**
+Consultez ce [tutoriel](https://www.howtogeek.com/662422/how-to-use-linuxs-screen-command/) pour plus de détails.
+
+```bash
+screen
+sudo yunohost app upgrade mastodon
+```
+
+## Sauvegardes
+
+Tout d'abord : Mastodon utilise un cache local pour sauvegarder les médias (comme les images, vidéos, etc). Ce cache peut devenir énorme.
+Vous devriez réfléchir à vider votre cache local avant de faire une sauvegarde, qui pourrait être énorme et vous pourriez manquer d'espace de stockage.
+
+Pour vérifier l'utilisation du stockage, en ligne de commande utilisez :
+
+```bash
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media usage
+```
+
+Si le cache est trop gros pour être sauvegardé, vous pouvez lancer la commande suivante pour en supprimer les médias attachés.
+Changez `X` par le nombre de cache à conserver, par ex. 1 jour.
+Tous les médias plus anciens seront supprimés, mais ils pourront être rechargé du serveur d'origine si nécessaire.
+
+En premier faite un essai à blanc pour voir combien de place sera libérée (sans rien supprimer):
+
+```bash
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media remove --days=X --dry-run`
+```
+
+Si cela semble bon, effectuez le nettoyage :
+
+```bash
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media remove --days=X
+```
+
+Consulter [la documentation officielle](<https://docs.joinmastodon.org/admin/tootctl/#media-remove>) pour plus de détails.
+
+## Avant la suppression de votre instance Mastodon
+
+Avant de désinstaller définitivement Mastodon, vous devez lancer `tootctl self-destruct` pour annoncer à la fédération la suppression de vos utilisateurs et de votre instance.
+Sinon, vos données resteront dans le cache de la fédération pour toujours.
+
+⚠️ Assurez-vous de savoir exactement ce que vous faites avant d'exécuter cette commande.
+⚠️ Cette opération n'est PAS réversible et peut prendre beaucoup de temps.
+⚠️ Le serveur sera dans un ÉTAT BRISÉ après la fin de cette commande.
+⚠️Un processus Sidekiq en cours d'exécution est nécessaire, donc n'arrêtez pas le serveur avant que les files d'attente ne soient complètement vidées.
+
+```bash
+screen
+sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl self-destruct
+```
+
+Consulter [la documentation officielle](<https://docs.joinmastodon.org/admin/tootctl/#self-destruct>) pour plus de détails.
+
+## Bugs connus
+
+- Se déconnecter depuis le portail YunoHost ne vous déconnecte pas de Mastodon. Voir <https://github.com/YunoHost/issues/issues/501>
diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md
index 72981f6..1bea4ef 100644
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
@@ -1 +1 @@
-Mastodon is a free, open-source microblogging social network. It is a decentralized alternative to commercial platforms like Twitter and avoids the risks of a single company monopolizing your communication for commercial purposes. \ No newline at end of file
+Mastodon is a free, open-source microblogging social network. It is a decentralized alternative to commercial platforms like Twitter and avoids the risks of a single company monopolizing your communication for commercial purposes.
diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md
deleted file mode 100644
index e08b255..0000000
--- a/doc/DISCLAIMER.md
+++ /dev/null
@@ -1,40 +0,0 @@
-## Important points to read before installing
-
-1. **Mastodon** require a dedicated **root domain**, eg. mastodon.domain.tld
-1. The user choosen during the installation is automatically created in Mastodon with admin rights
-1. At the end of the installation a mail is sent to the user with the automatically generated password
-1. It seems important to close the inscriptions for your Mastodon, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page.
-
-## Configuration
-
-### Install
-
-#### Using *screen* in case of disconnect
-```
-$ sudo apt-get install screen
-$ screen
-$ sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh.git
-```
-Recover after disconnect:
-```
-$ screen -d
-$ screen -r
-```
-
-### Update
-
-#### Using *screen* highly recommended
-
-`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `
-
-### Administrate with tootctl
-
-`$ (cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help)`
-
-## YunoHost specific features
-
-#### Multi-users support
-
-LDAP authentication is activated. All YunoHost users can authenticate.
-
-Log-out from YunoHost's portal doesn't log out from Mastodon. See https://github.com/YunoHost/issues/issues/501
diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md
deleted file mode 100644
index 09ed5c9..0000000
--- a/doc/DISCLAIMER_fr.md
+++ /dev/null
@@ -1,45 +0,0 @@
-## Points importants à lire avant l'installation
-
-1. **Mastodon** nécessite un **nom de domaine** dédié, par exemple : mastodon.domain.tld
-1. L'utilisateur sélectionné pendant l'installation sera créé automatiquement dans Mastodon avec des droits d'administration.
-1. À la fin de l'installation, un mail est envoyé à cet utilisateur avec un mot de passe généré automatiquement.
-1. Pour que votre instance Mastodon reste privée, il est important de fermer les inscriptions. Nous vous invitons à bloquer les instances distantes indésirables depuis l'interface d'administration. Vous pouvez également ajouter un texte sur votre page d'accueil dans l'administration.
-
-## Captures d'écran
-
-![](https://framalibre.org/sites/default/files/mastodon.png)
-
-## Configuration
-
-### Installation
-
-#### Utilisation de *screen* en cas de déconnection
-```
-$ sudo apt-get install screen
-$ screen
-$ sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh.git
-```
-Récupérer l'installation après une deconnection :
-```
-$ screen -d
-$ screen -r
-```
-L'utilisateur admin est créé automatiquement comme : user@domain.tld
-
-### Mise à jour
-
-#### Utilisation de *screen* fortement recommandée
-
-`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `
-
-### Administration avec tootctl
-
-`$ (cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl --help)`
-
-## Caractéristiques spécifiques YunoHost
-
-#### Support multi-utilisateur
-
-L'authentification LDAP est activée. Tous les utilisateurs YunoHost peuvent s'authentifier.
-
-Se déconnecter depuis le portail YunoHost ne vous déconnecte pas de Mastodon. Voir https://github.com/YunoHost/issues/issues/501
diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md
new file mode 100644
index 0000000..c08f99b
--- /dev/null
+++ b/doc/PRE_INSTALL.md
@@ -0,0 +1,23 @@
+## Important points to read before installing
+
+- **Mastodon** require a dedicated **root domain**, eg. `domaine.tld` or `mastodon.domain.tld`, with no other apps installed on that domain. You can't change the domain once installed.
+- The user choosen during the installation is automatically created in Mastodon with admin rights
+- It seems important to close registrations for your Mastodon, so that it remains a private body. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page.
+
+## Using *screen* in case of disconnect
+
+Mastodon can take a long time to install, depending on server performance.
+To avoid the process being interrupted by a disconnection, you can use `screen`.
+
+```bash
+sudo apt install screen
+screen
+sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh.git
+```
+
+Recover after disconnect:
+
+```bash
+screen -d
+screen -r
+```
diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md
new file mode 100644
index 0000000..2a407a6
--- /dev/null
+++ b/doc/PRE_INSTALL_fr.md
@@ -0,0 +1,23 @@
+## Points importants à lire avant l'installation
+
+- **Mastodon** nécessite un **nom de domaine** dédié, par exemple : `domaine.tld` ou `mastodon.domaine.tld` sans apps installées sur ce domaine. Il est impossible de changer le nom de domaine après l'installation.
+- L'utilisateur sélectionné pendant l'installation sera créé automatiquement dans Mastodon avec des droits d'administration.
+- Pour que votre instance Mastodon reste privée, il est important de fermer les inscriptions. Nous vous invitons à bloquer les instances indésirables depuis l'interface d'administration. Vous pouvez également ajouter un texte sur votre page d'accueil dans l'administration.
+
+## Utilisation de *screen* en cas de déconnexion
+
+L'installation de Mastodon peut être longue, selon les performances du serveur.
+Pour éviter que le processus soit interrompu par une déconnexion, on peut utiliser `screen`.
+
+```bash
+sudo apt install screen
+screen
+sudo yunohost app install mastodon
+```
+
+Récupérer l'installation après une deconnection :
+
+```bash
+screen -d
+screen -r
+```