traefik-proxy icon indicating copy to clipboard operation
traefik-proxy copied to clipboard

Add example docker compose environment and related docs

Open alexleach opened this issue 2 years ago • 5 comments

Hello!

As mentioned in a comment I made yesterday, I thought the documentation and example folder could benefit from some information regarding docker-compose. It's what I use for my jupyterhub environment, and I think works well for single server environments.

Some suggested example configuration and documentation files are attached.

Kind regards, Alex

alexleach avatar Feb 22 '23 12:02 alexleach

We've got a example docker deployment repo https://github.com/jupyterhub/jupyterhub-deploy-docker so that's another option.

What does everyone else think? Have this example in this repo, or add it to a subdirectory of https://github.com/jupyterhub/jupyterhub-deploy-docker so that repo becomes a set of docker related deployment examples?

manics avatar Feb 22 '23 12:02 manics

Hmm, good point!

What does everyone else think? Have this example in this repo, or add it to a subdirectory of https://github.com/jupyterhub/jupyterhub-deploy-docker so that repo becomes a set of docker related deployment examples?

I believe having it in https://github.com/jupyterhub/jupyterhub-deploy-docker makes more sense so my vote goes towards that. I think for trefik-proxy it makes sense to just reference the example from its docs.

GeorgianaElena avatar Feb 22 '23 12:02 GeorgianaElena

I've opened a PR to move the existing example into a subdirectory, so it'll be easier to add more examples https://github.com/jupyterhub/jupyterhub-deploy-docker/pull/117

manics avatar Feb 22 '23 13:02 manics

Hiya. I was just wondering about this. I'm fine with moving it to the docker-compose example repo, but don't think there's anything I can do until that PR is merged, is there?

Cheers, Alex

alexleach avatar Mar 03 '23 14:03 alexleach

https://github.com/jupyterhub/jupyterhub-deploy-docker has been refactored to make it easier to add new examples. The README will require some reorganisation, or splitting into separate files (e.g. one README per example?), depending on exactly how the additional examples are documented.

manics avatar Mar 17 '23 16:03 manics