Documentation


Cluster Setup Guide

This guide will help you set up your Zeus Cluster by adding the necessary servers, configuring endpoints, and installing your SSL certificate.

1. Log In & Create Your Cluster

  1. Log In to Your Account

  2. Access the Clusters Page

    • In the left-hand menu, click on Clusters.

  3. Add a New Cluster

    • In the upper-right corner, click Actions > Add Cluster.
    • Enter a Cluster Name of your choice.
    • Click Submit.
    • You will be redirected to the Cluster Overview page.

2. Add Servers to Your Cluster

Each server in your cluster must be added and installed separately.

2.1 Add a Server

  1. Start the Process

    • In the Cluster Overview page, in the upper-right corner, click Actions > Add Server.

  2. Enter Server Details

    • Server Name: Give your server a recognizable name.
    • Server Hostname: Enter a valid DNS entry that is pre-configured for this server.
    • Select Server Role: Choose the appropriate role from the list.

  3. Server Installation Script

    • After submitting, you will be taken to the Server Overview page.
    • A server installation script will be displayed.
    • Copy the installation command.

  4. Run the Installation Script

    • Open an SSH terminal connected to the new server.
    • Paste and run the installation command.
    • The server will start installing and will automatically reboot once the installation is complete.
    • After reboot, refresh the Cluster Overview page in the CMS to view updated server stats.

2.2 Repeat for Each Required Server Role

Ensure that you complete the above steps for each of the following server roles:

Note: You must have at least one server installed for each role before proceeding.

3. Configure Cluster Settings

Once you have added all required servers, update additional cluster information.

  1. Navigate to Clusters

    • From the left-hand menu, click Clusters.

  2. Edit Your Cluster

    • Locate your cluster in the list.
    • On the left side of the cluster row, click Actions > Edit Cluster.

  3. Enter the Following Information

    • RTMP Endpoint

      • This is where content creators send their streams.
      • Example: publish.domain.com
      • Note: Point this to the IP address of your primary RTMP Server.

    • HLS Endpoint

      • This is where viewers connect to watch the streams.
      • Example: watch.domain.com
      • Note: Point this to the IP address of your Load Balancing Server.

    • API Endpoints (Optional)

      • Configure API endpoints if you wish the Zeus Cluster to send notifications when:
        • A stream goes live.
        • A stream ends.
        • A stream recording is ready for post processing.

  4. Save Your Changes

    • Review the information and click Save.

4. Install an SSL Certificate on the Load Balancing Server

  1. Locate the Load Balancer

    • In the Cluster Overview, find your Load Balancing Server in the list of servers.

  2. Begin SSL Installation

    • On the right-hand side of the Load Balancer row, click Actions > Install SSL Certificate.
    • A unique SSL installation script will be displayed.

  3. Run the SSL Installation Script

    • Open an SSH terminal on your Load Balancing Server.
    • Copy the SSL installation script and paste it into the terminal.
    • Run the script to install the SSL certificate.

5. Finalizing Setup

Congratulations!
Your Zeus Cluster is now set up and ready to handle live streaming events. 

Add a Stream


  1. Access the Streams Section

    • In the left-hand menu, click Streams to navigate to the streams overview page.

  2. Add a New RTMP Stream

    • In the upper-right corner of the page, click Actions > Add RTMP Stream.

  3. Configure Your Stream

    • Select Your Cluster: Choose the desired cluster from the dropdown list.
    • Enter a Stream Name: Provide a name for your stream.

  4. Retrieve Your Streaming Details

    • After submitting, you will be redirected to a page displaying your RTMP Server and RTMP Key.

  5. Start Streaming

    • Enter the provided RTMP Server and RTMP Key into your streaming software (e.g., OBS, vMIX, or any other RTMP streaming client).
    • Your stream is now ready to go live!

Follow these steps to seamlessly add and configure a new stream on your Zeus Cluster. Happy streaming!

How to watch your stream

  1. Access the Streams Overview

    • From the left-hand menu, select Streams.
    • This will take you to the streams overview page.

  2. Locate Your Stream

    • Scroll down until you find your stream.
    • Or, use the search box in the upper-right corner of the table to filter and locate your stream.

  3. View Stream Metrics

    • On the right-hand side of your stream row, click Actions > View Stream Metrics.
    • This opens the overview page for your specific stream.

  4. Get Connection Details

    • On the stream overview page, in the upper-right corner, click Actions > Connection Details.
    • A details page will appear, providing you with the following information:
      • RTMP Server – The server endpoint for streaming.
      • RTMP Key – The unique key associated with your stream.
      • RAW HLS Endpoint – A direct HLS feed from the RTMP server without transcoding (for internal pre-processing only).
      • Transcoded HLS Endpoint – A feed that has been transcoded for adaptive bitrate (ABR) and multi-bitrate delivery; ideal for passing to CDNs.
      • HTML5 Web Player – Preconfigured HTML and JavaScript markup to embed the live stream directly onto any website.

  5. Watch Your Stream

    • Use the Transcoded HLS Endpoint or embed the HTML5 Web Player code on your website to watch the live stream.
    • Note: Avoid sharing the RAW HLS Endpoint publicly as it’s intended only for additional processing.

With these steps, you can easily access and monitor your live stream. Enjoy watching your stream in action!

  1. Access the Streams Overview

    • From the left-hand menu, select Streams.
    • This will take you to the streams overview page.

  2. Locate Your Stream

    • Scroll down until you find your stream.
    • Or, use the search box in the upper-right corner of the table to filter and locate your stream.

  3. View Stream Metrics

    • On the right-hand side of your stream row, click Actions > View Stream Metrics.
    • This opens the overview page for your specific stream.

  4. Get Connection Details

    • On the stream overview page, in the upper-right corner, click Actions > Connection Details.
    • A details page will appear, providing you with the following information:
      • RTMP Server – The server endpoint for streaming.
      • RTMP Key – The unique key associated with your stream.
      • RAW HLS Endpoint – A direct HLS feed from the RTMP server without transcoding (for internal pre-processing only).
      • Transcoded HLS Endpoint – A feed that has been transcoded for adaptive bitrate (ABR) and multi-bitrate delivery; ideal for passing to CDNs.
      • HTML5 Web Player – Preconfigured HTML and JavaScript markup to embed the live stream directly onto any website.

  5. Watch Your Stream

    • Use the Transcoded HLS Endpoint or embed the HTML5 Web Player code on your website to watch the live stream.
    • Note: Avoid sharing the RAW HLS Endpoint publicly as it’s intended only for additional processing.

With these steps, you can easily access and monitor your live stream. Enjoy watching your stream in action!

Content Triggers

Content Triggers are a premium feature that monitors the audio of your streams in real time. Zeus will listen for trigger words or phrases and assign them a score. Once a stream accumulates 100 trigger points, an alert is sent via an API call so you can take appropriate action based on your community guidelines.

Adding/Configuring a Content Trigger

  1. Navigate to Content Triggers

    • In the left-hand menu, click Content Triggers.

  2. Add a New Trigger

    • In the upper-right corner, click Actions > Add Trigger.

  3. Configure the Trigger

    • Select Cluster: Choose the cluster where you want the content trigger to apply.
    • Trigger Word/Phrase: Enter the word or phrase you want Zeus to monitor.
    • Trigger Score: Enter the score that should be assigned each time the trigger word/phrase is detected.

  4. Save Your Trigger

    • Confirm your settings to add the trigger.

How to Enable Content Triggers for a Stream

  1. Access Streams

    • From the left-hand menu, click Streams.

  2. Find Your Stream

    • Locate the stream you wish to enable content triggers for. You can scroll through the list or use the search box in the upper-right corner to filter the list.

  3. View Stream Metrics

    • On the right-hand side of your chosen stream, click Actions > View Stream Metrics.

  4. Enable Content Monitoring

    • On the stream summary page, in the upper-right corner, click Content Monitoring. This action will enable content trigger monitoring for that stream.

Your Content Triggers are now set up and active. Zeus will start monitoring the stream's audio, and once the cumulative score reaches 100 points, you’ll receive an alert via the configured API. Enjoy the enhanced control over your streaming content!

How to Go Live with Zeus and OBS

Below is a detailed step-by-step tutorial on how to locate your RTMP Endpoint and RTMP Key from your Zeus Cluster dashboard and configure them in OBS for streaming. Where possible, sample screenshots are indicated as placeholders—simply replace these with your actual images when preparing your final documentation.

Part 1: Retrieving Your RTMP Details from Zeus Cluster

Step 1: Log in and Navigate to Streams

  1. Log in to Your Zeus Cluster Account:

    • Open your web browser and go to zeuscluster.com.
    • Enter your credentials and log in.
      zeus_screenshot_0017.png

  2. Access the Streams Section:

    • In the left-hand menu, click on Streams.
    • This will take you to the Streams Overview page.

Step 2: Locate Your Specific Stream

  1. Find Your Stream:

    • Scroll through the list until you see your stream.
    • Alternatively, use the Search Box in the upper-right corner of the table to filter for your stream.

  2. View Stream Metrics:

    • On the right-hand side of your stream row, click Actions > View Stream Metrics.
    • This action will take you to the Stream Summary page.

    zeus_screenshot_0006.png

Step 3: Get Your RTMP Endpoint and Key

  1. Access Connection Details:

    • On the Stream Summary page, locate the Actions button in the upper-right corner.
    • Click on Actions > Connection Details.
    • A new page will appear with your stream’s connection details.

    zeus_screenshot_0004.png

  2. Note Your RTMP Information:

    • RTMP Server: This is your streaming endpoint.
    • RTMP Key: This unique key authorizes your stream.
    • Optionally, you may see additional endpoints (like HLS endpoints or HTML5 web player code) which are useful for other purposes.

  3. Copy the RTMP Server and RTMP Key:

    • Highlight and copy these details; you’ll need them for configuring OBS.

Part 2: Configuring OBS with Your RTMP Details

Step 4: Open OBS and Access Stream Settings

  1. Launch OBS Studio:

    • Open OBS on your computer.

    obs_screenshot_0001.png

  2. Access Settings:

    • Click on the Settings button in the lower-right corner of OBS.

  3. Navigate to the Stream Tab:

    • In the Settings window, click on the Stream tab located in the left-hand sidebar.

    obs_screenshot_0000.png

Step 5: Enter Your RTMP Server and Key

  1. Select Streaming Service:

    • From the Service drop-down menu, choose Custom... (if Zeus isn’t listed).

  2. Paste Your RTMP Endpoint and RTMP Key:

    • In the Server field, paste the RTMP Server URL you copied.
    • In the Stream Key field, paste your RTMP Key.

  3. Apply the Settings:

    • Click Apply, then OK to save your settings.

Step 6: Start Streaming

  1. Begin Your Live Stream:

    • Once configured, click Start Streaming on the OBS main window.
    • OBS will connect to your Zeus Cluster using the provided RTMP details.

Summary

This completes your tutorial on setting up your live stream using Zeus Cluster and OBS. Enjoy broadcasting your content!