Welcome to BindPlane OP

This quickstart guide is broken up into four steps which will help you get up and running with BindPlane OP.

BindPlane OP will run on Linux, macOS, or as a container using Docker.

This guide will walk you through installing BindPlane OP on a Linux system, installing an agent, and collecting and routing your telemetry.

Step 1: Installing and Configuring BindPlane OP

Installation

Install the BindPlane OP server using the installation script below. If you are looking for additional installation options, check out our Installation page.

Enterprise requires an enterprise license. If you don't have one, start with Open Source.

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

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

Configuration

Initialize Server

Once installed, you need to initialize the server with some configuration parameters. The default command for this is below, however you should use the command displayed in the Server Initialization section following installation.

sudo /usr/local/bin/bindplane init server --config /etc/bindplane/config.yaml

📘

Get the bindplane init command from the installer

The Server Initialization section of the installer will have the exact bindplane init command for your system.

You’ll be prompted to configure BindPlane OP with the following parameters. This updates the parameters in the config.yaml located by default at /etc/bindplane/config.yaml.

• Set host to the instance's IP address, or 0.0.0.0 to bind to all IP addresses.
• Set username to your desired username
• Set password to your desired password
• Set serverURL to the HTTP endpoint of the server.
• Set remoteURL to the web socket endpoint of the server
• Add secretKey to a new randomly generated UUID. This is automatically generated by the init command.

Restart Server

Finally, use the following command to restart the BindPlane server.

sudo systemctl restart bindplane

That's it, you've successfully installed BindPlane OP. Next, we'll show you how to access the BindPlane OP UI in your browser.