From c699e1f7a79354bdaa51474b30074c6e3005fc27 Mon Sep 17 00:00:00 2001 From: Tagada <36127788+Tagadda@users.noreply.github.com> Date: Sat, 24 Feb 2024 23:28:27 +0100 Subject: Packaging v2 (#399) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Convert to v2 (#383) * convert script * v2 * Auto-update README * Update documentation cc @panomaki * Bump ruby version from 3.0.6 to 3.2.2 * v2 * Auto-update README * woops * v2 * v2 * s/final_path/install_dir * Update PRE_INSTALL.md * too soon... * v2 * v2 * v2 * Update tests.toml * Update doc/PRE_INSTALL.md Co-authored-by: Alexandre Aubin * Update doc/PRE_INSTALL_fr.md Co-authored-by: Alexandre Aubin * Update tests.toml Co-authored-by: Alexandre Aubin * Update tests.toml Co-authored-by: Alexandre Aubin * Update doc/PRE_INSTALL.md Co-authored-by: Alexandre Aubin * Update doc/PRE_INSTALL_fr.md Co-authored-by: Alexandre Aubin * Apply suggestions * Update manifest.toml * Auto-update README * Update manifest.toml * Update scripts * Auto-update README * Remove SSO integration * Use new mail mechanism * cleaning * Update manifest.toml --------- Co-authored-by: yunohost-bot Co-authored-by: Alexandre Aubin Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Bump ynh version * Auto-update README * Update manifest.toml * Update doc/PRE_INSTALL.md Co-authored-by: Alexandre Aubin * Add service setting for app shell * Use logrotate * smtp config follow-up Sidekiq service can be properly hardened since it doesn't use sendmail anymore o/ * Fix mkdir failing if /var/log/mastodon already exists * upgrade: Rename database to match packaging v2 * Bump 4.1.6~ynh2 * Auto-update README * Disable install.private test * remove full_domain * 4.1.7 (#403) * 4.1.7 * Auto-update README * Update manifest.toml * Auto-update README --------- Co-authored-by: yunohost-bot Co-authored-by: Tagada <36127788+Tagadda@users.noreply.github.com> * fix * fix * Don't swap when running on a LXC * Hardcore the needed RAM * Auto-update README * Auto-update README * Update manifest.toml * Auto-update README * Update _common.sh * Auto-update README * cleaning * cleaning * Auto-update README * Auto-update README * Update tests.toml * Fix restore * Fix manifest.toml * Auto-update README * Auto-update README * add `tootctl self-destruct` info * format * Auto-update README * lol autotranslate * break line * break lines * translation from french * update version * Auto-update README * Update manifest.toml --------- Co-authored-by: yunohost-bot Co-authored-by: Alexandre Aubin Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: ericgaspar Co-authored-by: OniriCorpe --- doc/ADMIN.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/ADMIN_fr.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/DESCRIPTION.md | 2 +- doc/DISCLAIMER.md | 40 -------------------------------- doc/DISCLAIMER_fr.md | 45 ------------------------------------ doc/PRE_INSTALL.md | 23 +++++++++++++++++++ doc/PRE_INSTALL_fr.md | 23 +++++++++++++++++++ 7 files changed, 173 insertions(+), 86 deletions(-) create mode 100644 doc/ADMIN.md create mode 100644 doc/ADMIN_fr.md delete mode 100644 doc/DISCLAIMER.md delete mode 100644 doc/DISCLAIMER_fr.md create mode 100644 doc/PRE_INSTALL.md create mode 100644 doc/PRE_INSTALL_fr.md (limited to 'doc') 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 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]() 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]() pour plus de détails. + +## Bugs connus + +- Se déconnecter depuis le portail YunoHost ne vous déconnecte pas de Mastodon. Voir 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 +``` -- cgit v1.2.3-70-g09d2 From 345a0c38c1eb16e1789c9e9d1b3fbb3d6720939e Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sat, 24 Feb 2024 23:41:02 +0100 Subject: 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(-) (limited to 'doc') 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 -- cgit v1.2.3-70-g09d2 From 3fba232c407aa0f9ecf3cf91fc29c23b2608b9d0 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sun, 25 Feb 2024 01:03:06 +0100 Subject: 'tootctl self-destruct --dry-run' to prevent accidental run --- doc/ADMIN.md | 4 +++- doc/ADMIN_fr.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 6ad1ab4..dfce904 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -60,9 +60,11 @@ Otherwise your data will remain in federation cache for ever. ```bash screen -sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl self-destruct +sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl self-destruct --dry-run ``` +Remove the `--dry-run` part only when you're absolutely certain that you really want to delete your Mastodon instance. + Check [the official documentation](https://docs.joinmastodon.org/admin/tootctl/#self-destruct) for more details. ## Known Bugs diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index 46849c7..c879081 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -60,9 +60,11 @@ Sinon, vos données resteront dans le cache de la fédération pour toujours. ```bash screen -sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl self-destruct +sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl self-destruct --dry-run ``` +Retirez la partie `--dry-run` uniquement lorsque vous avez la certitude que que vous voulez vraiment supprimer votre instance Mastodon. + Consulter [la documentation officielle](https://docs.joinmastodon.org/admin/tootctl/#self-destruct) pour plus de détails. ## Bugs connus -- cgit v1.2.3-70-g09d2 From 2ffdf9338bff6bbe7e6dfc284de7dc2787e56d9c Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sat, 11 May 2024 20:28:48 +0200 Subject: Advertise tootctl media remove and other media cleanup related commands in ADMIN.md --- doc/ADMIN.md | 14 ++++++++++++++ doc/ADMIN_fr.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) (limited to 'doc') diff --git a/doc/ADMIN.md b/doc/ADMIN.md index dfce904..9e9e52a 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -48,6 +48,20 @@ sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/op Check [the official documentation](https://docs.joinmastodon.org/admin/tootctl/#media-remove) for more details. +## Release disk space + +To liberate disk space, you can use the following commands: + +- [tootctl media remove](https://docs.joinmastodon.org/admin/tootctl/#media-remove): removes locally cached copies of media from other servers +- [tootctl media remove-orphans](https://docs.joinmastodon.org/admin/tootctl/#media-remove-orphans): scans for files that do not belong to existing media attachments, and remove them +- [tootctl accounts cull](https://docs.joinmastodon.org/admin/tootctl/#accounts-cull): remove remote accounts that no longer exist + +As seen above, each of these commands must be structured as such: + +```bash +sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl command +``` + ## 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. diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index c879081..777cbf3 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -48,6 +48,20 @@ sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/op Consulter [la documentation officielle](https://docs.joinmastodon.org/admin/tootctl/#media-remove) pour plus de détails. +## Libérer de l'espace disque + +Afin de libérer de l'espace disque, vous pouvez utiliser les commandes suivantes : + +- [tootctl media remove](https://docs.joinmastodon.org/admin/tootctl/#media-remove) : supprime les copies de médias mises en cache localement depuis d'autres serveurs +- [tootctl media remove-orphans](https://docs.joinmastodon.org/admin/tootctl/#media-remove-orphans) : recherche les fichiers qui n'appartiennent pas à des pièces jointes existantes et les supprime +- [tootctl accounts cull](https://docs.joinmastodon.org/admin/tootctl/#accounts-cull) : supprime les comptes à distants qui n'existent plus + +Comme vu précédemment, chacune de ces commandes doit être construite comme tel : + +```bash +sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl commande +``` + ## 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. -- cgit v1.2.3-70-g09d2 From 739c8cad75edde30d61150532175e019814e7554 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sat, 11 May 2024 20:37:29 +0200 Subject: better emphasis on the inability to change domain names --- doc/PRE_INSTALL.md | 2 +- doc/PRE_INSTALL_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md index 0088f30..cbb9a79 100644 --- a/doc/PRE_INSTALL.md +++ b/doc/PRE_INSTALL.md @@ -1,6 +1,6 @@ ## 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. +- **Mastodon** require a dedicated **root domain**, eg. `domaine.tld` or `mastodon.domain.tld`, with no other apps installed on that domain. Due to the federation, **you will not be able to change the domain once installed.** - The user choosen during the installation is automatically created in Mastodon with admin rights - 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. diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md index 7128e3a..a650425 100644 --- a/doc/PRE_INSTALL_fr.md +++ b/doc/PRE_INSTALL_fr.md @@ -1,6 +1,6 @@ ## 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. +- **Mastodon** nécessite un **nom de domaine** dédié, par exemple : `domaine.tld` ou `mastodon.domaine.tld` sans apps installées sur ce domaine. En raison de la fédération, **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 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. -- cgit v1.2.3-70-g09d2 From 6c5806fa7ef322f6ab23924a334e5619185bd166 Mon Sep 17 00:00:00 2001 From: OniriCorpe Date: Sat, 11 May 2024 22:31:25 +0200 Subject: add a pre upgrade text to advertise the new admin docs --- doc/PRE_UPGRADE.d/4.2.8~ynh2.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 doc/PRE_UPGRADE.d/4.2.8~ynh2.md (limited to 'doc') diff --git a/doc/PRE_UPGRADE.d/4.2.8~ynh2.md b/doc/PRE_UPGRADE.d/4.2.8~ynh2.md new file mode 100644 index 0000000..732c571 --- /dev/null +++ b/doc/PRE_UPGRADE.d/4.2.8~ynh2.md @@ -0,0 +1,2 @@ +We've added documentation dedicated to the administration of your Mastodon instance. +We encourage you to read it from the YunoHost web admin interface: `Applications > Mastodon > scroll down to see the docs` -- cgit v1.2.3-70-g09d2