Management Interface: start

This command starts a stopped Enterprise server.

Warning

When starting the server with --uid and/or --gid, all files in the server directory and subdirectories must be readable by that user and group.

Typical Usage

By default, the server is started in the foreground and can be exited with Ctrl-C. Use --detach to start the server in the background.

Note

Logs will not be printed to console when running detached. The logs command can be used to view server logs.

Command Help

Start Enterprise server

Usage: manage_server start [OPTIONS]

Options:
      --debug                            Run server in debug mode [env: DEBUG=]
      --swarm[=<STACK_NAME>]             Operate in docker swarm mode [env: ENTERPRISE_STACK_NAME=]
  -a, --allowed-host <allowed-host>...   Adds a hostname or address to the allowlist [env: ENTERPRISE_SERVER_ALLOWED_HOSTS=] [default: *]
      --registry-host <HOSTNAME>         Hostname of custom registry [env: ENTERPRISE_REGISTRY_HOST=registry.internal.v35.us] [default: registry.enterprise.binary.ninja]
      --bind-ip <bind-ip>                Host IP address to bind [env: ENTERPRISE_SERVER_BIND_IP=] [default: 0.0.0.0]
      --registry-username <USER>         Username for custom registry [env: ENTERPRISE_REGISTRY_USERNAME=]
  -p, --port <port>                      Port the Enterprise server will listen on [env: ENTERPRISE_SERVER_PORT=] [default: 3535]
      --registry-password <PASSWORD>     Password for custom registry [env: ENTERPRISE_REGISTRY_PASSWORD=]
      --detach                           Run in the background [env: DETACH=]
      --docker-host <HOST>               Overrides the default Docker/Podman Unix socket [env: DOCKER_HOST=]
  -c, --certfile <certfile>              Local path to the Enterprise server certificate [env: ENTERPRISE_SERVER_CERT_FILE=] [default: server.pem]
      --container-engine <ENGINE>        Container engine to use for deployments (docker or podman) [env: ENTERPRISE_CONTAINER_ENGINE=docker] [default: docker] [possible values: docker, podman]
  -k, --keyfile <keyfile>                Local path to the Enterprise server key [env: ENTERPRISE_SERVER_KEY_FILE=] [default: server.key]
  -b, --license-bundle <license-bundle>  Local path to Enterprise client floating license bundle [env: ENTERPRISE_SERVER_LICENSE_BUNDLE_FILE=] [default: license-bundle.b64]
      --no-tls                           Disable TLS [env: ENTERPRISE_PROXY_NO_TLS=false]
  -l, --license-file <license-file>      Path to Binary Ninja license file [env: ENTERPRISE_SERVER_LICENSE_FILE=] [default: license.dat]
      --uid <uid>                        User ID used for data and tasks (defaults to current User ID) [env: ENTERPRISE_SERVER_UID=]
      --gid <gid>                        Group ID used for data and tasks (defaults to current Group ID) [env: ENTERPRISE_SERVER_GID=]
  -h, --help                             Print help

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

Key-Value Store Options:
      --redis-url <URL>  URL to use when connecting to message broker [env: ENTERPRISE_KV_STORE_URL=] [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) [env: ENTERPRISE_OBJECT_STORE_BUCKET_NAME=] [default: binaryninja-enterprise]
      --object-store-endpoint-url <URL>      Object store endpoint URL [env: ENTERPRISE_OBJECT_STORE_URL=] [default: https://object-store:8333]
      --object-store-access-key-file <FILE>  Path to file containing the access key ID to use when authenticating with the object store [env: ENTERPRISE_OBJECT_STORE_ACCESS_KEY_FILE=] [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 [env: ENTERPRISE_OBJECT_STORE_SECRET_KEY_FILE=] [default: ./secrets/object_store_secret_access_key]