Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add details to the Enable HTTPS how-to section #726

Open
5 tasks
consideRatio opened this issue Oct 22, 2021 · 0 comments
Open
5 tasks

Add details to the Enable HTTPS how-to section #726

consideRatio opened this issue Oct 22, 2021 · 0 comments
Labels
needs-documentation Issue that can be solved with documentation priority Issue selected to have a bit higher priority

Comments

@consideRatio
Copy link
Member

consideRatio commented Oct 22, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-documentation Issue that can be solved with documentation priority Issue selected to have a bit higher priority
Projects
None yet
Development

No branches or pull requests

1 participant