manage_server start

Start Enterprise server

Usage: manage_server start [OPTIONS]

Options:
      --debug
          Run server in debug mode
      --swarm[=<STACK_NAME>]
          Operate in docker swarm mode
  -a, --allowed-host <allowed-host>...
          Adds a hostname or address to the allowlist [default: *]
      --registry-host <HOSTNAME>
          Hostname of registry [default: registry.enterprise.binary.ninja]
      --bind-ip <bind-ip>
          Host IP address to bind [default: 0.0.0.0]
  -p, --port <port>
          Port the Enterprise server will listen on [default: 3535]
      --detach
          Run in the background
  -c, --certfile <certfile>
          Local path to the Enterprise server certificate [default: server.pem]
  -k, --keyfile <keyfile>
          Local path to the Enterprise server key [default: server.key]
  -b, --license-bundle <license-bundle>
          Local path to Enterprise client floating license bundle [default: license-bundle.b64]
      --no-tls
          Disable TLS
      --no-validate-tls
          Disable backend TLS validation
  -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-host <HOSTNAME>    Name of host to use when connecting to message broker [default:
                                 redis]
      --redis-port <PORT>        Port to use when connecting to message broker [default: 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]

By default, the server is started in the foreground and can be exited with Ctrl+C.

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.

Examples

Running Detached

Running with manage_server start --detach will start the server without attaching to the process.

Note

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

Running on a Non-Default Port

Running with manage_server start --port 8081 will start the server, listening on port 8081

HTTP Host Validation

Running with manage_server start --allowed-host *.example.com --allowed-host localhost will validate that the Host header on all HTTP requests matches some subdomain of example.com or localhost.

Invalid requests will be met with a Bad Request (400) response.

Running on Docker Swarm

Note

Images must be present on each node before running. If you have more than a one node in your Swarm, please see the following example in the install instructions

Running with manage_server start --swarm will start the server in Docker Swarm. Use --swarm=<STACK_NAME> if you want to deploy with a non-default stack name.