aboutsummaryrefslogtreecommitdiffstats
path: root/www/owncast/pkg/README
diff options
context:
space:
mode:
Diffstat (limited to 'www/owncast/pkg/README')
-rw-r--r--www/owncast/pkg/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/www/owncast/pkg/README b/www/owncast/pkg/README
new file mode 100644
index 0000000..ccbb8fd
--- /dev/null
+++ b/www/owncast/pkg/README
@@ -0,0 +1,19 @@
++-----------------------------------------------------------------------
+| Running ${PKGSTEM} on OpenBSD
++-----------------------------------------------------------------------
+
+Owncast comes with web interface for users and a stream admin.
+Out of the box owncast listens on port 8080 on all interfaces, but
+this could be changed by passing desired values to -webserverip
+and -webserverport flags using rcctl(8).
+
+Owncast doesn't handle TLS, so you're supposed to be running it
+behind a TLS-terminating reverse-proxy if you want to host a public
+instance.
+
+On first start owncast will populate its data directory with a
+database and static files. You can add custom emojis here.
+
+Be sure to change the default admin password! It is advised to not
+forward the /admin path and the rtmp port for public access
+even though they are password-protected.