www/inks/pkg/README (view raw)
1+-----------------------------------------------------------------------
2| Running ${PKGSTEM} on OpenBSD
3+-----------------------------------------------------------------------
4
5Inks requires a working reverse proxy and https to work properly.
6Before following this guide, acquire a domain and a certificate for it
7(for example, using acme-client(1)).
8
9Then, initialize the database:
10
11$ doas su -l _inks -c 'inks init'
12
13Then type in username, password, listen address and a site name.
14The latter should be the same as your desired domain.
15
16Enable and start the inks service:
17
18$ doas rcctl enable inks && doas rcctl start inks
19
20Configure relayd(8) to forward incoming connections to local endpoint
21you specified at initialization step.
22
23Here is an example relayd(8) config:
24
25``` relayd.conf
26table <inks> { 127.0.0.1 }
27
28http protocol www {
29 tls keypair example.com
30 pass request forward to <inks>
31}
32
33relay www {
34 listen on egress port 443 tls
35 protocol www
36 forward to <inks> port 1268
37}
38```
39
40Then enable and start relayd(8).