Skip to content

Binary Ninja Enterprise Server Documentation

The Binary Ninja Enterprise Server enables users of Binary Ninja Ultimate edition to:

  • Collaborate with team members on shared analysis databases
  • Centrally manage the storage of projects and project files
  • Check out and use floating licenses
  • Build automation tooling via Enterprise-specific APIs
  • Contribute to and use a private function identification library with the bundled WARP service

This documentation covers the Enterprise server itself. Please see the Binary Ninja Ultimate User and/or API documentation for information about the client. If using the bundled WARP service, please see its documentation in the Binary Ninja user docs for how to use WARP.

Quick Start

The following is the absolute quickest way to get up and running with a new Enterprise Server. For more detailed instructions, see the full Installation guide.

If you are just trying to upgrade an existing deployment, check the Upgrade guide for any additional considerations or requirements for your current version and deployment.

And, if you encounter any difficulties, please see our section on Troubleshooting common issues and/or contact support at [email protected].

Requirements

To run the Enterprise Server, you will need:

  • A host that meets the Docker system requirements
  • Docker Engine version 20.10.0 or newer installed on that host
    • Docker Desktop 4.0+ should have this
  • The Management Interface (the executable called manage_server)
  • (Optional) The images.tar offline image bundle, if you are installing offline

Note

More details about system requirements and alternative ways of installing can be found in the full Installation guide.

Installation

Danger

We do not currently support installing as the root user due to a limitation of the default PostgreSQL container we leverage as part of the default deployment.

As any non-root user, do the following to install the Enterprise Server:

# For online installations
./manage_server install

# For offline installations
./manage_server install --offline

If you need to customize your deployment at all, see the Customization guide. Most customizations involve passing options directly to install or by editing your config.env manually after-the-fact.

First Run

Note

By default, the first user created will be admin. This account will have the password you supplied during install.

Do the following to start the Enterprise Server:

./manage_server start

After this, you should be able to navigate to https://your_host:3535. It may take a minute or two to complete the initial setup of all volumes, so be patient if you see a "Backend is missing!" page at first.

Once you're sure everything is working, Ctrl-C to stop the server and re-start it in the background with:

./manage_server start --detach

Next Steps

Additional documentation you may want past this point includes:

  • The Backup and Restore guide explains how to ensure you always have a usable copy of your data.
  • The Admin Interface reference explains what options and configuration is available in the admin interface.
  • The Management Interface reference explains what other commands the management interface is capable of running.