🚀 Beta Preview

[Zibbp]

EDIT

Release Candidate v1 has been released. Please visit the README for deploying.

---

OLD

Hey everyone,

While Ganymede is still in development I thought it would be good to release a beta for those who would like to try it out and report any bugs.

To get started, use the docker-compose.yml file and make the following changes:

1. Enter your Twitch client ID and secret in the API environment variables.
2. Update the UPDATEIP fields with the IP of the server hosting the Docker containers.
3. Copy the nginx.conf and paste it in a new file named nginx.conf alongside where the docker-compose.yml file lives.
4. Update the path to the nginx.conf under the nginx service volume.

version: '3.3'
services:
  ganymede-api:
    container_name: ganymede-api
    image: ghcr.io/zibbp/ganymede:master
    restart: unless-stopped
    environment:
      - DB_HOST=ganymede-db
      - DB_PORT=5432
      - DB_USER=ganymede
      - DB_PASS=e24e90d9045e61264d9e5ccf
      - DB_NAME=ganymede-testing
      - DB_SSL=disable
      - JWT_SECRET=ec554259e39a1effea4d1b23
      - JWT_REFRESH_SECRET=49a8785ef0574ea8b685bce0
      - TWITCH_CLIENT_ID=
      - TWITCH_CLIENT_SECRET=
      - FRONTEND_HOST=http://UPDATEIP:4801
    volumes:
      - ./vods:/vods
      - ./logs:/logs
      - ./data:/data
    ports:
      - 4800:4000
  ganymede-frontend:
    container_name: ganymede-frontend
    image: ghcr.io/zibbp/ganymede-frontend:master
    restart: unless-stopped
    environment:
      - NUXT_PUBLIC_API_URL=http://UPDATEIP:4800
      - NUXT_PUBLIC_CDN_URL=http://UPDATEIP:4802
    ports:
      - 4801:3000
  ganymede-db:
    container_name: ganymede-db
    image: postgres:14
    volumes:
      - ./ganymede-db:/var/lib/postgresql/data
    environment:
      - POSTGRES_PASSWORD=e24e90d9045e61264d9e5ccf
      - POSTGRES_USER=ganymede
      - POSTGRES_DB=ganymede-testing
    ports:
      - 4803:5432
  ganymede-nginx:
    container_name: ganymede-nginx
    image: nginx
    volumes:
      - /path/to/ganymede/nginx.conf:/etc/nginx/nginx.conf:ro
      - ./vods:/mnt/vods
    ports:
      - 4802:8080

nginx.conf

worker_processes auto;
worker_rlimit_nofile 65535;
error_log  /var/log/nginx/error.log info;
pid        /var/run/nginx.pid;

events {
   multi_accept       on;
   worker_connections 65535;
}

http {

  sendfile on;
  sendfile_max_chunk 1m;
  tcp_nopush on;
  tcp_nodelay on;

  keepalive_timeout 65;
  gzip on;

  server {
    listen 8080;
    root /mnt/vods;

    add_header 'Access-Control-Allow-Origin' '*' always;
    add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS' always;
    add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range' always;
    add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always;

    location ^~ /vods {
      autoindex on;
      alias /mnt/vods;

      location ~* \.(ico|css|js|gif|jpeg|jpg|png|svg|webp)$ {
          expires 30d;
          add_header Pragma "public";
          add_header Cache-Control "public";
     }
      }
}
}

Run docker compose up -d, visit http://YOURIP:4801 and login with user: admin pass: ganymede.

Functionality

Currently, only archiving VODs is supported in the beta no live archiving yet. The admin panel has full functionality for vods, queue, channels, and users. Admin settings are still WIP. Restarting of queue task steps is fully supported.

Known Bugs

• Ublock origin blocks the request to view queue logs (I'm guessing because the route is /log and Ublock has a blanket block on the word log.) Workaround is to disable Ubo for Ganymede.
• When viewing a queue log it sends the whole log file instead of the last 10 lines
• Video and chat player will sometimes not load. Performing a full refresh of the page should load them. I believe this has been fixed when I disabled SSR on the frontend, will further test.

Reporting Bugs

Feel free to drop the issue below as a reply or create a new issue in the repository with logs if applicable.

[Zibbp]

Updates

• Cleanup theme inconsistencies.
• Created application config, routes, and UI elements.
  • Able to set registration status, webhook url, post video ffmpeg params, and chat render params in the frontend and API.
• Webhook notifications.
  • Send notifications for success and errors if the webhook url is set.

[Zibbp]

Bug: Video and chat player instances are still failing to create upon navigating to a VOD. If already on a VOD and refresh the page it will load the players properly.

[Zibbp]

Player bug was found to be an issue where onMounted is being called before the DOM is loaded. Temporary workaround is to timeout the onMounted function by 50ms. Zibbp/ganymede-frontend@258ecc4

Related issue https://github.com/nuxt/framework/issues/3587

[Zibbp]

Updates

• Initial live stream support added.
  • Add a "watched" channel in the admin section.
  • Channels are checked every X minutes against the Twitch API if they are live. (need to allow the interval to be customized).
  • Frontend timeline updates to reflect the changes in "live tasks".

This is the first iteration and will probably break. I'll set some streams to be watched over the weekend and see breaks.

Most likely step to break is the live chat to "vod" chat conversion task.

[Zibbp]

Updates

• Fix: Do not call Twitch API if no live channels are watched.
• Fix: When viewing a log file the last 20 lines are returned. Previously the whole log file was returned which was unintended.
• Feat: Update live stream VOD duration once video download completes.
• Feat: Add a "chat start" time column to the queue table.
  • The time is used as the initial chat message so the chat and video are synced. More info Live stream video chat sync testing #27.
• Feat: Added debug and live_check_interval config options.
  • These can only be changed by editing the config file as they require a container restart.

Release Candidate

The current plan is to have a stable release candidate by the end of the week with all core features.

[Zibbp]

Updates

• Feat: Users can change their password now.
• Feat: Queue "on hold" functionality.
  • By default, but configurable, a max of 2 active queue items can be running at once. Any more are put on a "hold". Once a queue item finishes the next will start. Live streams are not affected by this.
• Feat: Livestream thumbnails are refreshed 30 minutes after the archive process starts.

Currently working on the Ceres to Ganymede migration tool. Plan to have it complete by tomorrow.

[Zibbp]

Release candidate v1 has been released. If you deployed the beta version, please delete all files and re-deploy following the instructions in the README. https://github.com/Zibbp/ganymede/blob/master/README.md

If you're coming from Ceres, take a look at the ganymede-migrate tool for migrating VODs to Ganymede.

[soleny894]

Hi,

First, thanks for your hard work on this, it looks great!

I'll have some time this week-end to work on my server, do you think it's actually stable enough for me to make the switch?

[soleny894]

When you get time, if possible, could you post some log/network requests about the login cookies and the API/Frontend ENV vars relating to host/paths. I have Ganymede deployed in the same way as the README states and have no issues.

It's just an issue that concerns me only because of my current setup. I use nginx-proxy which need envs to auto-generate a nginx configuration. I took the habit of doing 1 container = 1 subdomain which gave me "vods-cdn." and "vods-api." in that case. Since "vods-api." is different than "vods.", the cookie was not working. I used the path routing they added recently and I now have a session cookie.

[Zibbp]

Glad to hear that you got it working. If you have any suggestions for improvements regarding cookies let me know as I'm sure others will use various reverse proxy solutions and will run into this issue.

[soleny894]

If you have any suggestions for improvements regarding cookies let me know as I'm sure others will use various reverse proxy solutions and will run into this issue.

Maybe adding a notice somewhere saying that they need to create a path routing rule to the API from the frontend vhost? Most reverse proxy can do it and it's very simple to do.

Example for nginx:

location /api/ {
    proxy_pass http://<API container name or IP>:4000;
}

[soleny894]

I also have a question. I'll run the script soon to migrate my old vods from Ceres, but one of the streamer I have is currently temporary banned so I can't add it from his Twitch username. If I create his channel manually, will it create any issue while migrating?

[Zibbp]

Manually creating the channel will not cause issues as long as the Ceres login name is used as the Ganymede name and the display name is the same when manually creating the channel.

If any issues do arise you can simply delete the converted Ganymede VODs before enabling the rename function in the migrate script.

[Zibbp]

Closing the Beta discussion as the 1.0 stable release was just released https://github.com/Zibbp/ganymede/releases/tag/v1.0.0.