From 8d66c8c5cac310958fa64e3f62b828ea960202ba Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sat, 30 Sep 2023 10:08:23 +0000 Subject: Doc update Signed-off-by: Laurent Bercot --- INSTALL | 2 +- doc/index.html | 10 +++++----- doc/tipideed.html | 20 ++++++++++++++------ 3 files changed, 20 insertions(+), 12 deletions(-) diff --git a/INSTALL b/INSTALL index 124ce2b..ad5c866 100644 --- a/INSTALL +++ b/INSTALL @@ -7,7 +7,7 @@ Build Instructions - A POSIX-compliant C development environment - GNU make version 3.81 or later - skalibs version 2.14.0.0 or later: https://skarnet.org/software/skalibs/ - - (optional but recommended): s6-networking version 2.5.1.4 or later: + - (optional but recommended): s6-networking version 2.6.0.0 or later: https://skarnet.org/software/s6-networking/ This software will run on any operating system that implements diff --git a/doc/index.html b/doc/index.html index b30b01a..da7aa73 100644 --- a/doc/index.html +++ b/doc/index.html @@ -116,17 +116,17 @@ is going on with the code, too. requirement if you link against the shared version of the skalibs library.
  • Recommended at run-time: s6-networking version -2.5.1.4 or later. It's not a strict requirement, but tipidee relies -on a super-server to listen to the network and provide connection +2.6.0.0 or later. It's not a strict requirement, but tipidee relies on a super-server such as +s6-tcpserver +to listen to the network and provide connection information via environment variables. It also defers to tools such as s6-tcpserver-access to provide access control and connection fine-tuning. And if you want to run an HTTPS server, you'll need something like s6-tlsserver -to manage the TLS transport layer. It will make -your life easier. +to manage the TLS transport layer. It will make your life easier.
      -
    • Also, when built with BearSSL, +
    • When built with BearSSL, s6-tlsserver basically gives you a TLS tunnel for free. Bearly any RAM use. Don't take my word for it; try it out for yourself.
      • diff --git a/doc/tipideed.html b/doc/tipideed.html index 2fa626a..8f080bc 100644 --- a/doc/tipideed.html +++ b/doc/tipideed.html @@ -158,9 +158,9 @@ uses them to get more information.
      TCPLOCALHOST
      The default domain name associated to the local IP address. It will be passed as SERVER_NAME to CGI scripts when the requested URI does -not mention a Host, i.e. in HTTP/1.0 requests. If this variable is absent, -the default will be set to the local IP address itself (between square -brackets if IPv6).
      +not mention a Host, i.e. in HTTP/1.0 requests without a full request URL. +If this variable is absent, the default will be set to the local IP address +itself (between square brackets if IPv6).
      TCPLOCALPORT
      The port the server is bound to. It will be passed as SERVER_PORT @@ -322,9 +322,17 @@ your /etc/passwd file, tipideed will keep it safe.

      HTTP/1.0 does not have the concepts of virtual hosts. For HTTP/1.0 -requests that do not provide a full URL, tipideed will use a default -host name of @ (at), so documents will likely be looked for -under @:80 or @:443. +requests that do not provide a full URL, tipideed will use the value +it reads from the TCPLOCALHOST variable, which is normally the result +of a reverse DNS lookup on the server's address. You can override the +lookup and provide your own value by giving the -l option to +s6-tcpserver-access or +s6-tlsserver. +If TCPLOCALHOST does not exist or is empty, a fallback value of +@ (at), will be used. So if you aren't calling +s6-tcpserver-access +at all, your documents will most likely be accessible for HTTP/1.0 clients under +@:80 or @:443.

      -- cgit v1.2.3