diff options
| author | sternenseemann <sternenseemann@systemli.org> | 2021-11-29 11:56:51 +0000 |
|---|---|---|
| committer | sternenseemann <sternenseemann@systemli.org> | 2021-11-29 11:56:51 +0000 |
| commit | 46067a430ee41e30adb0444288a0fcf5c2c6d962 (patch) | |
| tree | 1d58e869b827842b38857ba3d385dad00ab2d0b4 | |
| parent | ca698015a5202f156eff89855be079ee800430d0 (diff) | |
Deploying to gh-pages from @ sternenseemann/spacecookie@82d4aa4b6c5aaf62473fed4235ec7151e5581904 🚀
| -rw-r--r-- | spacecookie.1.html | 90 | ||||
| -rw-r--r-- | spacecookie.gophermap.5.html | 79 | ||||
| -rw-r--r-- | spacecookie.json.5.html | 119 |
3 files changed, 146 insertions, 142 deletions
diff --git a/spacecookie.1.html b/spacecookie.1.html index 44cfdf5..982bc73 100644 --- a/spacecookie.1.html +++ b/spacecookie.1.html @@ -2,6 +2,7 @@ <html> <head> <meta charset="utf-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> <link rel="stylesheet" href="style.css" type="text/css" media="all"/> <title>SPACECOOKIE(1)</title> </head> @@ -16,8 +17,8 @@ <div class="manual-text"> <section class="Sh"> <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<code class="Nm">spacecookie</code> — -<div class="Nd">gopher server daemon</div> +<p class="Pp"><code class="Nm">spacecookie</code> — + <span class="Nd">gopher server daemon</span></p> </section> <section class="Sh"> <h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> @@ -31,15 +32,15 @@ </section> <section class="Sh"> <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<code class="Nm">spacecookie</code> is a simple to use gopher daemon for serving - static files. It is either invoked with the <code class="Fl">--version</code> - flag to print its version or with the path to its config file as the single - argument. The minimal config file needs to tell - <code class="Nm">spacecookie</code> about the directory to serve and the - server's name, i. e. the hostname or IP address the server is reachable - through. All configuration options, the format and default values are - explained in - <a class="Xr" href="./spacecookie.json.5.html">spacecookie.json(5)</a>. +<p class="Pp"><code class="Nm">spacecookie</code> is a simple to use gopher + daemon for serving static files. It is either invoked with the + <code class="Fl">--version</code> flag to print its version or with the path + to its config file as the single argument. The minimal config file needs to + tell <code class="Nm">spacecookie</code> about the directory to serve and + the server's name, i. e. the hostname or IP address the server is reachable + through. All configuration options, the format and default values are + explained in + <a class="Xr" href="./spacecookie.json.5.html">spacecookie.json(5)</a>.</p> <p class="Pp">On startup, <code class="Nm">spacecookie</code> will check if it has been started with systemd socket activation. If that's true, it will use the socket passed from systemd, if not, it will setup the socket itself. @@ -50,9 +51,10 @@ activation eliminates the need for starting as a privileged user in the first place because systemd will take care of the socket. The systemd integration is explained in more detail in its own section.</p> -<p class="Pp"><code class="Nm">spacecookie</code> will not fork itself to the - background or otherwise daemonize which can, however, be achieved using a - supervisor. Logs are always written to <b class="Sy">stderr</b> and can be +<p class="Pp" id="stderr"><code class="Nm">spacecookie</code> will not fork + itself to the background or otherwise daemonize which can, however, be + achieved using a supervisor. Logs are always written to + <a class="permalink" href="#stderr"><b class="Sy">stderr</b></a> and can be collected and rotated by another daemon or tool if desired.</p> <p class="Pp">Incoming requests are filtered: No files or directories outside the served directory or that start with a dot may be accessed by clients. @@ -70,9 +72,10 @@ <section class="Sh"> <h1 class="Sh" id="SYSTEMD_INTEGRATION"><a class="permalink" href="#SYSTEMD_INTEGRATION">SYSTEMD INTEGRATION</a></h1> -<code class="Nm">spacecookie</code> optionally supports two systemd-specific - features: It acts as a <b class="Sy">notify</b> type service and supports - socket activation. +<p class="Pp"><code class="Nm">spacecookie</code> optionally supports two + systemd-specific features: It acts as a + <a class="permalink" href="#notify"><b class="Sy" id="notify">notify</b></a> + type service and supports socket activation.</p> <p class="Pp">If you are writing a <a class="Xr" href="https://manpages.debian.org/unstable/systemd.service.5.en.html">systemd.service(5)</a> file, be sure to use the ‘<code class="Li">Type=notify</code>’ @@ -100,8 +103,10 @@ <a class="Xr" href="https://manpages.debian.org/unstable/systemd.socket.5.en.html">systemd.socket(5)</a>. To listen on an IPv4 address only, you can use an IPv6 socket with a mapped IPv4 address.</li> - <li>As always the <b class="Sy">hostname</b> setting must match the public - address or hostname the socket is listening on.</li> + <li id="hostname">As always the + <a class="permalink" href="#hostname"><b class="Sy">hostname</b></a> + setting must match the public address or hostname the socket is listening + on.</li> </ul> <p class="Pp">Make sure to check your socket configuration settings carefully since <code class="Nm">spacecookie</code> doesn't run any sanity checks on @@ -119,11 +124,11 @@ <section class="Sh"> <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE ALSO</a></h1> -<a class="Xr" href="./spacecookie.json.5.html">spacecookie.json(5)</a>, - <a class="Xr" href="./spacecookie.gophermap.5.html">spacecookie.gophermap(5)</a>, - <a class="Xr" href="https://manpages.debian.org/unstable/systemd.service.5.en.html">systemd.service(5)</a> - and - <a class="Xr" href="https://manpages.debian.org/unstable/systemd.socket.5.en.html">systemd.socket(5)</a>. +<p class="Pp"><a class="Xr" href="./spacecookie.json.5.html">spacecookie.json(5)</a>, + <a class="Xr" href="./spacecookie.gophermap.5.html">spacecookie.gophermap(5)</a>, + <a class="Xr" href="https://manpages.debian.org/unstable/systemd.service.5.en.html">systemd.service(5)</a> + and + <a class="Xr" href="https://manpages.debian.org/unstable/systemd.socket.5.en.html">systemd.socket(5)</a>.</p> <p class="Pp">For writing custom gopher application using the spacecookie library refer to the <a class="Lk" href="https://hackage.haskell.org/package/spacecookie">API @@ -131,30 +136,31 @@ </section> <section class="Sh"> <h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1> -By default, <code class="Nm">spacecookie</code> always behaves like a gopher - server as described in - <a class="Lk" href="https://tools.ietf.org/html/rfc1436">RFC1436</a>. However - users can configure <code class="Nm">spacecookie</code> to utilize common - protocol extensions like the ‘<code class="Li">h</code>’ and - ‘<code class="Li">i</code>’ types and - <a class="Lk" href="http://gopher.quux.org:70/Archives/Mailing%20Lists/gopher/gopher.2002-02%7C/MBOX-MESSAGE/34">URLs - to other protocols</a>. +<p class="Pp">By default, <code class="Nm">spacecookie</code> always behaves + like a gopher server as described in + <a class="Lk" href="https://tools.ietf.org/html/rfc1436">RFC1436</a>. + However users can configure <code class="Nm">spacecookie</code> to utilize + common protocol extensions like the + ‘<code class="Li">h</code>’ and + ‘<code class="Li">i</code>’ types and + <a class="Lk" href="http://gopher.quux.org:70/Archives/Mailing%20Lists/gopher/gopher.2002-02%7C/MBOX-MESSAGE/34">URLs + to other protocols</a>.</p> </section> <section class="Sh"> <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> -<code class="Nm">spacecookie</code> has been written and documented by - <span class="An">sternenseemann</span>, - <a class="Mt" href="mailto:sterni-spacecookie@systemli.org">sterni-spacecookie@systemli.org</a>. +<p class="Pp"><code class="Nm">spacecookie</code> has been written and + documented by <span class="An">sternenseemann</span>, + <a class="Mt" href="mailto:sterni-spacecookie@systemli.org">sterni-spacecookie@systemli.org</a>.</p> </section> <section class="Sh"> <h1 class="Sh" id="SECURITY_CONSIDERATIONS"><a class="permalink" href="#SECURITY_CONSIDERATIONS">SECURITY CONSIDERATIONS</a></h1> -<code class="Nm">spacecookie</code> supports no migitations or attack surface - reduction measures other than automatically switching to a less privileged - user after binding. It is recommended to use this feature and to make use of - containering or sandboxing like for example - <a class="Xr" href="https://manpages.debian.org/unstable/systemd.exec.5.en.html">systemd.exec(5)</a> - supports. +<p class="Pp"><code class="Nm">spacecookie</code> supports no migitations or + attack surface reduction measures other than automatically switching to a + less privileged user after binding. It is recommended to use this feature + and to make use of containering or sandboxing like for example + <a class="Xr" href="https://manpages.debian.org/unstable/systemd.exec.5.en.html">systemd.exec(5)</a> + supports.</p> <p class="Pp">TLS-enabled gopher, like the ‘<code class="Li">gophers</code>’ protocol supported by <a class="Xr" href="https://manpages.debian.org/unstable/curl.1.en.html">curl(1)</a> @@ -164,7 +170,7 @@ By default, <code class="Nm">spacecookie</code> always behaves like a gopher </div> <table class="foot"> <tr> - <td class="foot-date">September 19, 2021</td> + <td class="foot-date">November 29, 2021</td> <td class="foot-os">NixOS</td> </tr> </table> diff --git a/spacecookie.gophermap.5.html b/spacecookie.gophermap.5.html index 103b9b1..602ecb2 100644 --- a/spacecookie.gophermap.5.html +++ b/spacecookie.gophermap.5.html @@ -2,6 +2,7 @@ <html> <head> <meta charset="utf-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> <link rel="stylesheet" href="style.css" type="text/css" media="all"/> <title>SPACECOOKIE.GOPHERMAP(5)</title> </head> @@ -16,18 +17,18 @@ <div class="manual-text"> <section class="Sh"> <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<code class="Nm">spacecookie.gophermap</code> — -<div class="Nd">gophermap file format supported by - <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a></div> +<p class="Pp"><code class="Nm">spacecookie.gophermap</code> — + <span class="Nd">gophermap file format supported by + <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a></span></p> </section> <section class="Sh"> <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -A gophermap file allows to describe a gopher menu without the need to include - redundant information. The format supported by - <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> has originally - been introduced by Bucktooth and is supported by most popular gopher server - daemons like for example - <a class="Xr" href="https://manpages.debian.org/unstable/pygopherd.8.en.html">pygopherd(8)</a>. +<p class="Pp">A gophermap file allows to describe a gopher menu without the need + to include redundant information. The format supported by + <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> has originally + been introduced by Bucktooth and is supported by most popular gopher server + daemons like for example + <a class="Xr" href="https://manpages.debian.org/unstable/pygopherd.8.en.html">pygopherd(8)</a>.</p> <p class="Pp">A gophermap file stored as ‘<code class="Li">.gophermap</code>’ in a directory under the gopher root of <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> @@ -38,11 +39,13 @@ A gophermap file allows to describe a gopher menu without the need to include </section> <section class="Sh"> <h1 class="Sh" id="FORMAT"><a class="permalink" href="#FORMAT">FORMAT</a></h1> -The format is plain text and line based. Both Unix and DOS style line endings - are allowed. <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> - distinguishes between two types of lines: +<p class="Pp">The format is plain text and line based. Both Unix and DOS style + line endings are allowed. + <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> distinguishes + between two types of lines:</p> <dl class="Bl-tag"> - <dt><b class="Sy">info lines</b></dt> + <dt id="info"><a class="permalink" href="#info"><b class="Sy">info + lines</b></a></dt> <dd>Info lines are lines of text in a gophermap which don't have any special format requirements except that they may not contain any tab characters. <p class="Pp"></p> @@ -55,20 +58,19 @@ The format is plain text and line based. Both Unix and DOS style line endings <p class="Pp">The usual purpose is to display additional text, headings and decorative elements which are not directly related to other resources served via gopher:</p> - <div class="Bd Pp Bd-indent"> - <pre> -+------------------------------+ + <div class="Bd Pp Bd-indent Li"> + <pre>+------------------------------+ | Welcome to my Gopher Server! | +------------------------------+ Below you can find a collection of files I deemed -interesting or useful enough to publish them. - </pre> +interesting or useful enough to publish them.</pre> </div> <p class="Pp">Empty lines are interpreted as info lines which have no content.</p> </dd> - <dt><b class="Sy">menu entries</b></dt> + <dt id="menu"><a class="permalink" href="#menu"><b class="Sy">menu + entries</b></a></dt> <dd>Lines describing menu entries are of the following form. All spaces are for readability only and must not be present in the actual format. Everything in brackets may be omitted, the semantics of which are @@ -77,7 +79,7 @@ interesting or useful enough to publish them. <div class="Bd Bd-indent"><code class="Li">gopherfiletypeNAME\t [SELECTOR [\tSERVER [\tPORT]]]</code></div> <dl class="Bl-tag"> - <dt><i class="Em">gopherfiletype</i></dt> + <dt id="gopherfiletype"><a class="permalink" href="#gopherfiletype"><i class="Em">gopherfiletype</i></a></dt> <dd>File type character indicating the file type of the linked resource to the client. See <a class="Lk" href="https://tools.ietf.org/html/rfc1436#page-14">RFC1436</a> @@ -86,11 +88,11 @@ interesting or useful enough to publish them. ‘<code class="Li">i</code>’ which indicates an info line and ‘<code class="Li">h</code>’ which indicates an HTML document.</dd> - <dt><i class="Em">NAME</i></dt> + <dt id="NAME~2"><a class="permalink" href="#NAME~2"><i class="Em">NAME</i></a></dt> <dd>Name of the linked resource which will show up as the text of the menu entry. May contain any characters except newlines and tabs. <i class="Em">NAME</i> must always be terminated by a tab.</dd> - <dt><i class="Em">SELECTOR</i></dt> + <dt id="SELECTOR"><a class="permalink" href="#SELECTOR"><i class="Em">SELECTOR</i></a></dt> <dd>Gopher selector the entry should link to. Same restrictions in terms of characters apply as for <i class="Em">NAME</i>, but there should only be a tab character afterwards if another field is specified. If @@ -109,12 +111,12 @@ interesting or useful enough to publish them. <a class="Lk" href="http://gopher.quux.org:70/Archives/Mailing%20Lists/gopher/gopher.2002-02%7C/MBOX-MESSAGE/34">this email from John Goerzen.</a></p> </dd> - <dt><i class="Em">SERVER</i></dt> + <dt id="SERVER"><a class="permalink" href="#SERVER"><i class="Em">SERVER</i></a></dt> <dd>Describes the server <i class="Em">SELECTOR</i> should be retrieved from. Same character restrictions apply and it must come after a tab character as well. If it is omitted, the hostname of the server generating the menu is used.</dd> - <dt><i class="Em">PORT</i></dt> + <dt id="PORT"><a class="permalink" href="#PORT"><i class="Em">PORT</i></a></dt> <dd>Describes the port <i class="Em">SERVER</i> is running on. Must come after a tab and is terminated by the end of the line or file. If this field is left out, the server generating the menu uses its own @@ -128,10 +130,10 @@ interesting or useful enough to publish them. </section> <section class="Sh"> <h1 class="Sh" id="EXAMPLE"><a class="permalink" href="#EXAMPLE">EXAMPLE</a></h1> -Tabs are marked with ‘<code class="Li">^I</code>’ for clarity. -<div class="Bd Pp Bd-indent"> -<pre> -spacecookie +<p class="Pp">Tabs are marked with ‘<code class="Li">^I</code>’ + for clarity.</p> +<div class="Bd Pp Bd-indent Li"> +<pre>spacecookie =========== Welcome to spacecookie's gopher page! @@ -151,31 +153,30 @@ Other gopher server daemons (the first link only works if this server is running on port 70): 1pygopherd^I /devel/gopher/pygopherd^I gopher.quux.org -1Bucktooth^I /buck^I gopher.floodgap.com^I 70 -</pre> +1Bucktooth^I /buck^I gopher.floodgap.com^I 70</pre> </div> </section> <section class="Sh"> <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE ALSO</a></h1> -<a class="Xr" href="https://manpages.debian.org/unstable/pygopherd.8.en.html">pygopherd(8)</a>, - <a class="Lk" href="gopher://gopher.floodgap.com/0/buck/dbrowse?faquse%201a">Bucktooth's - gophermap documentation</a> and - <a class="Lk" href="https://tools.ietf.org/html/rfc1436#page-14">the file type - list from RFC1436</a>. +<p class="Pp"><a class="Xr" href="https://manpages.debian.org/unstable/pygopherd.8.en.html">pygopherd(8)</a>, + <a class="Lk" href="gopher://gopher.floodgap.com/0/buck/dbrowse?faquse%201a">Bucktooth's + gophermap documentation</a> and + <a class="Lk" href="https://tools.ietf.org/html/rfc1436#page-14">the file + type list from RFC1436</a>.</p> <p class="Pp"><a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a>, <a class="Xr" href="./spacecookie.json.5.html">spacecookie.json(5)</a></p> </section> <section class="Sh"> <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> -The <code class="Nm">spacecookie.gophermap</code> documentation has been written - by <span class="An">sternenseemann</span>, - <a class="Mt" href="mailto:sterni-spacecookie@systemli.org">sterni-spacecookie@systemli.org</a>. +<p class="Pp">The <code class="Nm">spacecookie.gophermap</code> documentation + has been written by <span class="An">sternenseemann</span>, + <a class="Mt" href="mailto:sterni-spacecookie@systemli.org">sterni-spacecookie@systemli.org</a>.</p> </section> </div> <table class="foot"> <tr> - <td class="foot-date">September 19, 2021</td> + <td class="foot-date">November 29, 2021</td> <td class="foot-os">NixOS</td> </tr> </table> diff --git a/spacecookie.json.5.html b/spacecookie.json.5.html index 0cd3b90..8d6bf08 100644 --- a/spacecookie.json.5.html +++ b/spacecookie.json.5.html @@ -2,6 +2,7 @@ <html> <head> <meta charset="utf-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> <link rel="stylesheet" href="style.css" type="text/css" media="all"/> <title>SPACECOOKIE.JSON(5)</title> </head> @@ -16,23 +17,24 @@ <div class="manual-text"> <section class="Sh"> <h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<code class="Nm">spacecookie.json</code> — -<div class="Nd">configuration file for - <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a></div> +<p class="Pp"><code class="Nm">spacecookie.json</code> — + <span class="Nd">configuration file for + <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a></span></p> </section> <section class="Sh"> <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -The <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> config file is - a JSON file which contains a single object. The allowed fields representing - individual settings and their effect are explained below. +<p class="Pp">The <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> + config file is a JSON file which contains a single object. The allowed + fields representing individual settings and their effect are explained + below.</p> <section class="Ss"> <h2 class="Ss" id="REQUIRED_SETTINGS"><a class="permalink" href="#REQUIRED_SETTINGS">REQUIRED SETTINGS</a></h2> -The following settings must be part of every configuration file as there is no - default or fallback value for them. +<p class="Pp">The following settings must be part of every configuration file as + there is no default or fallback value for them.</p> <div class="Bd-indent"> <dl class="Bl-tag"> - <dt><b class="Sy">hostname</b></dt> + <dt id="hostname"><a class="permalink" href="#hostname"><b class="Sy">hostname</b></a></dt> <dd>Describes the public server name <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> is reachable through, i. e. the address clients will use to connect to it. It will be @@ -42,7 +44,7 @@ The following settings must be part of every configuration file as there is no ‘<code class="Li">localhost</code>’. <p class="Pp">Type: string.</p> </dd> - <dt><b class="Sy">root</b></dt> + <dt id="root"><a class="permalink" href="#root"><b class="Sy">root</b></a></dt> <dd>Sets the the directory <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> should serve via gopher. All gopher requests will be resolved to files or directories @@ -58,11 +60,11 @@ The following settings must be part of every configuration file as there is no <section class="Ss"> <h2 class="Ss" id="OPTIONAL_SETTINGS"><a class="permalink" href="#OPTIONAL_SETTINGS">OPTIONAL SETTINGS</a></h2> -The following settings are optional, meaning there is either a default value or - an obvious default behavior if they are not given. +<p class="Pp">The following settings are optional, meaning there is either a + default value or an obvious default behavior if they are not given.</p> <div class="Bd-indent"> <dl class="Bl-tag"> - <dt><b class="Sy">listen</b></dt> + <dt id="listen"><a class="permalink" href="#listen"><b class="Sy">listen</b></a></dt> <dd>Describes the address and port <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> should listen on. Both aspects can be controlled individually by the two optional fields @@ -70,7 +72,7 @@ The following settings are optional, meaning there is either a default value or <p class="Pp">Type: object.</p> <div class="Bd-indent"> <dl class="Bl-tag"> - <dt><b class="Sy">port</b></dt> + <dt id="port"><a class="permalink" href="#port"><b class="Sy">port</b></a></dt> <dd>Port to listen on. The well-known port for gopher is <span class="Ms">70</span>. <p class="Pp">If @@ -86,26 +88,28 @@ The following settings are optional, meaning there is either a default value or <p class="Pp">Type: number. Default: ‘<code class="Li">70</code>’.</p> </dd> - <dt><b class="Sy">addr</b></dt> + <dt id="addr"><a class="permalink" href="#addr"><b class="Sy">addr</b></a></dt> <dd>Address to listen and accept gopher requests on. In contrast to <b class="Sy">hostname</b>, this option controls the socket setup and not what is used in gopher menus. This option is especially useful to limit the addresses <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> will listen on since it listens on all available addresses for incoming - requests by default, i. e. <b class="Sy">INADDR_ANY</b>. For example, - ‘<code class="Li">::1</code>’ can be used to listen on - the link-local addresses only which comes in handy if you are setting - up a onion service using + requests by default, i. e. + <a class="permalink" href="#INADDR_ANY"><b class="Sy" id="INADDR_ANY">INADDR_ANY</b></a>. + For example, ‘<code class="Li">::1</code>’ can be used + to listen on the link-local addresses only which comes in handy if you + are setting up a onion service using <a class="Xr" href="https://manpages.debian.org/unstable/tor.1.en.html">tor(1)</a> and want to avoid leaking the server's identity. - <p class="Pp">When given, + <p class="Pp" id="IPV6_V6ONLY">When given, <a class="Xr" href="https://manpages.debian.org/unstable/getaddrinfo.3.en.html">getaddrinfo(3)</a> is used to resolve the given hostname or parse the given IP address and <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> will only listen on the resulting address(es). Note that - <b class="Sy">IPV6_V6ONLY</b> is always disabled, so, if possible, - both the resulting v4 and v6 address will be used.</p> + <a class="permalink" href="#IPV6_V6ONLY"><b class="Sy">IPV6_V6ONLY</b></a> + is always disabled, so, if possible, both the resulting v4 and v6 + address will be used.</p> <p class="Pp">If <a class="Xr" href="https://manpages.debian.org/unstable/systemd.socket.5.en.html">systemd.socket(5)</a> activation is used, this setting has no effect.</p> @@ -114,7 +118,7 @@ The following settings are optional, meaning there is either a default value or </dl> </div> </dd> - <dt><b class="Sy">user</b></dt> + <dt id="user"><a class="permalink" href="#user"><b class="Sy">user</b></a></dt> <dd>The name of the user spacecookie should run as. When this option is given and not ‘<code class="Li">null</code>’, <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> will call @@ -134,19 +138,19 @@ The following settings are optional, meaning there is either a default value or <p class="Pp">Type: string. Default: ‘<code class="Li">null</code>’.</p> </dd> - <dt><b class="Sy">log</b></dt> + <dt id="log"><a class="permalink" href="#log"><b class="Sy">log</b></a></dt> <dd>Allows to customize the logging output of <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> to - <b class="Sy">stderr</b>. + <a class="permalink" href="#stderr"><b class="Sy" id="stderr">stderr</b></a>. <p class="Pp">Type: object.</p> <div class="Bd-indent"> <dl class="Bl-tag"> - <dt><b class="Sy">enable</b></dt> + <dt id="enable"><a class="permalink" href="#enable"><b class="Sy">enable</b></a></dt> <dd>Wether to enable logging. <p class="Pp">Type: bool. Default: ‘<code class="Li">true</code>’.</p> </dd> - <dt><b class="Sy">hide-ips</b></dt> + <dt id="hide-ips"><a class="permalink" href="#hide-ips"><b class="Sy">hide-ips</b></a></dt> <dd>Wether to hide IP addresses of clients in the log output. If enabled, ‘<code class="Li">[redacted]</code>’ is displayed instead of client's IP addresses to avoid writing personal information @@ -154,7 +158,7 @@ The following settings are optional, meaning there is either a default value or <p class="Pp">Type: bool. Default: ‘<code class="Li">true</code>’.</p> </dd> - <dt><b class="Sy">hide-time</b></dt> + <dt id="hide-time"><a class="permalink" href="#hide-time"><b class="Sy">hide-time</b></a></dt> <dd>If this is set to ‘<code class="Li">true</code>’, <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> will not print timestamps at the beginning of every log line. This is useful if @@ -164,13 +168,12 @@ The following settings are optional, meaning there is either a default value or <p class="Pp">Type: bool. Default: ‘<code class="Li">false</code>’.</p> </dd> - <dt><b class="Sy">level</b></dt> + <dt id="level"><a class="permalink" href="#level"><b class="Sy">level</b></a></dt> <dd>Controls verbosity of logging. It is recommended to either use - “warn” or “info” since - “error” hides warnings that are indicative of - configuration issues. - <p class="Pp">Type: either “error”, “warn” - or “info”. Default: “info”.</p> + "warn" or "info" since "error" hides + warnings that are indicative of configuration issues. + <p class="Pp">Type: either "error", "warn" or + "info". Default: "info".</p> </dd> </dl> </div> @@ -181,12 +184,12 @@ The following settings are optional, meaning there is either a default value or <section class="Ss"> <h2 class="Ss" id="DEPRECATED_SETTINGS"><a class="permalink" href="#DEPRECATED_SETTINGS">DEPRECATED SETTINGS</a></h2> -The following settings are only supported for backwards compatibility and should - be replaced in existing configurations in the way described for each - respectively. +<p class="Pp">The following settings are only supported for backwards + compatibility and should be replaced in existing configurations in the way + described for each respectively.</p> <div class="Bd-indent"> <dl class="Bl-tag"> - <dt><b class="Sy">port</b></dt> + <dt id="port~2"><a class="permalink" href="#port~2"><b class="Sy">port</b></a></dt> <dd>The top level <b class="Sy">port</b> is an alias for the setting of the same name inside the <b class="Sy">listen</b> object and should be replaced by the latter.</dd> @@ -196,12 +199,11 @@ The following settings are only supported for backwards compatibility and should </section> <section class="Sh"> <h1 class="Sh" id="EXAMPLE"><a class="permalink" href="#EXAMPLE">EXAMPLE</a></h1> -The following configuration equates to the default behavior of - <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> for all optional - settings, although it is much verboser than necessary. -<div class="Bd Pp Bd-indent"> -<pre> -{ +<p class="Pp">The following configuration equates to the default behavior of + <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> for all + optional settings, although it is much verboser than necessary.</p> +<div class="Bd Pp Bd-indent Li"> +<pre>{ "hostname" : "localhost", "root" : "/srv/gopher", "listen" : { @@ -215,8 +217,7 @@ The following configuration equates to the default behavior of "hide-time" : false, "level" : "info" } -} -</pre> +}</pre> </div> <p class="Pp">This configuration is suitable for running as an onion service: It disables logging completely to not collect any kind of meta data about users @@ -226,9 +227,8 @@ The following configuration equates to the default behavior of allows free mapping from local to exposed ports, so <a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a> can be started as a normal user.</p> -<div class="Bd Pp Bd-indent"> -<pre> -{ +<div class="Bd Pp Bd-indent Li"> +<pre>{ "hostname": "myonionservicehash.onion", "root": "/srv/onion-gopher", "listen": { @@ -238,20 +238,17 @@ The following configuration equates to the default behavior of "log": { "enable": false } -} -</pre> +}</pre> </div> <p class="Pp">If you are not using socket activation for running a gopher server on the well-known port for gopher, a config like this is appropriate, provided the user ‘<code class="Li">gopher</code>’ exists:</p> -<div class="Bd Pp Bd-indent"> -<pre> -{ +<div class="Bd Pp Bd-indent Li"> +<pre>{ "hostname": "example.org", "root": "/srv/gopher", "user": "gopher" -} -</pre> +}</pre> </div> <p class="Pp">For a <a class="Xr" href="https://manpages.debian.org/unstable/systemd.socket.5.en.html">systemd.socket(5)</a> @@ -264,18 +261,18 @@ The following configuration equates to the default behavior of <section class="Sh"> <h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE ALSO</a></h1> -<a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a>. +<p class="Pp"><a class="Xr" href="./spacecookie.1.html">spacecookie(1)</a>.</p> </section> <section class="Sh"> <h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> -The <code class="Nm">spacecookie.json</code> documentation has been written by - <span class="An">sternenseemann</span>, - <a class="Mt" href="mailto:sterni-spacecookie@systemli.org">sterni-spacecookie@systemli.org</a>. +<p class="Pp">The <code class="Nm">spacecookie.json</code> documentation has + been written by <span class="An">sternenseemann</span>, + <a class="Mt" href="mailto:sterni-spacecookie@systemli.org">sterni-spacecookie@systemli.org</a>.</p> </section> </div> <table class="foot"> <tr> - <td class="foot-date">September 19, 2021</td> + <td class="foot-date">November 29, 2021</td> <td class="foot-os">NixOS</td> </tr> </table> |