manage_server backup

Archive Enterprise server data (requires server to be running)

Usage: manage_server backup [OPTIONS]

Options:
  -f, --file <file>                   [default: bn_enterprise_backup.tar]
      --swarm[=<STACK_NAME>]          Operate in docker swarm mode
      --registry-host <HOSTNAME>      Hostname of custom registry [default: registry.enterprise.binary.ninja]
      --stdout                        Stream the backup archive to stdout instead of writing to disk
      --registry-username <USER>      Username for custom registry
      --registry-password <PASSWORD>  Password for custom registry
  -l, --license-file <license-file>   Path to Binary Ninja license file [default: license.dat]
      --uid <uid>                     User ID used for data and tasks (defaults to current User ID)
      --gid <gid>                     Group ID used for data and tasks (defaults to current Group ID)
  -h, --help                          Print help

Database Options:
      --db-name <NAME>           Name of database to use [default: binaryninja_enterprise]
      --db-host <HOSTNAME>       Name of host to use when connecting to database [default: database]
      --db-port <PORT>           The port to use when connecting to database [default: 5432]
      --db-user <USERNAME>       The user to use when connecting to database [default: binaryninja_enterprise]
      --db-password-file <FILE>  Path to file containing password to authenticate with the database [default: ./secrets/db_password]

Redis Options:
      --redis-url <URL>  URL to use when connecting to message broker [default: redis://redis:6379]

Object Store Options:
      --object-store-bucket-name <BUCKET>    Object store bucket name (must be between 3 and 63 characters, only using lowercase letters, numbers, dot, and hyphen) [default: binaryninja-enterprise]
      --object-store-endpoint-url <URL>      Object store endpoint URL [default: https://object-store:9000]
      --object-store-key-id-file <FILE>      Path to file containing the access key ID to use when authenticating with the object store [default: ./secrets/object_store_access_key_id]
      --object-store-secret-key-file <FILE>  Path to file containing the secret access key to use when authenticating with the object store [default: ./secrets/object_store_secret_access_key]

Note

Please remember that the user running this command must have permissions to run docker commands for it to complete successfully.

Additional Considerations

An older backup can be restored to a newer Enterprise server. Once the backup has been loaded, database migrations will be applied to bring the older database up to the newer version.

Danger

A backup from a newer Enterprise server cannot be restored to an older version of the Enterprise server.