summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-10-18 13:07:23 +0000
committerLaurent Bercot <ska@appnovation.com>2023-10-18 13:07:23 +0000
commit1a7e3d00588725da3d8764fa9d624bc8611be070 (patch)
tree65d28b52bd1d4ccdbeb418d4d681b1999ed46b7a /doc
parent24fb88dbb023ae08adc9989bf19e0c6c569a6607 (diff)
downloadtipidee-1a7e3d00588725da3d8764fa9d624bc8611be070.tar.xz
Add infrastructure for custom error files
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/tipidee.conf.html7
-rw-r--r--doc/tipideed.html10
2 files changed, 10 insertions, 7 deletions
diff --git a/doc/tipidee.conf.html b/doc/tipidee.conf.html
index 76ffae1..483d9d0 100644
--- a/doc/tipidee.conf.html
+++ b/doc/tipidee.conf.html
@@ -407,9 +407,12 @@ malicious clients messing with log lines.
This keyword has no effect when given without the <tt>request</tt> keyword. </dd>
<dt> <tt>resource</tt> </dt> <dd> Log a <tt>resource</tt> line when <a href="tipideed.html">tipideed</a>
has found a resource corresponding to the URI and is willing to serve it. The line looks like
-<tt>resource docroot <em>docroot</em> file <em>file</em> type <em>type</em></tt>. <em>docroot</em> is
-the document root of the virtual host; <em>file</em> is the path to the served file; <em>type</em>
+<tt>resource <em>file</em> type <em>type</em></tt>.
+<em>file</em> is the path to the served file; the first component of that path is always
+the document root of the virtual host. <em>type</em>
is <tt>nph</tt> for an NPH script, <tt>cgi</tt> for a CGI script, or the Content-Type for a regular file.
+If it's a CGI or NPH script being called with a non-empty PATH_INFO, an additional <tt>path_info <em>path_info</em></tt>
+field is added to the log line.
If a served CGI script outputs a local redirection, several <tt>resource</tt> lines may appear for
a single request. </dd>
<dt> <tt>answer</tt> </dt> <dd> Log an <tt>answer</tt> line when <a href="tipideed.html">tipideed</a>
diff --git a/doc/tipideed.html b/doc/tipideed.html
index 254fa2f..eebdb6d 100644
--- a/doc/tipideed.html
+++ b/doc/tipideed.html
@@ -120,8 +120,8 @@ 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> or
-<a href="//skarnet.org/s6-networking/s6-tlsserver.html">s6-tlsserver</a>,
+<a href="//skarnet.org/software/s6-networking/s6-tcpserver.html">s6-tcpserver</a> or
+<a href="//skarnet.org/software/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
operations itself.
@@ -153,11 +153,11 @@ to CGI scripts. </dd>
<p>
tipideed can function without these variables, but if they're present, it
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>
+<a href="//skarnet.org/software/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>
+<a href="//skarnet.org/software/s6-networking/s6-tcpserver.html">s6-tcpserver</a>
command line.
-(For HTTPS, <a href="//skarnet.org/s6-networking/s6-tlsserver.html">s6-tlsserver</a>
+(For HTTPS, <a href="//skarnet.org/software/s6-networking/s6-tlsserver.html">s6-tlsserver</a>
calls it implicitly.)
</p>