~zethra/stargazer

91f45b21a060f7b5902b61125f4f0ff859afe17d — Ben Aaron Goldberg 2 months ago a57881f
docs: make requirement of routes clearer in docs

Signed-off-by: Ben Aaron Goldberg <ben@benaaron.dev>
3 files changed, 48 insertions(+), 9 deletions(-)

M doc/stargazer-ini.scd
M doc/stargazer.1.txt
M doc/stargazer.ini.5.txt
M doc/stargazer-ini.scd => doc/stargazer-ini.scd +22 -2
@@ 4,12 4,31 @@ stargazer.ini(5)

*stargazer.ini* - configuration file for *stargazer*(1)

# EXAMPLE CONFIG

```
listen = 0.0.0.0

[:tls]
store = /var/lib/gemini/certs
organiztion = example org

[example.com]
root = /srv/gemini/example.com

[example.com~(.*)\.cgi(.*)]
root = /srv/gemini/example.com/cgi-bin
cgi = on
```

An example config file should also be installed at
*/usr/share/stargazer/config.ini*

# SYNTAX

*stargazer.ini* is an INI file. Each line is either a key/value pair, or a
section heading. Key/value pairs are specified as key=value, and sections as
\[section].  Extra white space in generally ignored.
\[section]. Extra white space in generally ignored.

# CONFIGURATION KEYS



@@ 17,7 36,8 @@ The meaning of the key depends on the section. Anonymous keys (prior to the
first [section] directive) are used to specify parameters for the daemon itself.
Sections whose name is prefixed with ":", e.g. [:tls], are sub-categories of
the daemon configuration. Otherwise, section names refer to the hostnames of
domains serviced by the *stargazer* daemon.
domains serviced by the *stargazer* daemon. Each of these sections is a route
that *stargazer* will server requests to. At least one route must be specified.

## ANONYMOUS KEYS


M doc/stargazer.1.txt => doc/stargazer.1.txt +1 -1
@@ 34,4 34,4 @@ AUTHORS
       bugs/patches can be submitted by email to
       ~zethra/stargazer@lists.sr.ht.

			      2021-06-09		  stargazer(1)
			      2021-07-06		  stargazer(1)

M doc/stargazer.ini.5.txt => doc/stargazer.ini.5.txt +25 -6
@@ 3,11 3,28 @@ stargazer.ini(5)	  File Formats Manual	      stargazer.ini(5)
NAME
       stargazer.ini - configuration file for stargazer(1)

EXAMPLE CONFIG
	   listen = 0.0.0.0

	   [:tls]
	   store = /var/lib/gemini/certs
	   organiztion = example org

	   [example.com]
	   root = /srv/gemini/example.com

	   [example.com~(.*).cgi(.*)]
	   root = /srv/gemini/example.com/cgi-bin
	   cgi = on

       An example config file should also be installed at
       /usr/share/stargazer/config.ini

SYNTAX
       stargazer.ini is an INI file. Each line is either a key/value
       pair, or a section heading. Key/value pairs are specified as
       key=value, and sections as [section].  Extra white space in
       generally ignored.
       key=value, and sections as [section]. Extra white space in gen‐
       erally ignored.

CONFIGURATION KEYS
       The meaning of the key depends on the section. Anonymous keys


@@ 15,7 32,9 @@ CONFIGURATION KEYS
       parameters for the daemon itself. Sections whose name is pre‐
       fixed with ":", e.g. [:tls], are sub-categories of the daemon
       configuration. Otherwise, section names refer to the hostnames
       of domains serviced by the stargazer daemon.
       of domains serviced by the stargazer daemon. Each of these sec‐
       tions is a route that stargazer will server requests to. At
       least one route must be specified.

   ANONYMOUS KEYS
       listen


@@ 134,8 153,8 @@ CONFIGURATION KEYS
       auto-index
	   "on" to enable the auto-index feature, which presents
	   clients with a list of files in the requested directory
	   when an index file cannot be found. Off by default. Mutu‐
	   ally exclusive with cgi.
	   when an index file cannot be found. Off by default. Only
	   availible for static file routes.

       lang
	   Set this value as the lang parameter for gemini files


@@ 331,4 350,4 @@ AUTHORS
       bugs/patches can be submitted by email to
       ~zethra/stargazer@lists.sr.ht.

			      2021-06-09	      stargazer.ini(5)
			      2021-07-06	      stargazer.ini(5)