Skip to content

Commit

Permalink
chore: Made the traefik based docker compose example more usable (#2055)
Browse files Browse the repository at this point in the history
  • Loading branch information
dadrus authored Dec 19, 2024
1 parent 880bc4e commit 6c22355
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion examples/docker-compose/quickstarts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ In that setup heimdall is not integrated with any other reverse proxy.

In that setup heimdall is integrated with Traefik. All requests are sent to traefik, which then contacts heimdall as external authorization middleware and depending on the response from heimdall either forwards the request to the upstream service, or directly responses with an error from heimdall.

*NOTE:* This setup uses Traefik's Docker provider and mounts the `docker.sock` file into the Traefik container. It also assumes a rootless Docker installation. If your installation differs, you may need to modify the `docker.sock` volume mount in the `docker-compose-traefik.yaml` file, likely changing it to `"/var/run/docker.sock:/var/run/docker.sock:ro"`.
*NOTE:* This setup uses Traefik's Docker provider and mounts the `docker.sock` file into the Traefik container. Your docker installation may differ requiring a modification of the configured volume mount in the `docker-compose-traefik.yaml` file.

1. Start the environment with

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ services:
--entryPoints.http.address=":9090"
--accesslog --api=true --api.insecure=true
volumes:
- "${XDG_RUNTIME_DIR}/docker.sock:/var/run/docker.sock:ro"
- "/var/run/docker.sock:/var/run/docker.sock:ro"
labels:
- traefik.enable=true
- traefik.http.routers.traefik_http.service=api@internal
Expand Down

0 comments on commit 6c22355

Please sign in to comment.