Quickstart

Open your terminal and run the following command to clone the Opslane repository:

git clone https://github.com/opslane/opslane.git
cd opslane

Opslane requires an external URL accessible from the internet for features like Slack integration and Datadog webhooks. We’ll use Ngrok to create this URL.

1. Sign up for a free Ngrok account at https://ngrok.com if you haven’t already.
2. Install Ngrok following their installation guide.
3. Authenticate Ngrok with your account token:

ngrok authtoken YOUR_NGROK_AUTH_TOKEN

4. Start your ngrok tunnel

The ngrok tunnel should point to port 8001 (where the API server will run):

ngrok http --subdomain=xxx --host-header=rewrite 8001 --region us

1. Copy the example environment file:

cp .env.example .env

2. Leave the dummy values for now. We will come back and update them.

Build and run the Opslane Docker container:

docker-compose up --build

This command will start Opslane. Before we can get the alert classification to work, we need to get the Slack and Datadog integrations to work.

For detailed instructions on setting up the Opslane Slack bot, including adding it to your channels and configuring permissions, please refer to our Slack Bot Setup Guide.

For detailed instructions on setting up the Datadog integration, please refer to our Datadog Setup Guide.