1 ae6870fa 2021-10-04 op => / Home
 2 ae6870fa 2021-10-04 op => /gmid.1.txt docs
 3 ae6870fa 2021-10-04 op 
 4 ae6870fa 2021-10-04 op # Contrib
 5 ae6870fa 2021-10-04 op 
 6 ae6870fa 2021-10-04 op This directory is for additional contributed files which may be useful.
 7 ae6870fa 2021-10-04 op 
 8 ae6870fa 2021-10-04 op ## Dockerfile
 9 ae6870fa 2021-10-04 op 
10 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/Dockerfile contrib/Dockerfile
11 ae6870fa 2021-10-04 op 
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:
14 ae6870fa 2021-10-04 op 
15 ae6870fa 2021-10-04 op ```instructions to build the image
16 ae6870fa 2021-10-04 op # docker build -f contrib/Dockerfile -t gmid .
17 ae6870fa 2021-10-04 op ```
18 9212cf1b 2021-10-04 op 
19 ae6870fa 2021-10-04 op and then run it with something along the lines of:
20 9212cf1b 2021-10-04 op 
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
27 ae6870fa 2021-10-04 op ```
28 ae6870fa 2021-10-04 op 
29 ae6870fa 2021-10-04 op ## OpenBSD rc file
30 ae6870fa 2021-10-04 op 
31 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/gmid contrib/gmid
32 ae6870fa 2021-10-04 op 
33 ae6870fa 2021-10-04 op contrib/gmid is a sample service file for OpenBSD rc(8).  To install it:
34 9212cf1b 2021-10-04 op 
35 ae6870fa 2021-10-04 op ```command to install the rc file
36 ae6870fa 2021-10-04 op # cp contrib/gmid /etc/rc.d
37 ae6870fa 2021-10-04 op ```
38 9212cf1b 2021-10-04 op 
39 ae6870fa 2021-10-04 op then the usual ‘rcctl [start|stop|enable|restart] gmid’ are available.
40 ae6870fa 2021-10-04 op 
41 ae6870fa 2021-10-04 op ## Systemd unit file
42 ae6870fa 2021-10-04 op 
43 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/gmid.service gmid.service
44 ae6870fa 2021-10-04 op 
45 ae6870fa 2021-10-04 op A simple service file for systemd.  To install it
46 9212cf1b 2021-10-04 op 
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
49 ae6870fa 2021-10-04 op ```
50 9212cf1b 2021-10-04 op 
51 ae6870fa 2021-10-04 op then the usual ‘systemctl [status|start|enable|stop] gmid’ commands can be used to manage the server.
52 ae6870fa 2021-10-04 op 
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
56 ae6870fa 2021-10-04 op 
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
59 eb82dcfb 2021-10-04 op ```
60 eb82dcfb 2021-10-04 op 
61 eb82dcfb 2021-10-04 op * logs can be inspected with journalctl(1)
62 eb82dcfb 2021-10-04 op 
63 eb82dcfb 2021-10-04 op ```reads gmid logs with journalctl
64 eb82dcfb 2021-10-04 op # journalctl -t gmid
65 eb82dcfb 2021-10-04 op ```
66 eb82dcfb 2021-10-04 op 
67 ae6870fa 2021-10-04 op ## Vim syntax files
68 ae6870fa 2021-10-04 op 
69 ae6870fa 2021-10-04 op => https://git.omarpolo.com/gmid/tree/contrib/vim contrib/vim
70 ae6870fa 2021-10-04 op 
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.:
72 9212cf1b 2021-10-04 op 
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/
76 ae6870fa 2021-10-04 op ```
77 ae6870fa 2021-10-04 op 
78 ae6870fa 2021-10-04 op To enable Syntastic checker, add to your vimrc:
79 9212cf1b 2021-10-04 op 
80 ae6870fa 2021-10-04 op ```
81 ae6870fa 2021-10-04 op let g:syntastic_gmid_checkers = ['gmid']
82 ae6870fa 2021-10-04 op ```
83 ae6870fa 2021-10-04 op 
84 ae6870fa 2021-10-04 op => vim-screenshot.png Screenshot of vim editing gmid.conf