www/inks: add 0.9.2pre20230325

this is not a real version, but since there were no releases for some
time, i packaged the latest tip of mercurial repository and put it on my
webserver.

1 files changed, 40 insertions, 0 deletions

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).