Skip to main content

Backups and restoration

A useful backup lets you recover PlexSub after a server, disk, or update failure. Back up before important changes and test restoration in a separate installation.

What to keep​

Store these securely:

  • The PostgreSQL database.
  • Uploaded files such as logos and branding.
  • The .env file.
  • The APP_SETTINGS_ENCRYPTION_KEY key.

Without this key, PlexSub cannot read the encrypted integration credentials already stored in the database.

Create a database backup​

From the folder that contains docker-compose.yml, run:

docker compose exec db pg_dump -U plexsub plexsub > plexsub-backup.sql

Replace the user and database with the values from your .env if they differ. Store the file outside the server whenever possible.

Security rules​

  • Treat backups as private information.
  • Do not upload them to Git, public chats, or unprotected file services.
  • Do not keep the only backup on the same disk as the installation.
  • Keep the date, version, and source of every backup.

Test a restoration​

Do not test your first restoration on the live installation. Create a separate folder and database, restore there, and verify:

  • The container starts.
  • You can sign in.
  • The portal loads.
  • Settings are still available.

Also read Updates before changing the PlexSub image or the PostgreSQL major version.