Before we get started, you should install Go (1.21), Node.js (18+), and yarn (1+). You should have the latest version of Docker (25.0+) with the docker compose plugin (2.24+) and Git (2.13+) installed. We suggest configuring docker to use at least 8GB of RAM, 4 CPUs, and 64 GB of disk space.

$ go version
go version go1.21.6 linux/arm64

$ node --version
v18.15.0

$ yarn --version
4.0.2

$ docker --version
Docker version 25.0.3, build 4debf41

$ docker compose version
Docker Compose version v2.24.5

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.sh to start the docker containers.

cd highlight/docker;
./run.sh;

(Optional) Running in different terminals.

While the above instructions will hot-reload, you might want more control of parts of the stack when developing. Running the dev workflow manually is easy in different terminals as well.

# first, start the infrastructure containers
cd highlight/docker;
./start-infra.sh;

# start the backend. this will run make start-no-doppler in backend and block until you stop it with ctrl+c.
cd highlight/docker;
./run-backend.sh

# now, start the frontend in a second terminal. this will run yarn docker:frontend in the monorepo and block until you stop it with ctrl+c.
./run-frontend.sh

Visit the dashboard.

Visit your REACT_APP_FRONTEND_URI to view the dashboard and go through the login flow; use the password set in docker/.env variable ADMIN_PASSWORD with any valid email address.

View your first session.

After clicking around on the dashboard for a bit, you should see a session appear at http://localhost:3000/1/sessions. Click on the session to view the session details page.

Troubleshoot the deployment.

Having issues? Here's some things to 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

Self Host & Local Development Integrations