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