Hive

YouTube channel archiver

⚠️ Warning ⚠️

This is under active development and should not be used. Only nightly builds will be available for now.

Installation

Docker compose

services:
  hive:
    image: ghcr.io/killbasa/hive:nightly
    restart: unless-stopped
    environment:
      AUTH_SECRET: <secret> # openssl rand -base64 32
      AUTH_ORIGIN: http://localhost:3000
      REDIS_HOST: redis
      REDIS_PORT: 6379
      REDIS_PASSWORD: password
      YT_API_KEY: <secret>
    volumes:
      - hive:/var/lib/hive
    ports:
      - 127.0.0.1:3001:3001
    depends_on:
      - redis
    networks:
      - hive

  web:
    image: ghcr.io/killbasa/hive-web:nightly
    restart: unless-stopped
    environment:
      VITE_API_URL: http://localhost:3001
    ports:
      - 127.0.0.1:3000:3000
    depends_on:
      - hive
    networks:
      - hive

  redis:
    image: redis:7.2.4-alpine3.19
    restart: unless-stopped
    command: ['redis-server', '--requirepass password']
    networks:
      - hive

volumes:
  hive:

networks:
  hive:

Using your own yt-dlp binary

This would be considered advanced usage since Hive already comes with a version of yt-dlp installed, however you could provide your own if you wish.

You can do so by adding the following mount on the hive image:

volumes:
  - /path/to/binary:/hive/bin/yt-dlp:ro

Supported yt-dlp versions

The only version of yt-dlp that is guarateed to work is the version that is bundled in the Docker image. Once this project stabilizes a table specifying the yt-dlp versions support by each Hive release.

Contibuting

1. Download yt-dlp binary

wget https://github.com/yt-dlp/yt-dlp/releases/download/2024.08.06/yt-dlp
chmod +x yt-dlp
mv ./yt-dlp ./apps/api/bin

1. Setup .env files

cp apps/api/.env.example apps/api/.env
cp apps/web/.env.example apps/web/.env

3. Start services

docker compose -f apps/api/compose.yml up -d

4. Build applications

pnpm build

Developing on Mac OS

You'll need to use a virtualization method that supports host mode networking (required by the API nginx).