Skip to content
Pluvira Docs v1.0.0-alpha.3

Quickstart Guide

Pluvira is designed as a single, lightweight container that runs locally on your home server, NAS appliance, or Raspberry Pi. Follow this guide to deploy Pluvira using Docker or Docker Compose in under two minutes.

1. System Requirements

  • Architecture: linux/amd64 (x86_64) or linux/arm64 (Apple Silicon, Raspberry Pi 4/5).
  • Memory Footprint: Less than 100 MB RAM under active load.
  • Storage Footprint: ~50 MB persistent volume for configuration and SQLite databases.
  • Host Operating System: Linux, Synology DSM 7+, QNAP QTS/QuTS, Unraid, TrueNAS SCALE, Windows/macOS with Docker Desktop.

Create a dedicated directory and save the following docker-compose.yml file:

services:
  pluvira:
    image: ghcr.io/pluvira/app:latest
    container_name: pluvira
    restart: unless-stopped
    ports:
      - "8585:8585"
    tmpfs:
      - /dev/shm/pluvira:rw,size=256M,mode=1777
    volumes:
      - ./data:/app/data
    environment:
      - TZ=UTC
      - PLUVIRA_LOG_LEVEL=INFO

Start the container in the background:

Terminal window
docker compose up -d

3. Standalone Docker Run Command

Alternatively, launch the container directly using docker run:

Terminal window
docker run -d \
  --name pluvira \
  --restart unless-stopped \
  -p 8585:8585 \
  --tmpfs /dev/shm/pluvira:rw,size=256M,mode=1777 \
  -v $(pwd)/data:/app/data \
  -e TZ=UTC \
  ghcr.io/pluvira/app:latest

4. Understanding Volume Mounts & RAM Disk

Pluvira optimizes hardware longevity and eliminates SSD wear through a dual-storage design:

  1. Persistent Data Directory (/app/data):
    • Persists config.yaml, personal playlists, rewrite rules, and local SQLite database files (pluvira_main.db, pluvira_epg.db).
    • Mount this path to your host disk or NAS storage pool.
  2. High-Speed RAM Disk (/dev/shm/pluvira):
    • All raw M3U playlist decompression, EPG parsing, and temporary cache operations execute in RAM.
    • Eliminates disk write wear on SSDs and eMMC flash drives.

5. NAS Deployment Guides

Synology DSM (Container Manager)

  1. Open Container Manager → Project → Create.
  2. Set project name to pluvira, select path (e.g. /docker/pluvira).
  3. Paste the Docker Compose configuration above and click Done.

Unraid

  1. Navigate to the Docker tab → Add Container.
  2. Set Name to pluvira, Repository to ghcr.io/pluvira/app:latest.
  3. Add Port Mapping: Container Port 8585 → Host Port 8585.
  4. Add Path Mapping: Container Path /app/data → Host Path /mnt/user/appdata/pluvira.
  5. Add Extra Parameter: --tmpfs /dev/shm/pluvira:rw,size=256M,mode=1777.

6. Accessing the Web Interface

Once started, open your web browser and navigate to:

http://<YOUR_SERVER_IP>:8585
  1. Onboarding: Select your preferred UI theme and interface language.
  2. Add Playlists: Add your first M3U playlist URL or XMLTV guide.
  3. Curate Channels: Create your custom channel list (“My List”) and enjoy responsive playback.