Hobby deployment guide.
Clone the highlight.io repository and make sure to checkout the submodules with the
If this hobby deploy is running on a remote server, make changes to the
docker/.env file for your deployment. Update the following values to your backend IP address.
The frontend for hobby deploy now defaults to using password auth. That uses a password set in your deployments
docker/.env file to authenticate users. Update the following environment variable to your preferred admin password.
highlight/docker directory, run
./run-hobby.sh to start the docker stack.
Visit https://localhost:3000 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.
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.
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.