the-maty / owncast-scripts

Start and stop the Owncast server on macOS and Linux platforms

Owncast Server Control Scripts

This repository contains scripts to conveniently start and stop the Owncast server on macOS and Linux platforms.

Getting Started

Prerequisites

• Owncast server installed on your machine. You can find more information on how to install Owncast here.
• A pre-configured Cloudflare Tunnel is required for optimal functionality. Installation instructions can be found here.
• If you want to have shortcuts on your desktop with a nice icon, here and here are the icons that I use.

Installation

1. Clone this repository to your local machine.

   git clone https://github.com/the-maty/owncast-server-scripts.git

2. Create your config.sh file from example-config.sh .

Usage

Starting Owncast Server

To start the Owncast server including Cloudflare Tunnel, use the following command:

chmod 600 config.sh
chmod +x owncast-start.sh
./owncast-start.sh

Stopping Owncast Server

To gracefully stop the Owncast server, execute the following command:

chmod +x owncast-stop.sh
./owncast-stop.sh

Compatibility

These scripts are designed to work seamlessly on both macOS and Linux platforms.

• macOS: Tested on macOS version 10.15 and later.
• Linux: Successfully tested on Ubuntu 18.04 and later.

Feel free to use these scripts on your preferred operating system, ensuring a consistent experience across compatible environments.

## Contributing