From a569417dad883469c03ac95ec2d3c2081a4cbc8d Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Sat, 18 May 2019 17:46:06 -0700 Subject: [PATCH] Document that you need a domain name before HTTPS Also note that Let's Encrypt doesn't work in private networks. Fixes #217 --- docs/howto/admin/https.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/howto/admin/https.rst b/docs/howto/admin/https.rst index e525840..853a109 100644 --- a/docs/howto/admin/https.rst +++ b/docs/howto/admin/https.rst @@ -15,11 +15,23 @@ certificate. Unless you have a strong reason to use the manual method, you should use the :ref:`Let's Encrypt ` method. +.. note:: + + 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. + .. _howto/admin/https/letsencrypt: Automatic HTTPS with Let's Encrypt ================================== +.. note:: + + If the machine you are running on is not reachable from the internet - + for example, if it is a machine internal to your organization that + is cut off from the internet - you can not use this method. Please + set up a DNS entry and HTTPS :ref:`manually `. + To enable HTTPS via letsencrypt:: sudo tljh-config set https.enabled true @@ -33,7 +45,6 @@ Once you have loaded this, your config should look like:: sudo tljh-config show - .. sourcecode:: yaml https: