This documentation is for Octopus Deploy Version 3.9. View the latest version.

Backup and restore

Last updated

A successful disaster recovery plan for Octopus Deploy requires the ability to restore both:

  1. The Octopus SQL Server database
  2. The Octopus data stored on the file system

Without your master key, backups are useless
Sensitive information is encrypted using AES128 with the master key as the encryption key. Without this master key you will lose your sensitive variables, passwords and other encrypted data. Make sure you've taken a copy of the key! Learn more about backing up the master key.

Perfect practice makes perfect!
We highly recommend practicing your disaster recovery process to make sure it is a well-rehearsed and smooth experience in the unlikely event a recovery is required.

Octopus SQL Database

Most of the data and settings managed by Octopus - the projects, environments, deployments and so on - are stored in a SQL Server database. You are responsible for maintaining your own backups of the SQL Server database. Refer to SQL Server documentation for more information on backing up SQL Server.

Which SQL Database recovery model should I choose?

You should configure a SQL Database maintenance plan using a recovery model which suits your needs:

  1. If you happy with daily/weekly restore points you could consider the SIMPLE recovery model
  2. If you want point-in-time recovery you should consider the FULL recovery model

Learn more about restore and recovery of SQL Server Databases.

Octopus file storage

In addition to the SQL Server database, some Octopus data is stored on the file system. This includes task logs that are generated whenever a job is run by the server, artifacts that have been collected during a deployment and packages stored in the Octopus built-in repository. These files are stored in the Octopus home directory that is configured when Octopus Server is installed (C:\Octopus by default). It is a good idea to do regular backups of your Octopus home directory.

Learn about Octopus file storage.

Encrypted data

Certain sensitive information in the Octopus database is encrypted. This information is encrypted using your Octopus Server "master key", a randomly generated string. This master key will be needed if you ever plan to restore the database to a new server. You will be prompted for this key during the setup process when connecting to an existing database. If you have already setup the server you can change the master key so that it will work with the restored database.

It's worth repeating! Without your master key, backups are useless
Sensitive information is encrypted using AES128 with the master key as the encryption key. Without this master key you will lose your sensitive variables, passwords and other encrypted data. Make sure you've taken a copy of the key! Learn more about backing up the master key.