diff options
Diffstat (limited to 'www/inks/pkg')
| -rw-r--r-- | www/inks/pkg/DESCR | 3 | ||||
| -rw-r--r-- | www/inks/pkg/PLIST | 19 | ||||
| -rw-r--r-- | www/inks/pkg/README | 40 | ||||
| -rw-r--r-- | www/inks/pkg/inks.rc | 12 |
4 files changed, 74 insertions, 0 deletions
diff --git a/www/inks/pkg/DESCR b/www/inks/pkg/DESCR new file mode 100644 index 0000000..5e463ba --- /dev/null +++ b/www/inks/pkg/DESCR @@ -0,0 +1,3 @@ +Simple link aggregator with rss and activitypub support. +Can be used locally or deployed remotely and served via +a reverse proxy. diff --git a/www/inks/pkg/PLIST b/www/inks/pkg/PLIST new file mode 100644 index 0000000..9ae3dd1 --- /dev/null +++ b/www/inks/pkg/PLIST @@ -0,0 +1,19 @@ +@newgroup _inks:1102 +@newuser _inks:1102:_inks::Inks Account:/var/inks:/bin/sh +@rcscript ${RCDIR}/inks +@bin bin/inks +share/doc/pkg-readmes/${PKGSTEM} +share/inks/ +share/inks/schema.sql +share/inks/views/ +share/inks/views/addlink.html +share/inks/views/header.html +share/inks/views/inks.html +share/inks/views/login.html +share/inks/views/sources.html +share/inks/views/style.css +share/inks/views/tags.html +@mode 750 +@owner _inks +@group _inks +@sample ${LOCALSTATEDIR}/inks/ diff --git a/www/inks/pkg/README b/www/inks/pkg/README new file mode 100644 index 0000000..dbea6ad --- /dev/null +++ b/www/inks/pkg/README @@ -0,0 +1,40 @@ ++----------------------------------------------------------------------- +| Running ${PKGSTEM} on OpenBSD ++----------------------------------------------------------------------- + +Inks requires a working reverse proxy and https to work properly. +Before following this guide, acquire a domain and a certificate for it +(for example, using acme-client(1)). + +Then, initialize the database: + +$ doas su -l _inks -c 'inks init' + +Then type in username, password, listen address and a site name. +The latter should be the same as your desired domain. + +Enable and start the inks service: + +$ doas rcctl enable inks && doas rcctl start inks + +Configure relayd(8) to forward incoming connections to local endpoint +you specified at initialization step. + +Here is an example relayd(8) config: + +``` relayd.conf +table <inks> { 127.0.0.1 } + +http protocol www { + tls keypair example.com + pass request forward to <inks> +} + +relay www { + listen on egress port 443 tls + protocol www + forward to <inks> port 1268 +} +``` + +Then enable and start relayd(8). diff --git a/www/inks/pkg/inks.rc b/www/inks/pkg/inks.rc new file mode 100644 index 0000000..eee67aa --- /dev/null +++ b/www/inks/pkg/inks.rc @@ -0,0 +1,12 @@ +#!/bin/ksh + +daemon="${TRUEPREFIX}/bin/inks" +daemon_user="_inks" +daemon_logger="daemon.info" + +. /etc/rc.d/rc.subr + +rc_bg=YES +rc_reload=NO + +rc_cmd $1 |
