Skip to content

Commit 709716a

Browse files
committed
docs(readme): update configuration instructions and clarify network naming
Updated the README to provide clearer instructions on configuring Traefik, especially regarding the use of `traefik.monitoredLabel` and `traefik.docker.network`. Added a warning about network name prefixing in Docker Compose and adjusted the FAQ section for better clarity. Corrected a minor typo in the credits section.
1 parent e1c4d91 commit 709716a

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

Diff for: README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,14 @@ For more details about the configuration options, refer to the [Configuration](#
6565
Modify `config.yaml` to adjust the Traefik container name, the label to monitor, and other settings. Key configuration options include:
6666

6767
- `traefik.containerName`: Name of the Traefik container in Docker.
68-
- `traefik.monitoredLabel`: Docker label that triggers network connection actions. (DEPRECATED ! Directly use `traefik.docker.network` instead in Traefik 2.0+)
6968
- `logLevel`: Adjust the verbosity of the script's output.
69+
- `traefik.monitoredLabel`: Docker label that triggers network connection actions. (DEPRECATED ! Directly use `traefik.docker.network` instead in Traefik 2.0+)
70+
71+
> :warning: **Take care !**
72+
> @ If you use `traefik.monitoredLabel`, you just have to give the network name in your compose file.
73+
> But if you use `traefik.docker.network`, you need to prefix the network name (for the example, let's say `mynetwork`) with your deployment name (for example, you run `docker compose up` in a directory named `foo`, your network name will be `foo_mynetwork`).
74+
> I don't understand why me, a single developer without special knowledge about docker, I was able to detect the compose name, but not Traefik...
75+
> So you can't use a same compose for multiple deployment, it's kind of ridiculous, but I didn't find an elegant solution... (Il you have an idea, contact me !)
7076
7177
For a detailed explanation of all configuration options, refer to the comments within `config.yaml`.
7278

@@ -169,11 +175,8 @@ This section addresses common issues and questions:
169175
- **Q: How can I debug issues with incorrect configuration values?**
170176
- **A:** Ensure that your command line arguments and environment variables are correctly formatted and match the expected patterns. Use the `--help` option with the script to see available command line arguments.
171177

172-
173178
- **Q: How can I specify the networks Traefik should connect to?**
174-
- **A:** To specify the networks Traefik should connect to, you can set the `autoproxy.networks` label on the Docker containers you want Traefik to manage. Add the label with the network names separated by commas. You can change the label in [Configuration](#configuration).
175-
176-
179+
- **A:** It was easy, but... Look at [Configuration](#configuration).
177180

178181
## Contributing
179182

@@ -185,6 +188,6 @@ For support or queries, please open an issue on this repository. We aim to respo
185188

186189
👾 **obeone**
187190

188-
Primarily powered by my new brain, GPT-4, with some crucial tweaks and oversight from my secondary brain.
191+
Primarily powered by my new brain, GPT-4o, with some crucial tweaks and oversight from my secondary brain.
189192

190193
Check out more of my work on [GitHub](https://github.com/obeone).

0 commit comments

Comments
 (0)