Using Docker Compose

The most straightforward way to have Sandhole up and running is with Docker Compose. Mainly, this takes care of managing TLS for you, and also daemonizes your application.

For this, you'll first need to install the Docker Engine on your server.

An example configuration is provided in the repository's docker-compose-example/sandhole directory, using sandhole.com.br as the example domain. Copy the compose.yml and config.toml files to the desired directory, and adjust them as necessary.

Then, simply run:

docker compose up --detach

You should also re-run this command whenever you make changes to your configuration and/or after you update to the latest image (docker compose pull). See the official Docker Compose documentation for more information.

An alternate configuration using dnsrobocert is available under docker-compose-example/sandhole-dnsrobocert in the repository.