clients.md: Add Kyclos
[akkoma] / docs / administration / backup.md
1 # Backup/Restore your instance
2
3 ## Backup
4
5 1. Stop the Pleroma service.
6 2. Go to the working directory of Pleroma (default is `/opt/pleroma`)
7 3. Run `sudo -Hu postgres pg_dump -d <pleroma_db> --format=custom -f </path/to/backup_location/pleroma.pgdump>`
8 4. Copy `pleroma.pgdump`, `config/prod.secret.exs` and the `uploads` folder to your backup destination. If you have other modifications, copy those changes too.
9 5. Restart the Pleroma service.
10
11 ## Restore
12
13 1. Stop the Pleroma service.
14 2. Go to the working directory of Pleroma (default is `/opt/pleroma`)
15 3. Copy the above mentioned files back to their original position.
16 4. Run `sudo -Hu postgres pg_restore -d <pleroma_db> -v -1 </path/to/backup_location/pleroma.pgdump>`
17 5. Restart the Pleroma service.