From 84a7795be4868016f15d012b1f597f02a272f6fa Mon Sep 17 00:00:00 2001 From: Yotam Nachum Date: Fri, 22 Nov 2019 17:34:34 +0200 Subject: Add a README to explain how to use the server --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..06b27e7 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Go Gemini Server + +This is a yet to be named configurable Gemini server for UNIX operating systems. +The server is in a very early state and can only serve static files but in the +near future it will support dynamically generated files like a search endpoints +and an Atom feed. + +## Building + +The server is written in Go so to build it you only need to run one command: + + go build + +This will produce a binary named `go-gemini-server` that you can run. + +## Running + +After you have compiled the server you need to configure it before it will run. +The server expect a configuration file in `/etc/gemini/config.toml` that contain +a path to the documents directory and the certificate files. A simple +configuration file might look like this: + + source = "/var/gemini/docs" + tls_certificate = "/var/gemini/server.crt" + tls_key = "/var/gemini/server.key" + +With this configuration file the server will look for a certificate and key in +`/var/gemini` and for documents in `/var/gemini/docs`. -- cgit v1.2.3