From 9cd4e0d1902ebb196ebd53ed7ee88e6689d801b7 Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Sat, 22 Mar 2025 05:53:08 +0000
Subject:  Add cgi streaming

 WILDLY UNTESTED, don't use this commit, probably.
Also, autochunk hasn't been implemented yet.

Signed-off-by: Laurent Bercot <ska@appnovation.com>
---
 doc/index.html        |  4 ++--
 doc/tipidee.conf.html | 39 +++++++++++++++++++++++++++++++++++++++
 doc/upgrade.html      |  6 +++---
 3 files changed, 44 insertions(+), 5 deletions(-)

(limited to 'doc')

diff --git a/doc/index.html b/doc/index.html
index 47c0a55..69352ad 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -111,7 +111,7 @@ 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.3.0 or later. It's a build-time requirement. It's also a run-time
+2.14.4.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
@@ -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.5.2.tar.gz">0.0.5.2</a>. </li>
+<a href="tipidee-0.0.6.0.tar.gz">0.0.6.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 d33a05e..9906629 100644
--- a/doc/tipidee.conf.html
+++ b/doc/tipidee.conf.html
@@ -734,6 +734,45 @@ or specific file <em>file</em>, do <em>not</em> require authentication. </li>
 under <tt>basic-auth</tt> but want to carve exceptions. </li>
 </ul>
 
+<div id="autochunk">
+<h4> <tt>autochunk</tt> </h4>
+</div>
+
+<p>
+ <code> autochunk <em>directory</em> </code> <br>
+ <code> autochunk <em>file</em> </code>
+</p>
+
+<ul>
+ <li> This directive is useful if <em>file</em> is actually a resource providing
+a large amount of content without providing a <tt>Content-Length</tt>, i.e. a CGI
+script (or, in the future, some other resource) writing a stream of data to the
+client. Saying that <em>file</em>, or all resources under <em>directory</em>, is
+<tt>autochunk</tt> means that tipideed will split the streamed content into
+chunks. This is friendlier to browsers, and to the transport security layer. </li>
+ <li> The <tt>autochunk</tt> directive does nothing for regular files or other
+resources providing a <tt>Content-Length</tt>. It also does nothing when the
+client request uses HTTP/1.0, which does not support the use of
+<tt>Transfer-Encoding</tt>. </li>
+ <li> The default is <em>not</em> to autochunk content. </li>
+</ul>
+
+<div id="noautochunk">
+<h4> <tt>noautochunk</tt> </h4>
+</div>
+
+<p>
+ <code> noautochunk <em>directory</em> </code> <br>
+ <code> noautochunk <em>file</em> </code>
+</p>
+
+<ul>
+ <li> This is the opposite, saying that content streamed from resources under
+<em>directory</em>, or specific script <em>file</em>, will <em>not</em>
+be autochunked. </li>
+</ul>
+
+
 <div id="file-type">
 <h4> <tt>file-type</tt> </h4>
 </div>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 46186d6..6c7b5e0 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,13 +18,13 @@
 
 <h1> What has changed in tipidee </h1>
 
-<h2> in 0.0.5.2 </h2>
+<h2> in 0.0.6.0 </h2>
 
 <ul>
- <li> No functional changes. </li>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
+dependency bumped to 2.14.4.0 </li>
 </ul>
 
-
 <h2> in 0.0.5.1 </h2>
 
 <ul>
-- 
cgit v1.3.1