Skip to content

Setup

Prerequisites

  • Docker and Docker Compose
  • MySQL or MariaDB database server

Quick Start with Docker Compose

Create a docker-compose.yaml file:

services:
  encoder:
    image: cr.jdbnet.co.uk/public/encoder:latest
    container_name: encoder
    restart: always
    ports:
      - 5000:5000
    environment:
      - DB_HOST=your-mysql-or-mariadb-host
      - DB_USER=database-user
      - DB_PASSWORD=database-password
      - DB_NAME=encoder
      - SECRET_KEY=set-your-secret-key-here
    volumes:
      - encoder-temp:/temp
      - /path/to/your/local/media:/media

volumes:
  encoder-temp:

Replace the placeholder environment variables with your actual database credentials

Run the container:

docker compose up -d

Database Configuration

The application requires a MySQL or MariaDB database to track encoding jobs and store configuration.

  1. Create the database:

    CREATE DATABASE encoder;
    

  2. Set the environment variables for database connection:

  3. DB_HOST: Database server hostname or IP
  4. DB_USER: Database username
  5. DB_PASSWORD: Database password
  6. DB_NAME: Database name (default: encoder)

Initial Access

Once running, access the web interface at http://localhost:5000