YunoHost-Apps/mastodon_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mastodon_ynh.git synced 2024-09-03 19:46:02 +02:00
Code Issues Activity Actions
mastodon_ynh/doc/ADMIN.md

2.9 KiB
Raw Blame History

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 for more background information.

screen
sudo yunohost app upgrade mastodon

Recover the screen session after disconnect:

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.
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`

Check the official documentation 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.

screen
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 for more details.

Known Bugs