From b94c6f4f8a7bcf98891306dec5d96ca2885b279c Mon Sep 17 00:00:00 2001
From: PsychoZander <62998704+PsychoZander@users.noreply.github.com>
Date: Thu, 31 Mar 2022 08:45:36 +0100
Subject: [PATCH] Create Owncast README.md

---
 software/owncast/README.md | 51 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 software/owncast/README.md

diff --git a/software/owncast/README.md b/software/owncast/README.md
new file mode 100644
index 00000000..6d2ea6f6
--- /dev/null
+++ b/software/owncast/README.md
@@ -0,0 +1,51 @@
+# Owncast
+
+## From the [Owncast](https://owncast.online) website
+
+Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software.
+
+## Installation
+
+Follow the common egg installation guide to install the egg on your Pterodactyl instance.
+When setting up a server, the version set in the varaible will be used, default is 0.0.11.
+
+## Configuration
+
+Configuring Owncast in Pterodactyl can be done by using the command line switches:
+* -backupdir string
+	* Directory where backups will be written to
+* -database string
+	* Path to the database file.
+* -enableDebugFeatures
+	* Enable additional debugging options.
+* -enableVerboseLogging
+	* Enable additional logging.
+* -logdir string
+	* Directory where logs will be written to
+* -restoreDatabase string
+	* Restore an Owncast database backup
+* -rtmpport int
+	* Set listen port for the RTMP server
+* -streamkey string
+	* Set your stream key/admin password
+* -webserverip string
+	* Force web server to listen on this IP address
+* -webserverport string
+	* Force the web server to listen on a specific port
+
+
+
+## Update support
+
+The egg _should_ keep the `data` folder when reinstalling, to prevent destroying the configuration by accident.
+
+If you want to reset the server completly, remove the `data` directory manually before reinstalling.
+
+### Server Ports
+
+Ports required to run the server in a table format.
+
+| Port            | default |
+| --------------- | ------- |
+| Webserver 	  | 8080    |
+| RTMP 			  | 1935 	|