From 166697ec1274c39641c4eb1a477de29b3991f356 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sat, 23 Sep 2023 06:19:24 +0000 Subject: Doc fixes Signed-off-by: Laurent Bercot --- doc/tipidee-config.html | 4 ++-- doc/tipideed.html | 15 +++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/tipidee-config.html b/doc/tipidee-config.html index 2ade779..c56c248 100644 --- a/doc/tipidee-config.html +++ b/doc/tipidee-config.html @@ -56,8 +56,8 @@ option to configure.)
Use textfile as input instead of /etc/tipidee.conf
-o cdbfile
Use cdbfile as output instead of /etc/tipidee.conf.cdb. -You can then use the -f cdbfile option to -tipideed.
+You can then use the -f cdbfile option to +tipideed.
-m mode
Create the output file with permissions mode (given in octal). Default is 0644. Note that the output file should be readable diff --git a/doc/tipideed.html b/doc/tipideed.html index d315086..79c055b 100644 --- a/doc/tipideed.html +++ b/doc/tipideed.html @@ -37,8 +37,8 @@ to fulfill them, sending answers to stdout, and logs to stderr.
  • tipideed only speaks plaintext HTTP. It supports HTTPS, but the TLS layer must be handled upstream by a program such as s6-tlsd.
    • -
  • tipideed stays alive until the client closes the connection or (in -HTTP 1.1) sends a request with a Connection: close header, or an error +
  • tipideed stays alive until the client closes the connection, or times out, +or (in HTTP 1.1) sends a request with a Connection: close header; or an error occurs that makes it nonsensical to keep the connection open.
  • By default, the documents it serves must be in subdirectories of its current working directory, one subdirectory for every domain it hosts.
    • @@ -91,7 +91,9 @@ of the tipidee package provides service templates to help you run tipideed under
    0
    Clean exit. There was a successful stream of HTTP exchanges, -that the client decided to end.
    +that the client decided to end — including by being inactive long enough +that tipideed closes the connection on its own initiative, which is permitted +by HTTP.
    1
    Illicit client behaviour. tipideed exited because it could not serve the client in good faith.
    2
    Illicit CGI script behaviour. tipideed exited because the invoked @@ -121,7 +123,7 @@ client before exiting.
    tipideed expects the following variables in its environment, and will exit with an error message if they are undefined. When tipideed is run under s6-tcpserver -(with s6-tcpserver-access or +(with s6-tcpserver-access) or s6-tlsserver, these variables are automatically set by the super-server. This is the way tipidee gets its network information without having to perform network @@ -373,8 +375,9 @@ backends.
  • Else, the resource is a regular ("static") file, and tipideed serves it on its stdout, to the client.
    • -
  • tipideed exits on EOF (when the client closes the connection), or after -a single HTTP/1.0 request, or when it has answered a request with a +
  • tipideed exits on EOF (when the client closes the connection), or when +the client times out before sending a request, or after tipideed receives a +single HTTP/1.0 request, or when it has answered a request with a Connection: close header, or when it encounters an error where it is likely that the client will have no use for the connection anymore anyway and exiting is simpler and cheaper — in which case tipideed adds -- cgit v1.3.1