From 1069543fd4cbc9fcdd917cf89ed953738eb4a890 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 19 Oct 2023 20:58:52 +0000 Subject: Doc fixes Signed-off-by: Laurent Bercot --- doc/tipideed.html | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/doc/tipideed.html b/doc/tipideed.html index eebdb6d..315a9ab 100644 --- a/doc/tipideed.html +++ b/doc/tipideed.html @@ -33,14 +33,14 @@ a web server package: it serves files over HTTP. @@ -90,7 +90,7 @@ of the tipidee package provides service templates to help you run tipideed under
-
0
Clean exit. There was a successful stream of HTTP exchanges, +
0
Clean exit. There was a successful series of HTTP exchanges, that either tipideed or the client decided to end in a way that is permitted by HTTP.
1
Illicit client behaviour. tipideed exited because it could @@ -107,8 +107,10 @@ error message asking you to report the bug. Please do so, on the data or in the document layout that it does not like. This can happen, for instance, when a document is a symbolic link pointing outside of the server's root.
-
111
System call failed. This usually signals a problem with the -underlying system.
+
111
System call failed. This usually signals an issue with the +the underlying operating system. Before exiting, if in the middle of processing +a request, tipideed likely has sent a 500 (Internal Server Error) response to +the client.
@@ -272,7 +274,7 @@ more flexibility. document sets for different ports. You want the same document sets for ports 80 and 443, and that's it. And you don't want to have both a domain example.com:80 section and a -domain example.com: 443 section in your +domain example.com:443 section in your /etc/tipidee.conf, with duplicate information.

@@ -342,19 +344,21 @@ with "tipideed: pid pid: ". that tipideed exits right after writing the message), or "warning: " for warnings (meaning that tipideed continues operating after writing the message). In normal operation, you should not see any fatal or warning line. -
  • In normal operation, tipidee can log informational lines, and the continuing +
  • In normal operation, tipideed can log informational lines, and the continuing prefix is "info: ". It can potentially log:
    • One line when it starts (i.e. a client has connected)
    • Up to three lines for every request:
      • One when the request is received
        • -
      • One when a suitable resource is found
        • +
      • One when a suitable resource is found. In rare cases +(namely: the resource is a CGI script answering with a local redirection), +there may be more than one resource line.
      • One when an answer is sent
    • One line when it exits normally
    • -
  • What informational lines to log is configured via the +
  • What to log is configured via the log directive in the configuration file. By default, only a minimal request line and an answer line are printed.
    • @@ -382,7 +386,7 @@ some minimal defaults it can use.
  • tipideed listens to a stream of HTTP requests on its standard input. For every HTTP request:
      -
    • It parses the request line and check it's HTTP/1.0 or 1.1
      • +
    • It parses the request line and checks it's HTTP/1.0 or 1.1
    • It parses the headers into a quick access structure
    • It checks header consistency with the request
    • If the method is OPTIONS * or TRACE, it answers here @@ -482,8 +486,8 @@ other Web servers, please share them on the (it just exits), when receiving some malformed or weirdly paced client requests, despite what the HTTP RFC says. -This is on purpose. HTTP servers are very much solicited, they can run -very hot, the Web is a cesspool of bots and bad actors, and every +This is on purpose. HTTP servers are very heavily solicited, they can run +very hot, the Web is a cesspool of badly written bots and bad actors, and every legitimate browser knows how to speak HTTP properly and without abusing corner cases in the protocol. It makes no sense to try to follow the book to the letter, expending -- cgit v1.2.3