1
0
forked from aniani/gmnisrv
gmnisrv/README.md

52 lines
969 B
Markdown
Raw Normal View History

2020-09-24 11:11:48 -04:00
# gmnisrv
2020-09-26 16:43:34 -04:00
gmnisrv is a simple [Gemini](https://gemini.circumlunar.space) protocol server.
## Installation
2020-09-26 16:45:43 -04:00
Dependencies:
- A C11 compiler and a POSIX-like system
- OpenSSL
2020-11-01 14:24:31 -05:00
- Mailcap (for /etc/mime.types)
2020-09-26 16:45:43 -04:00
- [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional)
2020-09-26 16:43:34 -04:00
```
$ 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
2020-09-26 18:51:24 -04:00
[example.org]
root=/srv/gemini/example.org
[example.com]
root=/srv/gemini/example.com
2020-09-26 16:43:34 -04:00
```
2020-09-26 16:46:07 -04:00
For full details on gmnisrv configuration, consult the **gmnisrv**(5) manual
page.
2020-09-26 16:43:34 -04:00
## Usage
2020-09-26 16:46:07 -04:00
See **gmnisrv**(1).