funkwhale/docs/administrator_documentation/upgrade_docs/backup.md

1.7 KiB

Back up your Funkwhale instance

Before performing big changes, we recommend you back up your database and media files. Follow the instructions in this guide to back up your instance.

  1. Back up your database.

    ::::{tab-set}

    :::{tab-item} Debian :sync: debian

    sudo -u postgres -H pg_dump funkwhale > /path/to/your/backup/dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql
    

    :::

    :::{tab-item} Docker :sync: docker

    docker-compose exec postgres pg_dumpall -c -U postgres > dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql
    

    ::: ::::

  2. Back up your media files. In this example we use rsync to back up the files.

    ::::{tab-set}

    :::{tab-item} Debian :sync: debian

    rsync -avzhP /srv/funkwhale/data/media /path/to/your/backup/media
    rsync -avzhP /srv/funkwhale/data/music /path/to/your/backup/music
    

    :::

    :::{tab-item} Docker :sync: docker

    
    rsync -avzhP /srv/funkwhale/data/media /path/to/your/backup/media
    rsync -avzhP /srv/funkwhale/data/music /path/to/your/backup/music
    

    ::: ::::

  3. Back up your configuration files.

    ::::{tab-set}

    :::{tab-item} Debian :sync: debian

    rsync -avzhP /srv/funkwhale/config/.env /path/to/your/backup/.env
    

    :::

    :::{tab-item} Docker :sync: docker

    rsync -avzhP /srv/funkwhale/.env /path/to/your/backup/.env
    

    ::: ::::

If you are performing regular backups, you may need deduplication and compression to keep the size down. In this case, a tool like borg is more appropriate.