summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-12-15 10:35:41 +0000
committerLaurent Bercot <ska@appnovation.com>2023-12-15 10:35:41 +0000
commitd2959364ef8d6bc948474a8facf497788b4e768b (patch)
treee1459c1c94e9b7556c21c0b43d7144a162601b0a /doc
parent66844097454a8f2b4eddec64d4f276602c4cdd3a (diff)
downloadtipidee-d2959364ef8d6bc948474a8facf497788b4e768b.tar.xz
Prepare for 0.0.3.0; add XXX_no_translate
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html6
-rw-r--r--doc/tipidee.conf.html31
-rw-r--r--doc/upgrade.html10
3 files changed, 44 insertions, 3 deletions
diff --git a/doc/index.html b/doc/index.html
index 0db88cd..2aef76b 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -111,11 +111,11 @@ make it shorter. Just like the code.
<li> A POSIX-compliant system with a standard C development environment </li>
<li> GNU make, version 3.81 or later </li>
<li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version
-2.14.0.1 or later. It's a build-time requirement. It's also a run-time
+2.14.1.0 or later. It's a build-time requirement. It's also a run-time
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.7.0.0 or later. It's not a strict requirement, but tipidee relies on a super-server such as
+2.7.0.1 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
@@ -143,7 +143,7 @@ Don't take my word for it; try it out for yourself. </li>
<ul>
<li> The current released version of tipidee is
-<a href="tipidee-0.0.2.0.tar.gz">0.0.2.0</a>. </li>
+<a href="tipidee-0.0.3.0.tar.gz">0.0.3.0</a>. </li>
<li> You can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/tipidee/">tipidee
git repository</a>:
diff --git a/doc/tipidee.conf.html b/doc/tipidee.conf.html
index 691ac94..17c1a4f 100644
--- a/doc/tipidee.conf.html
+++ b/doc/tipidee.conf.html
@@ -302,6 +302,37 @@ a directive can protect dynamically managed content that is restricted
to a given hierarchy. </li>
</ul>
+<div id="XXX_no_translate">
+<h4> <tt>XXX_no_translate</tt> </h4>
+</div>
+
+<p>
+ <code> global XXX_no_translate <em>value</em> </code>
+</p>
+
+<ul>
+ <li> This directive is dangerous and significantly changes the behaviour of tipideed,
+which is why it is marked with the <tt>XXX_</tt> prefix. If you are not 100% certain
+that you need it, do not use it. </li>
+ <li> <em>value</em> is a non-negative integer. If it is nonzero, then:
+ <ul>
+ <li> Symbolic links are <em>not resolved</em> when tipidee looks for resources
+or error pages. This means that host names and resource paths will be looked up
+in the configuration database as they are given by the client, not as they appear
+in the filesystem. </li>
+ <ul>
+ <li> In particular, a same resource could have different attributes depending on how
+it is accessed: it could be seen as a CGI script from one URI and as a regular file from
+another. </li>
+ <li> This also means that if your configuration file needs local directives, you must
+specify them for every host/port combination your server is listening on. </li>
+ </ul> </li>
+ <li> If tipideed is not chrooted, symbolic links <em>may</em> point outside of the
+server root: this will not be checked. This allows you to serve data from other parts
+of the filesystem. </li>
+ </ul> </li>
+</ul>
+
<div id="index-file">
<h3> The <tt>index-file</tt> directive </h3>
</div>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 74f7594..f2a6880 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,16 @@
<h1> What has changed in tipidee </h1>
+<h2> in.0.0.3.0 </h2>
+
+<ul>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
+dependency bumped to 2.14.1.0 </li>
+ <li> <a href="//skarnet.org/software/s6-networking/">s6-networking</a>
+recommendation bumped to 2.7.0.1 </li>
+ <li> New <tt>global XXX_no_translate</tt> configuration directive. </li>
+</ul>
+
<h2> in.0.0.2.0 </h2>
<ul>