summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-10-16 17:45:02 +0000
committerLaurent Bercot <ska@appnovation.com>2023-10-16 17:45:02 +0000
commit24fb88dbb023ae08adc9989bf19e0c6c569a6607 (patch)
tree5e941db6305ce501782fcbdd79b6c854642d056e
parent6b157ebb404a44691746ee14a14ed5a51b1debb3 (diff)
downloadtipidee-24fb88dbb023ae08adc9989bf19e0c6c569a6607.tar.xz
Doc fixes
Signed-off-by: Laurent Bercot <ska@appnovation.com>
-rw-r--r--doc/tipideed.html25
1 files changed, 16 insertions, 9 deletions
diff --git a/doc/tipideed.html b/doc/tipideed.html
index 1d764ff..254fa2f 100644
--- a/doc/tipideed.html
+++ b/doc/tipideed.html
@@ -120,8 +120,7 @@ underlying system. </dd>
<p>
tipideed expects the following variables in its environment, and will exit
with an error message if they are undefined. When tipideed is run under
-<a href="//skarnet.org/s6-networking/s6-tcpserver.html">s6-tcpserver</a>
-(with <a href="//skarnet.org/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a>) or
+<a href="//skarnet.org/s6-networking/s6-tcpserver.html">s6-tcpserver</a> or
<a href="//skarnet.org/s6-networking/s6-tlsserver.html">s6-tlsserver</a>,
these variables are automatically set by the super-server. This is the way
tipidee gets its network information without having to perform network
@@ -136,6 +135,10 @@ operations itself.
<dd> The IP address the server is bound to. It will be passed as <tt>SERVER_ADDR</tt>
to CGI scripts. </dd>
+ <dt> TCPLOCALPORT </dt>
+ <dd> The port the server is bound to. It will be passed as <tt>SERVER_PORT</tt>
+to CGI scripts unless the requested URI explicitly mentions a different port. </dd>
+
<dt> TCPREMOTEIP </dt>
<dd> The IP address of the client. It will be passed as <tt>REMOTE_ADDR</tt>
to CGI scripts. </dd>
@@ -149,7 +152,13 @@ to CGI scripts. </dd>
<p>
tipideed can function without these variables, but if they're present, it
-uses them to get more information.
+uses them to get more information. They're typically obtained by calling
+<a href="//skarnet.org/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a>
+before tipideed in the
+<a href="//skarnet.org/s6-networking/s6-tcpserver.html">s6-tcpserver</a>
+command line.
+(For HTTPS, <a href="//skarnet.org/s6-networking/s6-tlsserver.html">s6-tlsserver</a>
+calls it implicitly.)
</p>
<dl>
@@ -160,12 +169,6 @@ 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>
-to CGI scripts unless the requested URI explicitly mentions a different port.
-If this variable is absent, the default will be set to 80 in case of HTTP or
-443 in the case of HTTPS. </dd>
-
<dt> TCPREMOTEHOST </dt>
<dd> The domain name associated to the IP address of the client. It will
be passed as <tt>REMOTE_HOST</tt> to CGI scripts; if absent, the value of
@@ -487,6 +490,10 @@ It makes no sense to try to follow the book to the letter, expending
precious resources, when the client can't even be bothered to pretend
it's legit. Knowing when to exit early is crucial for good resource
management. </li>
+ <li> tipideed does not have any configuration defaults baked in; it
+reads all its configuration values, including the defaults, from the cdb
+file created by <a href="tipidee-config.html">tipidee-config</a>. That
+is why having such a cdb file is mandatory for tipideed to run. </li>
<li> <tt>tipideed</tt> is pronounced <em>tipi-deed</em>. You can say
<em>tipi-dee-dee</em>, but only if you're the type of person who also says
<em>PC computer</em>, <em>NIC card</em> or <em>ATM machine</em>. </li>