summaryrefslogtreecommitdiffstats
path: root/debian/ttyd.README.Debian
blob: 90fe148d6d6e8dc455b23b6d9201dbb60612b435 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
ttyd for Debian
===============

1. Default configuration
------------------------

After installing ttyd it will by default listen on http://localhost:7681
in multi-user read-write "login"-mode:

  * multi-user means that more than one user can connect at the same time.

  * read-write means that anyone connecting to the website can input data.

  * Login mode means that the user gets a login prompt (like getty) where
    user and password has to be entered.

Edit /etc/default/ttyd and check the ttyd(1) manpage for the exact options.


2. Reverse proxy
----------------

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