summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index ed6cd45..9a134dd 100644
--- a/README.md
+++ b/README.md
@@ -39,15 +39,24 @@ to create a release build.
Starting
--------
-Sheldon Director look for a config file in `/etc/sheldond.conf`. If you want to
-change this, pass an alternative path on startup using the `-c` parameter.
+Sheldon Director looks for a config file in `/etc/sheldond.conf`. If you want
+to change this, pass an alternative path on startup using the `-c` parameter.
Use `-h` to get a list of all supported command line arguments.
+You'll need a TLS certificate, I've chosen not to include an example in this
+repository. Use OpenSSL to quickly generate one:
+
+```sh
+openssl req -x509 -newkey rsa:4096 -keyout doc/key.pem -out doc/cert.pem -days 365 -nodes
+```
+
An example config file can be found in this repository in `doc/sheldond.conf`.
Use it to serve the content of the `doc/` directory on localhost:
-```
+
+```sh
sudo ./target/debug/sheldond -c ./doc/sheldond.conf
```
+
Try connecting to `gemini://localhost` via your favorite Gemini client!
Note: This sets the user to `nobody` and the group to `nobody` as well. This