Egg Repository

Pterodactyl Community Egg Repository

owncast.online

Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software.

Read Me

Owncast

From the Owncast 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 8090
RTMP 8091
Yolks
NameTag
ghcr.io/pterodactyl/yolks:debianghcr.io/pterodactyl/yolks:debian
Variables
NameDescriptionEnvironment VariableDefault ValueUser ViewableUser Editable
RTMP PortThe port that is used to receive the stream data.RTMP_PORT8091YesNo
Stream/Admin KeyThis is used to authenticate to the web admin interface, as well as to authenticate your stream.STREAM_KEYYesYes
Owncast VersionThe version of Owncast that you would like to install, from https://github.com/owncast/owncast/releases As an Example - "v0.0.11" for a specific version or "latest" for the most up to date version.VERSIONlatestYesYes
Github RepositoryUsed to identify the github repository to pull the release from.GITHUB_PACKAGEowncast/owncastNoNo
Github File MatchUsed to identify the specific asset under a release for download.MATCHlinux-64bitNoNo
Github UserRequired if you are doing more calls than the github anonymous API user allows.GITHUB_USERNoNo
Github Oauth TokenRequired if you are doing more calls than the github anonymous API user allows.GITHUB_OAUTH_TOKENNoNo
Install Script
#!/bin/bash

#Make Server Dir
if [ ! -d /mnt/server/ ]; then
    mkdir /mnt/server/
fi
cd /mnt/server/

#Get Dependencies
apt-get -y update
apt-get -y install curl unzip tar jq

#Get Owncast Install Files

if [ -z "${GITHUB_USER}" ] && [ -z "${GITHUB_OAUTH_TOKEN}" ] ; then
    echo -e "using anon api call"
else
    echo -e "user and oauth token set"
    alias curl='curl -u ${GITHUB_USER}:${GITHUB_OAUTH_TOKEN} '
fi

## get release info and download links
LATEST_JSON=$(curl --silent "https://api.github.com/repos/${GITHUB_PACKAGE}/releases/latest")
RELEASES=$(curl --silent "https://api.github.com/repos/${GITHUB_PACKAGE}/releases")

if [ -z "${VERSION}" ] || [ "${VERSION}" == "latest" ]; then
    DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})
else
    VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION "${VERSION}" '.[] | select(.tag_name==$VERSION) | .tag_name')
    if [ "${VERSION}" == "${VERSION_CHECK}" ]; then
        DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION "${VERSION}" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})
    else
        echo -e "defaulting to latest release"
        DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)
    fi
fi

echo Download URL is: ${DOWNLOAD_URL}

curl -L ${DOWNLOAD_URL} --output ./owncast_installer.zip

#curl -L https://github.com/owncast/owncast/releases/download/v${OWNCAST_VERSION}/owncast-${OWNCAST_VERSION}-linux-64bit.zip --output ./owncast_installer.zip

#Unzip Install Files
unzip -o -q ./owncast_installer.zip
rm ./owncast_installer.zip

## install end
echo "-----------------------------------------"
echo "Installation completed..."
echo "-----------------------------------------"