the-littlest-jupyterhub
the-littlest-jupyterhub copied to clipboard
Add details to the Enable HTTPS how-to section
The How to section: Enable HTTPS could use some additional details, as it is easy to have it fail for various reasons. I suggest we improve the documentation by adding details about:
- [ ] describe that using Let's Encrypt requires inbound network traffic to port 80 from the public internet, so if its setup to be exposed only within a private network only then this is not an option
- [ ] Try to be a bit more kind to the reader that hasn't registered a domain name, configured a DNS record, and acquired a cert from Let's Encrypt.
This text segment was explicitly mentioned as a bit tricky to handle without experience.
You must have a domain name set up to point to the IP address on which TLJH is accessible before you can set up HTTPS.
- [ ] verifying that your device is reachable from the internet on port 80 and port 443
- [ ] and that one need to restart traefik if one wants to make the domain certificate acquisition to trigger be re-attempted
- [ ] and that let's encrypt can block you if you try and fail too many times
Related
- #115 (closed in favor of this)
- #330 (closed in favor of this)
- #345 (closed in favor of this)
- #398 (closed in favor of this)
- #438 (closed in favor of this)
- #533 (closed in favor of this)