GHCR.md

GitHub Container Registry

This project uses GitHub Container Registry to publish Docker images. The published images are:

• ghcr.io/johnr24/colourstream-frontend:latest
• ghcr.io/johnr24/colourstream-backend:latest
• ghcr.io/johnr24/colourstream-ovenmediaengine:latest

Quick Setup

The easiest way to deploy ColourStream is using our setup script:

curl -s https://raw.githubusercontent.com/johnr24/colourstream/main/setup-ghcr.sh | bash

This script will:

1. Download the necessary configuration files
2. Generate secure random passwords and secrets
3. Configure the application to use the GHCR images
4. Create all required directories and environment files

After running the script, you can simply start the application with:

docker-compose up -d

Manual Setup

If you prefer to set up manually:

1. Pull the images:

   docker pull ghcr.io/johnr24/colourstream-frontend:latest
   docker pull ghcr.io/johnr24/colourstream-backend:latest
   docker pull ghcr.io/johnr24/colourstream-ovenmediaengine:latest

2. Download the docker-compose template:

   curl -s https://raw.githubusercontent.com/johnr24/colourstream/main/docker-compose.template.yml > docker-compose.yml

3. Configure your environment files and directories

4. Start the application:

   docker-compose up -d

Publishing New Versions

Images are automatically built and published when:

• Code is pushed to the main branch (tagged as latest)
• A version tag is pushed (tagged with the version, e.g., v1.0.0)

To create a versioned release:

git tag v1.0.0
git push origin v1.0.0