Hobby deployment guide.

Before we get started, you should have the latest version of docker (19.03.0+) and git (2.13+) installed. For a local deploy, we suggest configuring docker to use at least 16GB of memory and 4 CPUs.

Clone the repository.

Clone the highlight.io repository and make sure to checkout the submodules with the --recurse-submodules flag.

git clone --recurse-submodules https://github.com/highlight/highlight

Enter the `highlight/docker` directory.

Navigate into the highlight/docker directory of the repo.

cd highlight/docker

Start the docker compose containers.

In the highlight/docker directory, run docker compose up --build -d to start the docker containers.

docker compose up --build -d

Visit the dashboard.

Visit https://localhost:3000 to view the dashboard; there are no login credentials required.

Setup the snippet.

In your frontend application, you should setup highlight.io as usual (see our guides), with the exception of adding the backendUrl flag to your init() method. See the example in react to the right.

import { H } from 'highlight.run';

H.init('<YOUR_PROJECT_ID>', {
    backendUrl: 'https://localhost:8082/public',
    ...
});

Troubleshoot the deployment.

Having issues? Here's some things ot try. First run the docker ps command and ensure that all containers are in a 'healthy' state. As a second step, run docker compose logs -f backend frontend to see the logs for the backend and frontend containers. If this doesn't help w/ troubleshooting, please reach out.

docker ps
docker compose logs -f backend frontend

Self Host & Local Dev Docs Home