Skip to content

Latest commit

 

History

History
167 lines (124 loc) · 16.5 KB

README.md

File metadata and controls

167 lines (124 loc) · 16.5 KB
Raw

Logo

Ganymede

Twitch VOD and Live Stream archiving platform with a real-time and rendered chat experience. Files are saved in a friendly format allowing for use without Ganymede.

Screenshot

ganymede-readme_landing

ganymede_landing_video.mp4

About

Ganymede allows archiving of past streams (VODs) and live streams with a real-time chat playback along with a archival-friendly rendered chat. All files are saved in a friendly way that doesn't require Ganymede to view them (see file structure). Ganymede is the successor of Ceres.

Features

  • Realtime Chat Playback
  • SSO / OAuth authentication (wiki)
  • Light/dark mode toggle.
  • 'Watched channels' - watch channels for videos and live streams.
  • Twitch VOD/Livestream support.
  • Full VOD, Channel, and User management.
  • Custom post-download video FFmpeg parameters.
  • Custom chat render parameters.
  • Webhook notifications.
  • Simple file structure for long-term archival that will outlas Ganymede.
  • Recoverable queue system.
  • Playback / progress saving.
  • Playlists.

Documentation

For in-depth documentation on features visit the wiki.

API

Visit the docs folder for the API docs.

Installation

Requirements

Installation

Ganymede consists of four docker containers:

  1. API
  2. Frontend
  3. Postgres Database
  4. Nginx

Feel free to use an existing Postgres database container and Nginx container if you don't want to spin new ones up.

  1. Download a copy of the docker-compose.yml file and nginx.conf.
  2. Edit the docker-compose.yml file modifying the environment variables, see environment variables for more information.
  3. Run docker compose up -d.
  4. Visit the address and port you specified for the frontend and login with username: admin password: ganymede.
  5. Change the admin password or create a new user, grant admin permissions on that user, and delete the admin user.

Rootless

The API container can be run as a non root user. To do so add PUID and PGID environment variables, setting the value to your user. Read linuxserver's docs about this for more information.

Note: On startup the container will chown the config, temp, and logs directory. It will not recursively chown the /data/videos directory. Ensure the mounted /data/videos directory is readable by the set user.

Environment Variables

The docker-compose.yml file has comments for each environment variable. The *_URL envionrment variables must be the 'public' URLs (e.g. https://ganymedem.domain.com) it cannot be a URL to just the docker service.

API
ENV Name Description
DEBUG Enable debug logging true or false.
VIDEOS_DIR Path inside the container to the videos directory. Default: /data/videos.
TEMP_DIR Path inside the container where temporary files are stored during archiving. Default: /data/temp.
LOGS_DIR Path inside the container where log files are stored. Default: /data/logs.
CONFIG_DIR Path inside the container where the config is stored. Default: /data/config.
PATH_MIGRATION_ENABLED Enable path migration at startup. Default: true.
TZ Timezone.
DB_HOST Host of the database.
DB_PORT Port of the database.
DB_USER Username for the database.
DB_PASS Password for the database.
DB_NAME Name of the database.
DB_SSL Whether to use SSL. Default: disable. See DB SSL for more information.
DB_SSL_ROOT_CERT Optional Path to DB SSL root certificate. See DB SSL for more information.
JWT_SECRET Secret for JWT tokens. This should be a long random string.
JWT_REFRESH_SECRET Secret for JWT refresh tokens. This should be a long random string.
TWITCH_CLIENT_ID Twitch application client ID.
TWITCH_CLIENT_SECRET Twitch application client secret.
FRONTEND_HOST Host of the frontend, used for CORS. Example: http://192.168.1.2:4801
COOKIE_DOMAIN Optional Domain the cookie is valid for. This is used with a reverse proxy and should be the top level domain (e.g. domain.com). You may need to tinker with this variable depending how your reverse proxy is setup. Typically it is the root where ganymede is or the level up-one.
OAUTH_ENABLED Optional Wheter OAuth is enabled true or false. Must have the other OAuth variables set if this is enabled.
OAUTH_PROVIDER_URL Optional OAuth provider URL. See https://github.com/Zibbp/ganymede/wiki/SSO---OpenID-Connect
OAUTH_CLIENT_ID Optional OAuth client ID.
OAUTH_CLIENT_SECRET Optional OAuth client secret.
OAUTH_REDIRECT_URL Optional OAuth redirect URL, points to the API. Example: http://localhost:4000/api/v1/auth/oauth/callback.
MAX_CHAT_DOWNLOAD_EXECUTIONS Maximum number of chat downloads that can be running at once. Live streams bypass this limit.
MAX_CHAT_RENDER_EXECUTIONS Maximum number of chat renders that can be running at once.
MAX_VIDEO_DOWNLOAD_EXECUTIONS Maximum number of video downloads that can be running at once. Live streams bypass this limit.
MAX_VIDEO_CONVERT_EXECUTIONS Maximum number of video conversions that can be running at once.
Frontend
ENV Name Description
API_URL Host for the API. Example: http://192.168.1.2:4800.
CDN_URL Host for the Nginx serivce. Example: http://197.148.1.2:4802.
SHOW_SSO_LOGIN_BUTTON true/false Show a "login via sso" button on the login page.
FORCE_SSO_AUTH true/false Force users to login via SSO by bypassing the login page.
REQUIRE_LOGIN true/false Require users to be logged in to view videos.
DB

Ensure these are the same in the API environment variables.

ENV Name Description
POSTGRES_PASSWORD Database password
POSTGRES_USER Database username.
POSTGRES_DB Name of the database.

Volumes

API
Volume Description Example
/data/videos Mount for video storage. This must match the VIDEOS_DIR environment variable. /mnt/nas/vods:/data/videos
/data/logs Mount to store task logs. This must match the LOGS_DIR environment variable. ./logs:/data/logs
/data/temp Mount to store temporay files during the archive process. This is mounted to the host so files are recoverable in the event of a crash. This must match the TEMP_DIR environment variable. ./temp:/data/temp
/data/config Mount to store the config. This must match the CONFIG_DIR environment variable. ./config:/data/config
Nginx
Volume Description Example
/data/videos Mount for video storage, same as the API container volume. /mnt/nas/vods:/data/videos
/etc/nginx/nginx.conf:ro Path to the Nginx conf file. /path/to/nginx.conf:/etc/nginx/nginx.conf:ro

Acknowledgements

License

GNU General Public License v3.0