aboutsummaryrefslogtreecommitdiff
path: root/gmid/README
diff options
context:
space:
mode:
Diffstat (limited to 'gmid/README')
-rw-r--r--gmid/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/gmid/README b/gmid/README
new file mode 100644
index 0000000..cbd4fdc
--- /dev/null
+++ b/gmid/README
@@ -0,0 +1,19 @@
+gmid is a server for the Gemini protocol. It has various features, among which
+Capsicum support and a "config-less" mode akin to "python -m http.server" to
+quickly serve local directories from the shell.
+
+This setup differs from the project's standard by avoiding to run the service
+as root. It comes at the cost of not supporting 'chroot'.
+
+To have the gmid daemon start and stop with your host,
+add to /etc/rc.d/rc.local:
+
+ if [ -x /etc/rc.d/rc.gmid ]; then
+ /etc/rc.d/rc.gmid start
+ fi
+
+and to /etc/rc.d/rc.local_shutdown (creating it if needed):
+
+ if [ -x /etc/rc.d/rc.gmid ]; then
+ /etc/rc.d/rc.gmid stop
+ fi