Lost Master Key

Get your Octopus Server working again after losing your Master Key.

Before using this command, we recommend taking a look at our guide on recovering after losing your master key.

lost-master-key options

Usage: octopus.server lost-master-key [<options>]

Where [<options>] is any of:

      --instance=VALUE       Name of the instance to use
      --config=VALUE         Configuration file to use
                             Confirm you really want to generate a new Master
                               Key and reset all your sensitive data.
                             Confirm you have taken a backup of your database
                               in its current state. If something goes wrong at
                               least you can start again from that point in
      --upgradeDatabase      Confirm you are willing to let Octopus upgrade
                               the schema of your database so it can safely
                               load and save data in the expected format.
                             By default this command will test whether the
                               existing Master Key can decrypt the Octopus
                               Server X.509 certificate. Use this switch if you
                               are certain you want to ignore the results of
                               this test.
      --scrubPii             Use this switch to scrub all personally
                               identifiable information from the database.
      --skipLicenseCheck     Skips the license check when performing a schema

Or one of the common options:

      --help                 Show detailed help for this command

Basic example

This example will re-create the master key for the instance named OctopusServer.

Please note: The command below will replace the existing Master Key with a newly generated Master Key, and reset all sensitive data in the Octopus instance - be sure you have taken a database backup before running this.

octopus.server lost-master-key --instance="OctopusServer" --iReallyWantToResetAllMySensitiveData --iHaveBackedUpMyDatabase

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023