Skip to content

docs: describe use with itkdev-docker #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yepzdk wants to merge 1 commit into from
Closed

docs: describe use with itkdev-docker #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Light and dark mode, chosen under Appearance in Settings; the default follows
the system setting.
- Clicking a service row copies its agents call URL to the clipboard.
- README section on using Agent Proxy with itkdev-docker's untracked
`traefik/dynamic.d/` config directory.

### Changed

Expand Down
22 changes: 21 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,27 @@ providers:
```

When Traefik runs in Docker, including Docker Desktop on macOS, point Agent
Proxy at the host side of the bind mount, not the container path.
Proxy at the host side of the bind mount, not the container path. Traefik also
reads subdirectories of the file provider directory, but only reloads on
changes to files directly in it, so mount the directory Agent Proxy writes to
as the provider directory itself, not as a subdirectory of it.

### With itkdev-docker

[itkdev-docker](https://github.com/itk-dev/devops_itkdev-docker) mounts the
untracked `traefik/dynamic.d/` as Traefik's config directory, next to the
shared `traefik/dynamic-conf.yaml`. Point Agent Proxy at the directory:

```sh
./agent-proxy -config ~/itkdev-docker/traefik/dynamic.d -traefik http://127.0.0.1:8080
```

Do not point it at `traefik/dynamic-conf.yaml`. That file is tracked in a public
repository, so a commit would publish the API keys. To move services already in
it, add them again in Agent Proxy or move their entries to `dynamic.d/`, then
restore the shared file with `git checkout -- traefik/dynamic-conf.yaml`. Keep
each service in one place only: Traefik drops a router or middleware defined
twice with different content.

## Usage

Expand Down