From 345a0c38c1eb16e1789c9e9d1b3fbb3d6720939e Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sat, 24 Feb 2024 23:41:02 +0100 Subject: [PATCH] minor improvements --- doc/ADMIN.md | 11 +++++++++-- doc/ADMIN_fr.md | 15 +++++++++++---- doc/DESCRIPTION.md | 3 ++- doc/DESCRIPTION_fr.md | 4 +++- doc/PRE_INSTALL.md | 4 ++-- doc/PRE_INSTALL_fr.md | 4 ++-- 6 files changed, 29 insertions(+), 12 deletions(-) diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 6cb69e2..6ad1ab4 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -12,6 +12,13 @@ screen sudo yunohost app upgrade mastodon ``` +Recover the screen session after disconnect: + +```bash +screen -d +screen -r +``` + ## Backups First of all: Mastodon uses a local cache to save media (such as posted images, videos etc.). This cache can grow huge. @@ -47,9 +54,9 @@ Before definitively uninstalling Mastodon, you have to run `tootctl self-destruc 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. +⚠️ **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. +⚠️ A running Sidekiq process is required, **so do not shut down the server until the queues are fully cleared**. ```bash screen diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index 91125ba..46849c7 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -12,6 +12,13 @@ screen sudo yunohost app upgrade mastodon ``` +Récupérer la session screen après une déconnexion : + +```bash +screen -d +screen -r +``` + ## 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. @@ -39,7 +46,7 @@ Si cela semble bon, effectuez le nettoyage : 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]() pour plus de détails. +Consulter [la documentation officielle](https://docs.joinmastodon.org/admin/tootctl/#media-remove) pour plus de détails. ## Avant la suppression de votre instance Mastodon @@ -47,16 +54,16 @@ Avant de désinstaller définitivement Mastodon, vous devez lancer `tootctl self 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. +⚠️ **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. +⚠️Un processus Sidekiq en cours d'exécution est nécessaire, **donc ne stoppez 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]() pour plus de détails. +Consulter [la documentation officielle](https://docs.joinmastodon.org/admin/tootctl/#self-destruct) pour plus de détails. ## Bugs connus diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 1bea4ef..d15afb9 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1 +1,2 @@ -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. +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/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index bb225b2..f68bfd0 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -1 +1,3 @@ -Mastodon est un réseau social de microblog auto-hébergé et open source. C'est une alternative décentralisée aux plates-formes commerciales comme Twitter. Mastodon évite ainsi les risques qu'une seule société monopolise votre communication à des fins commerciales. +Mastodon est un réseau social de microblog auto-hébergé et open source. +C'est une alternative décentralisée aux plates-formes commerciales comme Twitter. +Mastodon évite ainsi les risques qu'une seule société monopolise votre communication à des fins commerciales. diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md index c08f99b..0088f30 100644 --- a/doc/PRE_INSTALL.md +++ b/doc/PRE_INSTALL.md @@ -2,7 +2,7 @@ - **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. +- To ensure that your Mastodon instance remains private and that the community is secure, it is important that registrations are closed and verified. We invite you to block remote malicious instances from the administration interface. You can also add text on your home page using the administration interface. ## Using *screen* in case of disconnect @@ -15,7 +15,7 @@ screen sudo yunohost app install https://github.com/YunoHost-Apps/mastodon_ynh.git ``` -Recover after disconnect: +Recover the screen session after disconnect: ```bash screen -d diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md index 2a407a6..7128e3a 100644 --- a/doc/PRE_INSTALL_fr.md +++ b/doc/PRE_INSTALL_fr.md @@ -2,12 +2,12 @@ - **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. +- Pour que votre instance Mastodon reste privée et que la communauté soit sécurisée, il est important que les inscriptions soient fermées et vérifiées. 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'interface d'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`. +Pour éviter que le processus soit interrompu par une déconnexion, vous pouvez utiliser `screen`. ```bash sudo apt install screen