aboutsummaryrefslogtreecommitdiffstats
path: root/net/matterbridge/pkg/README
diff options
context:
space:
mode:
Diffstat (limited to 'net/matterbridge/pkg/README')
-rw-r--r--net/matterbridge/pkg/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/net/matterbridge/pkg/README b/net/matterbridge/pkg/README
new file mode 100644
index 0000000..239983b
--- /dev/null
+++ b/net/matterbridge/pkg/README
@@ -0,0 +1,19 @@
++-----------------------------------------------------------------------
+| Running ${PKGSTEM} on OpenBSD
++-----------------------------------------------------------------------
+
+There are two example configuration files installed in
+${TRUEPREFIX}/share/${PKGSTEM}. They are heavy commented, so check them
+out. More detailed documentation is available at
+${HOMEPAGE}.
+
+To start using matterbridge, copy the desired sample config, modify
+it to your taste and enable and start matterbridge service. Alternatively,
+of course you can write a new config from scratch.
+
+# cp ${TRUEPREFIX}/share/${PKGSTEM}/${PKGSTEM}-sample.toml ${SYSCONFDIR}/${PKGSTEM}/${PKGSTEM}.toml
+# vi ${SYSCONFDIR}/${PKGSTEM}/${PKGSTEM}.toml
+# rcctl enable ${PKGSTEM} && rcctl start ${PKGSTEM}
+
+The daemon stores it's state in memory, so syncronization of chat rooms
+will not persist between restarts.