2 ae6870fa 2021-10-04 op => /gmid.1.txt docs
6 ae6870fa 2021-10-04 op This directory is for additional contributed files which may be useful.
10 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/Dockerfile contrib/Dockerfile
12 ae6870fa 2021-10-04 op A sample Dockerfile. The resulting image is a classic alpine linux image with a statically linked gmid installed as /bin/gmid.
13 ae6870fa 2021-10-04 op To build the image:
15 ae6870fa 2021-10-04 op ```instructions to build the image
16 ae6870fa 2021-10-04 op # docker build -f contrib/Dockerfile -t gmid .
19 ae6870fa 2021-10-04 op and then run it with something along the lines of:
21 ae6870fa 2021-10-04 op ```instruction to run the image
22 ae6870fa 2021-10-04 op # docker run --rm -it -p 1965:1965 \
23 ae6870fa 2021-10-04 op -v gmid.conf:/etc/gmid.conf:ro \
24 ae6870fa 2021-10-04 op -v path/to/keys:/tls:ro \
25 ae6870fa 2021-10-04 op -v /var/gemini:/var/gemini:ro \
26 ae6870fa 2021-10-04 op gmid -c /etc/gmid.conf
29 ae6870fa 2021-10-04 op ## OpenBSD rc file
31 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/gmid contrib/gmid
33 ae6870fa 2021-10-04 op contrib/gmid is a sample service file for OpenBSD rc(8). To install it:
35 ae6870fa 2021-10-04 op ```command to install the rc file
36 ae6870fa 2021-10-04 op # cp contrib/gmid /etc/rc.d
39 ae6870fa 2021-10-04 op then the usual ‘rcctl [start|stop|enable|restart] gmid’ are available.
41 ae6870fa 2021-10-04 op ## Systemd unit file
43 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/gmid.service gmid.service
45 ae6870fa 2021-10-04 op A simple service file for systemd. To install it
47 ae6870fa 2021-10-04 op ```instructions to install the system file
48 ae6870fa 2021-10-04 op # cp contrib/gmid.service /lib/systemd/system/gmid.service
51 ae6870fa 2021-10-04 op then the usual ‘systemctl [status|start|enable|stop] gmid’ commands can be used to manage the server.
53 ae6870fa 2021-10-04 op Some things to keep in mind:
54 eb82dcfb 2021-10-04 op * the ExecStart path may depend on the installation
55 eb82dcfb 2021-10-04 op * a ‘gmid’ user needs to be create for e.g. with
57 eb82dcfb 2021-10-04 op ```how to create a dedicated user
58 eb82dcfb 2021-10-04 op # useradd --system --no-create-home -s /bin/nologin -c "gmid Gemini server" gmid
61 eb82dcfb 2021-10-04 op * logs can be inspected with journalctl(1)
63 eb82dcfb 2021-10-04 op ```reads gmid logs with journalctl
64 eb82dcfb 2021-10-04 op # journalctl -t gmid
67 ae6870fa 2021-10-04 op ## Vim syntax files
69 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/vim contrib/vim
71 ae6870fa 2021-10-04 op 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.:
73 ae6870fa 2021-10-04 op ```install the vim syntax highlight in your home
74 ae6870fa 2021-10-04 op $ mkdir -p ~/.vim
75 ae6870fa 2021-10-04 op $ cp -R contrib/vim/* ~/.vim/
78 ae6870fa 2021-10-04 op To enable Syntastic checker, add to your vimrc:
81 ae6870fa 2021-10-04 op let g:syntastic_gmid_checkers = ['gmid']
84 ae6870fa 2021-10-04 op => vim-screenshot.png Screenshot of vim editing gmid.conf