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 hobby deploy, we suggest configuring docker to use at least 8GB of RAM, 4 CPUs, and 64 GB of disk space.

$ docker --version
Docker version 20.10.23, build 7155243
$ docker compose version
Docker Compose version v2.15.1

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

Start highlight.

In the highlight/docker directory, run ./run-hobby.sh to start the docker stack.

cd highlight/docker;
./run-hobby.sh;

Visit the dashboard.

Visit https://localhost:3000 to view the dashboard and go through the login flow; 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 to see the logs for the infra containers. Looking at the logs, if any containers are not healthy, use the follow commands to start from scratch. If this doesn't help with troubleshooting, please reach out.

docker ps
docker compose logs
# delete everything in the docker compose stack
docker compose down --remove-orphans --volumes --rmi local

Development deployment guide.Docs Home