summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 468dba9d7098e11499a82daf36a089c36b574e04 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# gmnisrv

gmnisrv is a simple [Gemini](https://gemini.circumlunar.space) protocol server.

## Installation

Dependencies:

- A C11 compiler and a POSIX-like system
- OpenSSL
- Mailcap (for /etc/mime.types)
- [scdoc](https://git.sr.ht/~sircmpwn/scdoc) (optional)

```
$ 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

[example.org]
root=/srv/gemini/example.org

[example.com]
root=/srv/gemini/example.com
```

For full details on gmnisrv configuration, consult the **gmnisrv**(5) manual
page.

## Usage

See **gmnisrv**(1).