Docker-letsencrypt-nginx-proxy-companion: Doc updates for V3 Docker compose?

Created on 10 Jun 2020  路  5Comments  路  Source: nginx-proxy/docker-letsencrypt-nginx-proxy-companion

There are a lot of wildly varying examples on the web for using this with Docker compose v3, are there any thoughts about updating the docs to support it?

Documentation Update

Most helpful comment

Okay, I think I got it this time. I'll have to think about it, I don't wan't ending up merging https://github.com/buchdag/letsencrypt-nginx-proxy-companion-compose into this repo.

I know that @JrCs wasn't really hot on adding Docker compose reference files probably out of fear of having to troubleshoot people use of Docker compose rather than actual issue with the container. I must admit that I find myself having to do this more often than I'd like to (like in #651).

If I go this way and further develop the Docker compose docs I will probably have to add a note at some point about not providing support for any deviation from those reference examples.

All 5 comments

I could update the doc with the Docker compose v3 files used here if that suits you : https://github.com/buchdag/letsencrypt-nginx-proxy-companion-compose

edit: wrong URL

I've added another barebones example using the v2 syntax if that helps for now too:
https://gitlab.com/SuperRoach/barebones-ssl-letsencrypt

The doc mention in your edit is good that it explains what the tag was used for and stuff. It'd probably help to be a self contained example instead of only referencing the container you want to add.

It'd probably help to be a self contained example instead of only referencing the container you want to add.

I didn't get that part 馃樁

Sorry, by that I mean your example on there only illustrates what the container we should add looks like - you could give us a sample or two of how it would look like (the connected volumes for example) with a self contained piece of code that could live in a docker-compose.yml file.

In the issue https://github.com/nginx-proxy/docker-letsencrypt-nginx-proxy-companion/issues/651 , the main problem was interpreting where the volumes go as an example, and the sample posted is difficult to use in isolation (due to the amount of environment vars in it)

Okay, I think I got it this time. I'll have to think about it, I don't wan't ending up merging https://github.com/buchdag/letsencrypt-nginx-proxy-companion-compose into this repo.

I know that @JrCs wasn't really hot on adding Docker compose reference files probably out of fear of having to troubleshoot people use of Docker compose rather than actual issue with the container. I must admit that I find myself having to do this more often than I'd like to (like in #651).

If I go this way and further develop the Docker compose docs I will probably have to add a note at some point about not providing support for any deviation from those reference examples.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

synopsisdevs picture synopsisdevs  路  7Comments

KetchupBomb picture KetchupBomb  路  6Comments

ToniSoftware picture ToniSoftware  路  4Comments

elifiner picture elifiner  路  6Comments

DatAres37 picture DatAres37  路  5Comments