docker-compose.yml

---

#
# Cheat sheet:
#
#   $ echo -e "UID=$(id -u)\nGID=$(id -g)" > .env
#   $ docker compose up --build --detach dev
#
#   $ docker compose exec --user dev --workdir /mnt/host dev bash
#     # Compile with development mode enabled & run the application overriding
#     # some settings in the configuration file.
#     $ ENVIRONMENT=development make
#     $ ./build/bin/varnishmon --config ./files/varnishmon.yml --loglevel info
#
#     # Regenerate static assets & templates incrementally (only useful when
#     # compiling with development mode enabled). This is convenient when
#     # developing is focused on the backend side. Web UI will be available at
#     # http://127.0.0.1:6100.
#     $ make web-watch
#
#     # Use Vite's development server to serve the web UI, proxying API requests
#     # to the backend. This is convenient when developing is focused on the
#     # frontend side. Web UI will be available at http://127.0.0.1:5173.
#     $ make web-serve
#
#     # Regenerate static assets & templates, ready for production. Beware
#     # generated files are versioned to simplify the whole packaging process.
#     # It's ok to push generated static assets & templates to the repository
#     # at any time, but the ideal scenario is to do it only when creating a
#     # new release.
#     $ make web-build
#     $ git add ...
#
#     # Run the test suite (or part of it).
#     $ TEST_PACKAGES='./pkg/helpers/...' TEST_PATTERN='TestLogFileWriterTestSuite' make test
#
#     # Trigger reopening of the log and database files.
#     $ kill -HUP $(pgrep varnishmon)
#
#     # Generate dist & package files. This will fail if activation of the
#     # development mode is requested (i.e., ENVIRONMENT=development). Also,
#     # beware packing is expected to be done on the target platform +
#     # architecture.
#     $ PLATFORM=noble make package
#
#     # Periodic update of dependencies:
#     #   - Development & CI environments:
#     #     + extras/docker/Dockerfile: Go, Node.js, FPM, etc.
#     #     + .github/workflows/main.yml: Go, etc.
#     #     + extras/github/docker/*: FPM, etc.
#     #     + Makefile: Go tools no handled using the tools pattern, etc. + make mocks
#     #   - Go:
#     #     + go get -u ./... + make mod fmt lint vet modernize test
#     #   - Node.js:
#     #     + rm -rf package-lock.json node_modules && npm update --save && npm audit fix
#     #     + npm outdated && npm install --save-dev <package>@latest
#
#     # Fetch profiling data & metrics.
#     $ curl -o /tmp/cpu.pprof http://127.0.0.1:6100/debug/pprof/profile?seconds=15
#     $ curl -v http://127.0.0.1:6100/metrics
#
#   $ docker compose exec --user root --workdir /root dev bash
#     # Supervisor commands.
#     $ supervisorctl status
#     $ supervisorctl restart varnishd
#
#   $ docker compose logs --follow dev
#
#   $ docker compose down --volumes --remove-orphans
#
#   $ IMAGE=$(docker build \
#       --file extras/github/docker/Dockerfile-jammy \
#       --build-arg GO_VERSION=1.24.0 \
#       .)
#   $ docker run \
#       --rm \
#       --volume .:/workspace \
#       --workdir /workspace
#       $IMAGE \
#       bash -c '\
#         git config --global --add safe.directory /workspace; \
#         export PATH=/usr/local/go/bin:$PATH; \
#         export PLATFORM=jammy; \
#         make package'
#

name: varnishmon

services:
  dev:
    hostname: dev
    build:
      context: ./extras/docker
    privileged: true
    environment:
      HOST_UID: ${UID:?}
      HOST_GID: ${GID:?}
    volumes:
      - .:/mnt/host.raw
    ports:
      - 5173:5173
      - 6100:6100
    tmpfs:
      - /run
      - /run/lock
      - /var/cache
      - /tmp:exec