ganymede

module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 1, 2022 License: GPL-3.0

README


Logo

Ganymede

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


Demo

landing-demo

https://user-images.githubusercontent.com/21207065/180067579-674af497-090f-4e07-9c81-0314c6361a87.mp4

About

Ganymede allows archiving of past streams (VODs) and livestreams both with a 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

  • Light/dark mode toggle.
  • Twitch VOD/Livestream support.
  • Queue holds.
  • Queue task restarts.
  • Full VOD, Channel, and User management.
  • Custom post-download video FFmpeg parameters.
  • Custom chat render parameters.
  • Webhook notifications.

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.
  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.

Environment Variables

API
ENV Name Description
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 or not enable/disable.
JWT_SECRET Secret for JWT tokens.
JWT_REFRESH_SECRET Secret for JWT refresh tokens.
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
Frontend
ENV Name Description
NUXT_PUBLIC_API_URL Host for the API. Example: http://192.168.1.2:4800.
NUXT_PUBLIC_CDN_URL Host for the Nginx serivce. Example: http://197.148.1.2:4802.
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
/vods Mount for VOD storage. This example I have my NAS mounted to /mnt/vault/vods. /mnt/vault/vods:/vods
/logs Queue log folder. ./logs:/logs
/data Config folder. ./data:/data

Optional

./tmp:/tmp Binding the tmp folder prevents lost data if the container crashes as temporary downloads are stored in tmp which gets flushed when the container stops.

Nginx
Volume Description Example
/mnt/vods VOD storage, same as the API container volume. /mnt/vault/vods:/mnt/vods
/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

Authors

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL