From 1402141fae5f827ac1b5323b6fd83e3530b760df Mon Sep 17 00:00:00 2001
From: Tagadda <36127788+Tagadda@users.noreply.github.com>
Date: Sun, 7 May 2023 11:31:25 +0000
Subject: [PATCH] Restore documentations unfortunatly removed by autoreadme

---
 doc/DISCLAIMER.md    | 38 +++++++++++++++++++++++++++++++++++++-
 doc/DISCLAIMER_fr.md | 40 ++++++++++++++++++++++++++++++++++++++--
 2 files changed, 75 insertions(+), 3 deletions(-)

diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md
index 959c15d..92be934 100644
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
@@ -10,6 +10,9 @@
 ### Install
 
 #### Using *screen* in case of disconnect
+
+`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.
 ```
 $ sudo apt-get install screen
 $ screen
@@ -23,7 +26,40 @@ $ screen -r
 
 ### Update
 
-#### Using *screen* highly recommended
+**Please use `screen` as the upgrade process can take a long time!**
+
+#### A note about 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:
+
+`$ 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):
+
+`$ 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:
+
+`$ sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media remove --days=X `
+
+#### Upgrade
+
+The actual upgrade can be done using the following command:
+
+`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `
+
+Upgrading from 3.5.3 to 4.1.2 directly has not been integration-tested. It is recommended to do a two-step upgrade:
+
+First upgrade to 4.0.2~ynh2:
+
+`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/94381183ca2d14da72234b53c9a83972ffb16e54 --debug `
+
+Check your installation. If all looks well, upgrade to 4.1.2~ynh1:
 
 `$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `
 
diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md
index a7b81ce..af8c0a9 100644
--- a/doc/DISCLAIMER_fr.md
+++ b/doc/DISCLAIMER_fr.md
@@ -13,7 +13,11 @@
 
 ### Installation
 
-#### Utilisation de *screen* en cas de déconnection
+### Utilisation de *screen* en cas de déconnection
+
+`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.
+
 ```
 $ sudo apt-get install screen
 $ screen
@@ -28,7 +32,39 @@ L'utilisateur admin est créé automatiquement comme : user@domain.tld
 
 ### Mise à jour
 
-#### Utilisation de *screen* fortement recommandée
+**Utilisation de *screen* fortement recommandée**
+
+### Note à propos des 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 :
+
+`$ 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):
+`$ 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 :
+`$ sudo cd /var/www/mastodon/live && sudo -u mastodon RAILS_ENV=production PATH=/opt/rbenv/versions/mastodon/bin bin/tootctl media remove --days=X `
+
+#### Upgrade
+
+La mise à niveau proprement dite peut être effectuée à l'aide de la commande suivante :
+
+`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `
+
+
+Mettre à niveau de 3.5.3 en 4.1.2 directement n'a pas été testé automatiquement. Il est donc recommandé de la réaliser en 2 étapes :
+
+Mettez d'abord à niveau en 4.0.2~ynh2:
+
+`$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh/tree/94381183ca2d14da72234b53c9a83972ffb16e54 --debug `
+
+Vérifiez votre installation. Si cela semble bon, mettez à niveau en 4.1.2~ynh1:
 
 `$ sudo yunohost app upgrade mastodon -u https://github.com/YunoHost-Apps/mastodon_ynh --debug `