Reworking README.Debian.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 26 insertions, 15 deletions

diff --git a/debian/ttyd.README.Debian b/debian/ttyd.README.Debian
index 3fd0de1..90fe148 100644
--- a/debian/ttyd.README.Debian
+++ b/debian/ttyd.README.Debian
@@ -1,29 +1,40 @@
 ttyd for Debian
 ===============
 
-  * After installing ttyd it will by default listen on http://localhost:7681
-    in multi-user read-write "login"-mode:
+1. Default configuration
+------------------------
 
-    - multi-user means that more than one user can connect at the same time.
+After installing ttyd it will by default listen on http://localhost:7681
+in multi-user read-write "login"-mode:
 
-    - read-write means that anyone connecting to the website can input data.
+  * multi-user means that more than one user can connect at the same time.
 
-    - Login mode means that the user gets a login prompt (like getty) where
-      user and password has to be entered.
+  * read-write means that anyone connecting to the website can input data.
 
-  * Edit /etc/default/ttyd and check the ttyd(1) manpage for the exact options.
+  * Login mode means that the user gets a login prompt (like getty) where
+    user and password has to be entered.
 
-To enable access to ttyd via apache2, enabling the shipped reverse proxy
-configuration needs the following steps:
+Edit /etc/default/ttyd and check the ttyd(1) manpage for the exact options.
 
-  * a2enmod proxy
-  * a2enmod proxy_http
-  * a2enmod proxy_http2
-  * a2enmod proxy_wstunnel
 
-  * a2enconf ttyd
+2. Reverse proxy
+----------------
 
-ttyd is now accessible as <http://example.org/ttyd>, consider protecting this with
+To make ttyd accessible on the network, it is advised to hide it behind a
+reverse proxy that does TLS and performs user authentication.
+
+To enable the apache2 proxy configuration, the following modules and
+configuration need to be enabled:
+
+  * sudo a2enmod proxy proxy_http proxy_http2 proxy_wstunnel
+  * sudo a2enconf ttyd
+  * sudo service apache2 reload
+
+ttyd is then accessible as <http://example.org/ttyd>.
+
+
+
+, consider protecting this with
 TLS as well as some authentication.
 
  -- Daniel Baumann <daniel.baumann@progress-linux.org>  Sun, 21 Feb 2021 17:19:20 +0100