Install BindPlane OP Server

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

  • Red Hat, Centos, Oracle Linux 7 and 8
  • Debian 10 and 11
  • Ubuntu LTS 18.04, 20.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. BindPlane OP will install on a non-systemd system, however, service management will be up to the user and is not a supported solution.

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 page or visit the BindPlane OP Github Repository.

curl -fsSlL https://github.com/observiq/bindplane-op/releases/latest/download/install-linux.sh | bash -s --

Once installed, you can check the service.

sudo systemctl status bindplane

📘

Note: initialize your server

After installing BindPlane OP, make sure to run the bindplane init command. The specific command for your OS can be found when running the installer.

Docker

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:1.10.0. To see the latest release versions, check the BindPlane OP Releases page.

docker volume create bindplane

docker run -d \
    --name bindplane \
    --restart always \
    --mount source=bindplane,target=/data \
    -e BINDPLANE_CONFIG_USERNAME=admin \
    -e BINDPLANE_CONFIG_PASSWORD=admin \
    -e BINDPLANE_CONFIG_SERVER_URL=http://localhost:3001 \
    -e BINDPLANE_CONFIG_REMOTE_URL=ws://localhost:3001 \
    -e BINDPLANE_CONFIG_SESSIONS_SECRET=2c23c9d3-850f-4062-a5c8-3f9b814ae144 \
    -e BINDPLANE_CONFIG_SECRET_KEY=8a5353f7-bbf4-4eea-846d-a6d54296b781 \
    -e BINDPLANE_CONFIG_LOG_OUTPUT=stdout \
    -p 3001:3001 \
    observiq/bindplane:latest

The following configuration options should be modified

  • BINDPLANE_CONFIG_SERVER_URL and BINDPLANE_CONFIG_REMOTE_URL should be set to the Docker host's IP address, hostname, or external load balancer. These endpoints are used by agents to communicate with BindPlane for OpAMP and Measurements. Localhost is sufficient for testing on your local machine only.
  • BINDPLANE_CONFIG_USERNAME and BINDPLANE_CONFIG_PASSWORD should be set to something secure and unique.
  • BINDPLANE_CONFIG_SECRET_KEY and BINDPLANE_CONFIG_SESSIONS_SECRET should be set to unique UUIDv4 values. You can use the uuidgen command.