diff options
| author | Drew DeVault <sir@cmpwn.com> | 2020-09-26 16:43:34 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2020-09-26 16:45:06 -0400 |
| commit | 0933880b2ba2990bc6a9ed14a4a44cfbfcc2154e (patch) | |
| tree | d599005173e2f7b5884aad6c1fe16d66d2a96a1e /README.md | |
| parent | fc036335eb8d32ad991874aac364752b68a43a24 (diff) | |
| download | gmnisrv-0933880b2ba2990bc6a9ed14a4a44cfbfcc2154e.tar.gz gmnisrv-0933880b2ba2990bc6a9ed14a4a44cfbfcc2154e.tar.xz gmnisrv-0933880b2ba2990bc6a9ed14a4a44cfbfcc2154e.zip | |
Documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 38 insertions, 1 deletions
@@ -1,3 +1,40 @@ # gmnisrv -WIP, come back later +gmnisrv is a simple [Gemini](https://gemini.circumlunar.space) protocol server. + +## Installation + +``` +$ mkdir build +$ cd build +$ ../configure --prefix=/usr +$ make +# make install +``` + +## Configuration + +By default it reads from `/etc/gmnisrv.ini`, but this can be changed by passing +the `-C` flag to the `gmnisrv` daemon. A sample config.ini is provided at +`/usr/share/gmnisrv/gmnisrv.ini`: + +``` +# Space-separated list of hosts +listen=0.0.0.0:1965 [::]:1965 + +[:tls] +# Path to store certificates on disk +store=/var/lib/gemini/certs + +# Optional details for new certificates +organization=gmnisrv user + +[localhost] +root=/var/www +``` + +For full details on gmnisrv configuration, consult the *gmnisrv*(5) manual page. + +## Usage + +See *gmnisrv*(1). |