Running Highlight

To run our app locally, head to our github repo and clone the repository. Then follow the steps below.

Docker Compose

# ensure git submodules are cloned
git submodule update --init --recursive
cd docker
docker compose up -d --build

After a brief frontend load time, the app should be accessible at https://localhost:3000

For deploying on Linux with Docker, we recommend having at least 16 CPU cores, 32GB RAM, 256GB disk. Reach out to our community with any questions!

Limitations

We don't recommend hosting Highlight yourself if you have more than 10k monthly sessions or 50k monthly errors. The infrastructure configuration in the docker compose is not meant to scale beyond a small number of sessions, and isn't resilient to an outage or version upgrades.

That being said, if the benefits of self hosting Highlight are signficant enough, you may want to consider an enterprise deployment (see our Enterprise Self Hosted Docs).

If you have any questions, don't hesitate to reach out!