4 <title>gmid | contrib</title>
5 <meta charset="utf8" />
6 <meta name="viewport" content="width=device-width, initial-scale=1" />
9 font-family: monospace;
51 strong::before { content: "*" }
52 strong::after { content: "*" }
57 background-color: #222;
70 background-color: #f0f0f0;
77 justify-content: center;
90 @media (prefers-color-scheme: dark) {
92 background-color: #222;
101 background-color: #ddd;
105 background-color: #353535;
113 @media (max-width: 400px) {
114 pre.banner { font-size: 9px; }
117 @media (max-width: 500px) {
118 pre.banner { font-size: 10px; }
125 <a href="/">Home</a> | contrib | <a href="gmid.1.html">docs</a>
130 This directory is for additional contributed files which may be
135 <li><a href="#dockerfile">Dockerfile</a></li>
136 <li><a href="#openbsd-rc">OpenBSD rc file</a></li>
137 <li><a href="#systemd-unit-file">Systemd unit file</a></li>
138 <li><a href="#vim-syntax-files">Vim syntax files</a></li>
141 <h2 id="dockerfile">Dockerfile</h2>
143 <a href="https://git.omarpolo.com/gmid/tree/contrib/Dockerfile">
144 <code>contrib/Dockerfile</code></a>
145 is a simple Dockerfile. The resulting image is a classic alpine
146 linux image with a statically linked gmid installed as
147 <code>/bin/gmid</code>.
149 <p>To build the image:</p>
150 <pre># docker build -f contrib/Dockerfile -t gmid .</pre>
151 <p>and then run it with something along the lines of:</p>
152 <pre># docker run --rm -it -p 1965:1965 \
153 -v gmid.conf:/etc/gmid.conf:ro \
154 -v path/to/keys:/tls:ro \
155 -v /var/gemini:/var/gemini:ro \
156 gmid -c /etc/gmid.conf</pre>
157 <h2 id="openbsd-rc">OpenBSD rc file</h2>
159 <a href="https://git.omarpolo.com/gmid/tree/contrib/gmid">contrib/gmid</a>
160 is a sample service file for OpenBSD <code>rc(8)</code>.
163 <pre># cp contrib/gmid /etc/rc.d</pre>
166 <code>rcctl [start|stop|enable|restart] gmid</code>
169 <h2 id="systemd-unit-file">Systemd unit file</h2>
171 <a href="https://git.omarpolo.com/gmid/tree/contrib/gmid.service">
172 <code>contrib/gmid.service</code></a>
173 is a simple service file for
174 systemd. To install it:
176 <pre># cp contrib/gmid.service /lib/systemd/system/gmid.service</pre>
179 <code>systemctl [status|start|enable|stop] gmid</code>
180 commands can be used to manage the server.
182 <p>Some things to keep in mind:</p>
185 the <code>ExecStart</code> path may depend on the installation.
188 a <code>gmid</code> user needs to be created for e.g. with:
189 <pre># useradd --system --no-create-home -s /bin/nologin -c "gmid Gemini server" gmid</pre>
192 logs can be inspected with <code>journalctl(1)</code>:
193 <pre># journalctl -t gmid</pre>
196 <h2 id="vim-syntax-files">Vim syntax files</h2>
198 <a href="https://git.omarpolo.com/gmid/tree/contrib/vim">
199 <code>contrib/vim</code></a>
200 contains a syntax highlighting for vim. To install it, just
201 copy the files to <code>~/.vim</code>
202 or <code>/usr/share/vim/vimfiles</code>, e.g.
204 <pre>$ mkdir -p ~/.vim
205 $ cp -R contrib/vim/* ~/.vim/</pre>
206 <p>To enable Syntastic checker, add to your vimrc:</p>
207 <pre>let g:syntastic_gmid_checkers = ['gmid']</pre>
208 <p>The end result is something like this:</p>
209 <a href="vim-screenshot.png">
210 <img src="vim-screenshot.png" alt="Screenshot of vim editing gmid.conf with syntax highlighting" />