diff options
author | Laurent Bercot <ska-skaware@skarnet.org> | 2023-09-30 10:08:23 +0000 |
---|---|---|
committer | Laurent Bercot <ska@appnovation.com> | 2023-09-30 10:08:23 +0000 |
commit | 8d66c8c5cac310958fa64e3f62b828ea960202ba (patch) | |
tree | 34e4e8d195f5a706ad8b654d8b6dab6e0576f218 /doc | |
parent | 00774b3f92bd6898ce56f41ce39074e9fe89c08e (diff) | |
download | tipidee-8d66c8c5cac310958fa64e3f62b828ea960202ba.tar.xz |
Doc update
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/index.html | 10 | ||||
-rw-r--r-- | doc/tipideed.html | 20 |
2 files changed, 19 insertions, 11 deletions
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. </li> <li> Recommended at run-time: <a href="//skarnet.org/software/s6-networking/">s6-networking</a> 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 +<a href="//skarnet.org/software/s6-networking/s6-tcpserver.html">s6-tcpserver</a> +to listen to the network and provide connection information via environment variables. It also defers to tools such as <a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a> to provide access control and connection fine-tuning. And if you want to run an HTTPS server, you'll need something like <a href="//skarnet.org/software/s6-networking/s6-tlsserver.html">s6-tlsserver</a> -to manage the TLS transport layer. It <em>will</em> make -your life easier. +to manage the TLS transport layer. It <em>will</em> make your life easier. <ul> - <li> Also, when built with BearSSL, + <li> When built with BearSSL, <a href="//skarnet.org/software/s6-networking/s6-tlsserver.html">s6-tlsserver</a> basically gives you a TLS tunnel <em>for free</em>. Bearly any RAM use. Don't take my word for it; try it out for yourself. </li> 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. <dt> TCPLOCALHOST </dt> <dd> The default domain name associated to the local IP address. It will be passed as <tt>SERVER_NAME</tt> 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). </dd> +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). </dd> <dt> TCPLOCALPORT </dt> <dd> The port the server is bound to. It will be passed as <tt>SERVER_PORT</tt> @@ -322,9 +322,17 @@ your <tt>/etc/passwd</tt> file, tipideed will keep it safe. <p> 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 <tt>@</tt> (at), so documents will likely be looked for -under <tt>@:80</tt> or <tt>@:443</tt>. +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 <tt>-l</tt> option to +<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a> or +<a href="//skarnet.org/software/s6-networking/s6-tlsserver.html">s6-tlsserver</a>. +If TCPLOCALHOST does not exist or is empty, a fallback value of +<tt>@</tt> (at), will be used. So if you aren't calling +<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a> +at all, your documents will most likely be accessible for HTTP/1.0 clients under +<tt>@:80</tt> or <tt>@:443</tt>. </p> <div id="details"> |