Ganymede

Ganymede

Docker app from grtgbln's Repository

Overview

A Twitch VOD and Live Stream archiving platform with a real-time chat experience. Every archive includes a rendered chat for viewing outside of Ganymede. Files are saved in a friendly format allowing for use without Ganymede.

Requirements


        Requires a separate Postgres database.
    

Runtime arguments

Web UI
http://[IP]:[PORT:4000]/
Network
bridge
Privileged
false

Template configuration

Web UI PortPorttcp

Container Port: 4000

Target
4000
Default
4000
Value
4000
Twitch - Client IDVariable

Twitch Client ID

Target
TWITCH_CLIENT_ID
Twitch - Client SecretVariable

Twitch Client Secret

Target
TWITCH_CLIENT_SECRET
Postgres - HostVariable

Postgres host

Target
DB_HOST
Postgres - PortVariable

Postgres port

Target
DB_PORT
Default
5432
Value
5432
Postgres - DatabaseVariable

Postgres database name

Target
DB_NAME
Default
ganymede
Value
ganymede
Postgres - UserVariable

Postgres user

Target
DB_USER
Postgres - PasswordVariable

Postgres password

Target
DB_PASS
Postgres - Use SSLVariable

Use SSL for Postgres connection. Details: https://github.com/Zibbp/ganymede/wiki/DB-SSL

Target
DB_SSL
Default
disable|enable
Postgres - SSL Root CertVariable

Postgres SSL root certificate. Remove if not needed. Details: https://github.com/Zibbp/ganymede/wiki/DB-SSL

Target
DB_SSL_ROOT_CERT
Require LoginVariable

Require users to be logged in to view videos.

Target
REQUIRE_LOGIN
Default
false|true
OAuth - EnableVariable

Enable OAuth

Target
OAUTH_ENABLED
Default
false|true
OAuth - ProviderVariable

URL for OAuth provider. Details: https://github.com/Zibbp/ganymede/wiki/SSO---OpenID-Connect

Target
OAUTH_PROVIDER_URL
OAuth - Client IDVariable

OAuth client ID

Target
OAUTH_CLIENT_ID
OAuth - Client SecretVariable

OAuth client secret

Target
OAUTH_CLIENT_SECRET
OAuth - Redirect URLVariable

OAuth redirect URL. Details: https://github.com/Zibbp/ganymede/wiki/SSO---OpenID-Connect

Target
OAUTH_REDIRECT_URL
OAuth - Enable Sign-in ButtonVariable

Show a 'login via sso' button on the login page.

Target
SHOW_SSO_LOGIN_BUTTON
Default
false|true
OAuth - Force SSOVariable

Force users to login via SSO by bypassing the login page.

Target
FORCE_SSO_AUTH
Default
false|true
Limits - Chat DownloadsVariable

Maximum number of chat downloads that can be running at once. Live streams bypass this limit.

Target
MAX_CHAT_DOWNLOAD_EXECUTIONS
Default
1
Value
1
Limits - Chat RendersVariable

Maximum number of chat renders that can be running at once.

Target
MAX_CHAT_RENDER_EXECUTIONS
Default
1
Value
1
Limits - Video DownloadsVariable

Maximum number of video downloads that can be running at once. Live streams bypass this limit.

Target
MAX_VIDEO_DOWNLOAD_EXECUTIONS
Default
1
Value
1
Limits - Video ConversionsVariable

Maximum number of video conversions that can be running at once.

Target
MAX_VIDEO_CONVERT_EXECUTIONS
Default
1
Value
1
Video PathPathrw

Mount for video storage

Target
/data/videos
DebugVariable

Enable debug logging

Target
DEBUG
Default
false|true
Internal Videos PathVariable

Internal path to videos. Not recommended to change.

Target
VIDEOS_DIR
Default
/data/videos
Value
/data/videos
Internal Temporary Data PathVariable

Internal path to temporary data. Not recommended to change.

Target
TEMP_DIR
Default
/data/temp
Value
/data/temp
Internal Logs PathVariable

Internal path to logs. Not recommended to change.

Target
LOGS_DIR
Default
/data/logs
Value
/data/logs
Internal Config PathVariable

Internal path to config. Not recommended to change.

Target
CONFIG_DIR
Default
/data/config
Value
/data/config
Path Migration at StartupVariable

Enable path migration at startup

Target
PATH_MIGRATION_ENABLED
Default
true|false
Config PathPathrw

Mount for config storage

Target
/data/config
Default
/mnt/user/appdata/ganymede/config
Value
/mnt/user/appdata/ganymede/config
Logs PathPathrw

Mount for log storage

Target
/data/logs
Default
/mnt/user/appdata/ganymede/logs
Value
/mnt/user/appdata/ganymede/logs
Temp Data PathPathrw

Mount to store temporary files during the archive process.

Target
/data/temp
Default
/mnt/user/appdata/ganymede/temp
Value
/mnt/user/appdata/ganymede/temp

Details

Repository
ghcr.io/zibbp/ganymede:latest
Last Updated2026-05-31
First Seen2024-12-26

Run Ganymede on Unraid.

Ganymede is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.