readme: Add example servers

Accessible at:

=> gemini://hedy.tilde.cafe/spsrv/
=> spartan://hedy.tilde.cafe:3333/spsrv/

README.gmi

@@ -0,0 +1,180 @@
+# spsrv
+
+A static spartan server with many features:
+
+* folder redirects
+* /~user directories
+* directory listing
+* CONF or TOML config file
+* CGI
+
+Table of Contents
+
+=> #install install
+=> #configuration configuation
+=> #cli CLI
+=> #cgi CGI
+=> #todo todo
+
+Known servers running spsrv
+=> spartan://hedy.tilde.cafe:3333
+=> spartan://tilde.team
+=> spartan://tilde.cafe
+
+
+## install
+
+you have two options for now:
+
+### Option 1: with go get
+
+first, you need to have go installed and have a folder ~/go with $GOPATH pointing to it.
+
+```
+go get git.sr.ht/~hedy/spsrv
+```
+
+there will be a binary at ~/go/bin/ with the source code at ~/go/src/
+
+feel free to move the binary somewhere else like /usr/sbin/
+
+### Option 2: just build it yourself
+
+run git clone https://git.sr.ht/~hedy/spsrv from any directory and cd spsrv
+
+make sure you have go installed and working.
+
+```
+git checkout v0.0.0  # optionally pin a specific tag
+go build
+```
+
+when it finishes, the binary will be in the current directory.
+
+### otherwise...
+
+If you don't have/want go installed, you can contact me, and if you're lucky, I have the same OS as you and you can use my compiled binary (lol). I'll eventually have automated uploads of binaries for various architectures for each release in the future.
+
+## configuration
+
+The default config file location is /etc/spsrv.conf you can specify your own path by running spsrv like
+
+```
+spsrv -c /path/to/file.conf
+```
+
+You don't need a config file to have spsrv running, it will just use the default values.
+
+config options:
+
+Note that the options are case insensitive.
+
+Here are the config options and their default values
+
+### general
+
+port=300: port to listen to
+
+hostname="localhost": if this is set, any request that for hostnames other than this value would be rejected
+
+rootdir="/var/spartan": folder for fetching files
+
+### directory listing
+
+dirlistEnable=true: enable directory listing for folders that does not have index.gmi
+
+dirlistReverse=false: reverse the order of which files are listed
+
+dirlistSort="name": how files are sorted, only "name", "size", and "time" are accepted. Defaults to "name" if an unknown option is encountered
+
+dirlistTitles=true: if true, directory listing will use first top level header in *.gmi files instead of the filename
+
+### ~user/ directories
+
+userdirEnable=true: enable serving /~user/* requests
+
+userdir="public_spartan": root directory for users. This should not have trailing slashes, and it is relative to /home/user/
+
+userSubdomains=false: User vhosts. Whether to allow user.host.name/foo.txt being the same as host.name/~user/foo.txt (When hostname="host.name"). NOTE: This only works when hostname option is set.
+
+### CGI
+
+CGIPaths=["cgi/"]: list of paths where world-executable files will be run as CGI processes. These paths would be checked if it prefix the requested path. For the default value, a request of /cgi/hi.sh (requesting to ./public/cgi/hi.sh, for example) will run hi.sh script if it's world executable.
+
+usercgiEnable=false: enable running user's CGI scripts too. This is dangerous as spsrv does not (yet) change the Uid of the CGI process, hence the process would be ran by the same user that is running the server, which could mean write access to configuration files, etc. Note that this option will be assumed false if userdirEnable is set to false. Which means if user directories are not enabled, there will be no per-user CGI.
+
+Check out some example configuraton in the examples/ directory.
+
+=> https://tildegit.org/hedy/spsrv/src/branch/main/examples/ examples/
+
+## CLI
+
+You can override values in config file if you supply them from the command line:
+
+```
+Usage: spsrv [ [ -c <path> -h <hostname> -p <port> -d <path> ] | --help ]
+
+    -c, --config string     Path to config file
+    -d, --dir string        Root content directory
+    -h, --hostname string   Hostname
+    -p, --port int          Port to listen to
+```
+
+Note that you cannot set the hostname or the dir path to , because spsrv uses that to check whether you provided an option. You can't set port to 0 either, sorry, this limitation comes with the advantage of being able to override config values from the command line.
+
+There are no arguments wanted when running spsrv, only options as listed above :)
+
+## CGI
+
+The following environment values are set for CGI scripts:
+
+```
+GATEWAY_INTERFACE # CGI/1.1
+REMOTE_ADDR      # Remote address
+SCRIPT_PATH      # (Relative) path of the CGI script
+SERVER_SOFTWARE  # SPSRV
+SERVER_PROTOCOL  # SPARTAN
+REQUEST_METHOD   # Set to nothing
+SERVER_PORT      # Port
+SERVER_NAME      # Hostname
+DATA_LENGTH      # Input data length
+```
+
+The data block, if any, will be piped as stdin to the CGI process.
+
+Keep in mind that CGI scripts (as of now) are run by the same user as the server process, hence it is generally dangerous for allowing users to have their own CGI scripts. See configuration section for more details.
+
+Check out some example CGI scripts in the examples/ directory.
+
+=> https://tildegit.org/hedy/spsrv/src/branch/main/examples/ examples/
+
+
+## todo
+
+```todo list
+* [x] /folder to /folder/ redirects
+* [x] directory listing
+* [ ] logging to files
+* [x] ~user directories
+* [x] refactor working dir part
+* [x] config
+  * [ ] status meta
+  * [x] user homedir
+  * [x] hostname, port
+  * [x] public dir
+  * [x] dirlist title
+  * [x] user vhost
+  * [ ] userdir slug
+  * [ ] redirects
+* [x] CGI
+  * [x] pipe data block
+  * [ ] user cgi config and change uid to user
+  * [ ] regex in cgi paths
+* [ ] SCGI
+* [ ] Multiple servers with each of their own confs
+
+README:
+* [ ] Add example confs
+* [ ] Add example .service files
+```
+

README.md

@@ -8,6 +8,11 @@ A static spartan server with many features:
 * CONF or TOML config file
 * CGI
 
+Known servers running spsrv:
+* [hedy.tilde.cafe:3333](https://portal.mozz.us/spartan/hedy.tilde.cafe:3333)
+* [tilde.team](https://portal.mozz.us/spartan/tilde.team)
+* [tilde.cafe](https://portal.mozz.us/spartan/tilde.cafe)
+
 <!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
 **Table of Contents**
 
@@ -27,8 +32,10 @@ A static spartan server with many features:
 
 you have two options for now:
 
-### with `go get`
-first, you need to have go installed and have a folder `~/go` with `$GOPATH` pointing to it.
+### Option 1: with `go get`
+
+first, you need to have go installed and have a folder `~/go` with `$GOPATH`
+pointing to it.
 
 ```
 go get git.sr.ht/~hedy/spsrv
@@ -38,30 +45,40 @@ there will be a binary at `~/go/bin/` with the source code at `~/go/src/`
 
 feel free to move the binary somewhere else like `/usr/sbin/`
 
-### or just build it yourself
+
+### Option 2: just build it yourself
+
 run `git clone https://git.sr.ht/~hedy/spsrv` from any directory and `cd spsrv`
 
 make sure you have go installed and working.
 
 ```
+git checkout v0.0.0  # optionally pin a specific tag
 go build
 ```
 
 when it finishes, the binary will be in the current directory.
 
+
 ### otherwise...
 
-If you don't have/want go installed, you can contact me, and if you're lucky, I have the same OS as you and you can use my compiled binary (lol). I'll eventually have automated uploads of binaries for various architectures for each release in the future.
+If you don't have/want go installed, you can contact me, and if you're lucky, I
+have the same OS as you and you can use my compiled binary (lol). I'll
+eventually have automated uploads of binaries for various architectures for
+each release in the future.
 
 
 ## configuration
+
 The default config file location is `/etc/spsrv.conf` you can specify your own path by running spsrv like
 
 ```
 spsrv -c /path/to/file.conf
 ```
 
-You don't need a config file to have spsrv running, it will just use the default values.
+You don't need a config file to have spsrv running, it will just use the
+default values.
+
 
 ### config options
 
@@ -93,6 +110,8 @@ Here are the config options and their default values
 * `CGIPaths=["cgi/"]`: list of paths where world-executable files will be run as CGI processes. These paths would be checked if it prefix the requested path. For the default value, a request of `/cgi/hi.sh` (requesting to `./public/cgi/hi.sh`, for example) will run `hi.sh` script if it's world executable.
 * `usercgiEnable=false`: enable running user's CGI scripts too. This is dangerous as spsrv does not (yet) change the Uid of the CGI process, hence the process would be ran by the same user that is running the server, which could mean write access to configuration files, etc. Note that this option will be assumed `false` if `userdirEnable` is set to `false`. Which means if user directories are not enabled, there will be no per-user CGI.
 
+Check out some example configuraton in the [examples/](examples/) directory.
+
 ## CLI
 
 You can override values in config file if you supply them from the command line:
@@ -106,7 +125,10 @@ Usage: spsrv [ [ -c <path> -h <hostname> -p <port> -d <path> ] | --help ]
     -p, --port int          Port to listen to
 ```
 
-Note that you *cannot* set the hostname or the dir path to `,` because spsrv uses that to check whether you provided an option. You can't set port to `0` either, sorry, this limitation comes with the advantage of being able to override config values from the command line.
+Note that you *cannot* set the hostname or the dir path to `,` because spsrv
+uses that to check whether you provided an option. You can't set port to `0`
+either, sorry, this limitation comes with the advantage of being able to
+override config values from the command line.
 
 There are no arguments wanted when running spsrv, only options as listed above :)
 
@@ -128,12 +150,15 @@ DATA_LENGTH      # Input data length
 
 The data block, if any, will be piped as stdin to the CGI process.
 
-Keep in mind that CGI scripts (as of now) are run by the same user as the server process, hence it is generally dangerous for allowing users to have their own CGI scripts. See configuration section for more details.
+Keep in mind that CGI scripts (as of now) are run by the same user as the
+server process, hence it is generally dangerous for allowing users to have
+their own CGI scripts. See configuration section for more details.
+
+Check out some example CGI scripts in the [examples/](examples/) directory.
 
 
 ## todo
 
-```
 - [x] /folder to /folder/ redirects
 - [x] directory listing
 - [ ] logging to files
@@ -159,4 +184,3 @@ Keep in mind that CGI scripts (as of now) are run by the same user as the server
 README:
 - [ ] Add example confs
 - [ ] Add example .service files
-```

examples/cgi/echo

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+
+# Echos back whatever data you send it
+
+printf "2 application/octet-stream\r\n"
+cat /dev/stdin

examples/cgi/env.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+printf "2 text/gemini\r\n"
+whoami
+printenv

examples/cgi/greet.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env sh
+
+# User can enter their name and this will greet them
+# Example inpu link:
+#
+# =: greet.sh Enter your name
+
+printf "2 text/plain\r\n"
+name=$(cat /dev/stdin)
+echo "Hello, ${name:-World}!"

examples/config_local.conf

@@ -0,0 +1,13 @@
+# Example config for a local testing server
+
+hostname="localhost"
+port=3000
+
+rootDir = "./public"
+
+# attempt CGI for all requests
+cgiPaths=[""]
+
+dirlistEnable=true
+dirlistSort="time"
+dirlistTitles=true

examples/config_pubnix.conf

@@ -0,0 +1,19 @@
+# Example config for a multi-user unix server
+
+# accept any hostname
+hostname=""
+port=300
+rootdir="/var/spartan"
+
+# allow CGI for all files - so you can have your root index.gmi do a user
+# listing
+cgipaths=[""]
+
+userdirEnable=true
+# each user would have their content be at /home/user/public_spartan,
+# accessible via spartan://host.name/~user/
+userdir="public_spartan"
+
+# enable per-user CGI (you might wanna be running the spartan server under
+# another user, such as spartan:nogroup)
+usercgiEnable=true

examples/config_uservhost.conf

@@ -0,0 +1,18 @@
+# Example config for allowing per-user vhosts on your pubnix, i.e.: allownig
+# spartan://user.example.org
+
+# you must set a non-empty hostname for user-vhost to work
+hostname="example.org"
+port=300
+
+userdirEnable=true
+
+# each user would have their content be at /home/user/public_spartan,
+# accessible via both spartan://example.org/~user/ and
+# spartan://user.example.org/
+userdir="public_spartan"
+userSubdomains=true
+
+# enable per-user CGI (you might wanna be running the spartan server under
+# another user, such as spartan:nogroup)
+usercgiEnable=true

examples/spsrv.debian.service

@@ -0,0 +1,15 @@
+[Unit]
+Description=spsrv
+After=network.target
+
+[Service]
+Type=simple
+Restart=always
+RestartSec=5
+User=spartan
+Group=spartan
+ExecStart=/usr/local/bin/spsrv -c /etc/spsrv.conf
+
+[Install]
+WantedBy=multi-user.target
+