3 This directory is for additional contributed files which may be useful.
7 => TREE/contrib/Dockerfile contrib/Dockerfile
9 A sample Dockerfile that builds an alpine linux-based image with a statically linked gmid installed as /bin/gmid. To build the image:
11 ```instructions to build the image
12 # docker build -f contrib/Dockerfile -t gmid .
15 and then run it with something along the lines of:
17 ```instruction to run the image
18 # docker run --rm -it -p 1965:1965 \
19 -v gmid.conf:/etc/gmid.conf:ro \
20 -v path/to/keys:/tls:ro \
21 -v /var/gemini:/var/gemini:ro \
22 gmid -c /etc/gmid.conf
27 => TREE/contrib/gencert contrib/gencert
29 contrib/gencert is a simple script to generate self-signed certificates.
33 => TREE/contrib/gmid.service contrib/gmid.service
34 => TREE/contrib/gmid.sysusers contrib/gmid.sysusers
36 A simple service file for systemd. To install it
38 ```instructions to install the system file
39 # cp contrib/gmid.service /etc/systemd/system/gmid.service
40 # systemctl daemon-reload
43 then the usual ‘systemctl [status|start|enable|stop] gmid’ commands can be used to manage the server.
45 Some things to keep in mind:
46 * the ExecStart path may depend on the installation
47 * a ‘gmid’ user needs to be created with systemd-sysusers or useradd:
49 ```how to create a dedicated user
50 # systemd-sysusers contrib/gmid.sysusers
52 # useradd --system --no-create-home -s /bin/nologin -c "gmid Gemini server" gmid
55 * logs can be inspected with journalctl(1)
57 ```reads gmid logs with journalctl
63 => TREE/contrib/renew-certs contrib/mime.types
65 A copy of OpenBSD' /usr/share/misc/mime.types to be used as
71 include "/path/to/mime.types"
75 ## renew certificates automatically
77 => TREE/contrib/renew-certs contrib/renew-certs
79 contrib/renew-certs is a script meant to be run in a crontab that watch for certificate expiration. It can optionally renew the certs and restart gmid too.
81 Read the documentation with: perldoc renew-certs
85 => TREE/contrib/vim contrib/vim
87 contrib/vim contains a syntax highlighting for vim. To install it, just copy the files to ~/.vim or to /usr/share/vim/vimfiles, e.g.:
89 ```install the vim syntax highlight in your home
91 $ cp -R contrib/vim/* ~/.vim/
94 To enable Syntastic checker, add to your vimrc:
97 let g:syntastic_gmid_checkers = ['gmid']
100 => vim-screenshot.png Screenshot of vim editing gmid.conf