Add example for static names in README.md #257
Conversation
README.md
Outdated
|
|
||
| Note: If the docker-gen container name is static and you want to explicitly set it, use `-e NGINX_DOCKER_GEN_CONTAINER=nginx-gen`. The same thing is true with the nginx container (`-e NGINX_PROXY_CONTAINER=nginx`). | ||
| Note: | ||
| If the 3 containers are using using static names, as shown in the examples. The label (`--label com.github.jrcs.letsencrypt_nginx_proxy_companion.docker_gen`) on `nginx` container can be removed and additional evironment variables set on the `letsencrypt-nginx-proxy-companion` container. The variables are `-e NGINX_DOCKER_GEN_CONTAINER=nginx-gen` and `-e NGINX_PROXY_CONTAINER=nginx`. |
There was a problem hiding this comment.
The variables themselves are just NGINX_DOCKER_GEN_CONTAINER and NGINX_PROXY_CONTAINER, not the whole thing with the -e switch and the variable value.
|
|
||
| * Then start any containers to be proxied as described previously. | ||
|
|
||
| Note: If the docker-gen container name is static and you want to explicitly set it, use `-e NGINX_DOCKER_GEN_CONTAINER=nginx-gen`. The same thing is true with the nginx container (`-e NGINX_PROXY_CONTAINER=nginx`). |
There was a problem hiding this comment.
I've removed the -e switch from the variable names.
README.md
Outdated
|
|
||
| Note: If the docker-gen container name is static and you want to explicitly set it, use `-e NGINX_DOCKER_GEN_CONTAINER=nginx-gen`. The same thing is true with the nginx container (`-e NGINX_PROXY_CONTAINER=nginx`). | ||
| Note: | ||
| If the 3 containers are using using static names, as shown in the examples. The label (`--label com.github.jrcs.letsencrypt_nginx_proxy_companion.docker_gen`) on `nginx` container can be removed and additional evironment variables set on the `letsencrypt-nginx-proxy-companion` container. The variables are `NGINX_DOCKER_GEN_CONTAINER=nginx-gen` and `NGINX_PROXY_CONTAINER=nginx`. |
There was a problem hiding this comment.
I removed the -e from the variables.
There was a problem hiding this comment.
The variables are NGINX_PROXY_CONTAINER and NGINX_DOCKER_GEN_CONTAINER, nginx and nginx-gen are their respective value in the context of this example only, that should be made clear like in the rest of the doc.
In my opinion the way you wrote it might cause people to believe that the two variables have to be set to nginx and nginx-gen regardless of the name given to the nginx and docker-gen containers. It should be made clearer that those two values have to be the static names chosen for the nginx and doker-gen containers.
|
@buchdag is it ok to merge this PR ? |
|
@JrCs I think the wording is still unclear as it is mixing labels themselves with the |
In the rest of the documentation labels are surround in double quotes. This commit makes it consistent in the static container name example.
Containers are now referred to as nginx contain and letsencrypt container. There was concern about confusion when using the name of the containers specific in the examples, rather than referring to them by generic names.
|
@buchdag I've made the wording more consistent with the rest of the readme. The labels are now surrounded by double quotes instead of being prefaced by |
|
@mjmayer I might not have been clear enough myself, your use of markdown was perfectly right, sorry for the unnecessary work. What I meant is that you have be more explicit on the fact that Let me show you what I mean:
And then your example. The [...] are meant to be replaced by the existing text, obviously. BTW there are two small typos ("using using" and "evironment"). |
|
@buchdag Thanks for clarifying. Hopefully the most recent commit is better. |
Documentation was unclear regarding statically named contains and where the environment variables went.