Install BindPlane OP Server

BindPlane OP Server runs on Linux and supports the following distributions:

  • Red Hat, Centos, Oracle Linux 7, 8, 9
  • Debian 11 and 12
  • Ubuntu LTS 20.04, 22.04
  • Suse Linux 12 and 15
  • Alma and Rocky Linux


📘 Prerequisites

You should verify that your system meets the recommended Resource Requirements

While BindPlane OP Server will generally run on any modern distribution of Linux, systemd is the only supported init system.

Install BindPlane OP Server

Debian and RHEL style packages are available for BindPlane Server.

An installation script is available to simplify installation. Additionally, you can download packages directly, see our Downloads.

1curl -fsSlL | bash -s --

After the installation, initialize the server:

1sudo BINDPLANE_CONFIG_HOME=/var/lib/bindplane /usr/local/bin/bindplane init server --config /etc/bindplane/config.yaml

Once initialized, you can check the service.

1sudo systemctl status bindplane


BindPlane OP can run as a container using Docker. The following commands will:

  • Name container bindplane
  • Keep persistent data in a volume named bindplane
  • Expose port 3001 (REST and Websocket)

Be sure to replace latest with the desired release image tag. e.g: observiq/bindplane-ee:1.32.0.

1docker volume create bindplane
3docker run -d \
4    --name bindplane \
5    --restart always \
6    --mount source=bindplane,target=/data \
7    -e BINDPLANE_USERNAME=admin \
8    -e BINDPLANE_PASSWORD=admin \
9    -e BINDPLANE_REMOTE_URL=http://localhost:3001 \
10    -e BINDPLANE_SESSION_SECRET=2c23c9d3-850f-4062-a5c8-3f9b814ae144 \
11    -e BINDPLANE_SECRET_KEY=8a5353f7-bbf4-4eea-846d-a6d54296b781 \
12    -e BINDPLANE_LOG_OUTPUT=stdout \
14    -p 3001:3001 \

The following configuration options should be modified:

  • BINDPLANE_REMOTE_URL should be set to the Docker host's IP address, hostname, or external load balancer. This endpoint is used by agents to communicate with BindPlane for OpAMP and Measurements. Localhost is sufficient for testing on your local machine only.
  • BINDPLANE_USERNAME and BINDPLANE_PASSWORD should be set to something secure and unique.
  • BINDPLANE_SECRET_KEY and BINDPLANE_SESSION_SECRET should be set to unique UUIDv4 values. You can use the uuidgen command.

Container Image Repositories

BindPlane OP container images can be found in the following locations:

  • Github Packages:
  • Google Artifact Repository:
  • Dockerhub: observiq/bindplane-ee

Container images are tagged with the release version. For example, Release "v1.32.0" will have the tag "observiq/bindplane-ee:1.32.0".