manage_server client_updates

Manage Enterprise client update files

Usage: manage_server client_updates [OPTIONS] <COMMAND>

Commands:
  download  Download Enterprise client updates from the official Binary Ninja update servers
  sync      Sync client updates from downloaded files
  rm        Remove client updates from server
  help      Print this message or the help of the given subcommand(s)

Options:
      --swarm[=<STACK_NAME>]
          Operate in docker swarm mode
      --registry-host <HOSTNAME>
          Hostname of registry [default: registry.enterprise.binary.ninja]
  -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 information

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]

manage_server client_updates download

Download Enterprise client updates from the official Binary Ninja update servers

Usage: manage_server client_updates download [OPTIONS]

Options:
  -f, --update-folder <update-folder>
          Local path to Enterprise client update folder [default: client_updates]
      --swarm[=<STACK_NAME>]
          Operate in docker swarm mode
  -m, --min-version <min-version>
          Minimum version of updates to be downloaded (latest stable version will always be
          downloaded) [default: 4.2.6455]
      --registry-host <HOSTNAME>
          Hostname of registry [default: registry.enterprise.binary.ninja]
      --latest-only
          Only download files for the latest stable and dev versions
      --platforms <platforms>...
          Platforms to download updates for [default: linux,win64,macosx] [possible values: linux,
          macosx, win64]
      --legacy-format
          Download updates in a format compatible with clients older than 3.0.3246. This will take
          much more disk space.
  -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 information

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]

manage_server client_updates sync

Sync client updates from downloaded files

Usage: manage_server client_updates sync [OPTIONS]

Options:
  -f, --update-folder <update-folder>
          Path to folder containing client update files [default: client_updates]
      --swarm[=<STACK_NAME>]
          Operate in docker swarm mode
      --registry-host <HOSTNAME>
          Hostname of registry [default: registry.enterprise.binary.ninja]
  -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 information

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]

manage_server client_updates rm

Remove client updates from server

Usage: manage_server client_updates rm [OPTIONS]

Options:
      --swarm[=<STACK_NAME>]
          Operate in docker swarm mode
      --registry-host <HOSTNAME>
          Hostname of registry [default: registry.enterprise.binary.ninja]
  -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 information

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]

Examples

Download Updates

Download updates from the official Binary Ninja update servers with manage_server client_updates download. These will be placed into a directory named client_updates by default, but you can point it at any directory with manage_server client_updates download --update-folder path/to/updates/folder. If this directory already exists, it will verify the files within without re-downloading and download any that are corrupted or missing.

If you only want to download the latest client updates, pass the --latest-only flag. This will download only the latest versions of the stable and dev channel updates for the platform(s) you've selected.

Sync Updates to Enterprise Server

Upload the updates you've downloaded to your Enterprise server with manage_server client_updates sync. By default, this assumes there is a local directory named client_updates, but you can point it at any directory with manage_server client_updates sync --update-folder path/to/updates/folder.

This command will synchronize the updates from this directory to the server and the update directory should contain all updates, not just those you were missing.