Get started

Download and install

Install the ZiiX.TV server with Docker in a few minutes, on a NAS, a home server or any Linux machine. Images for amd64 and arm64.

ZiiX.TV is a server you run yourself, with Docker. It runs on Linux on amd64 and arm64: a NAS, a home server, a mini PC or a Raspberry Pi 4/5. Your media files stay where they are; ZiiX.TV only reads them.

1. Make a folder with two files

Make a folder for ZiiX.TV, for example /opt/ziix-tv, and put this docker-compose.yml in it:

services:
  ziix-tv:
    image: ziixeu/ziix-tv:latest
    container_name: ziix-tv
    restart: unless-stopped
    ports:
      - "8470:8470"
    volumes:
      - ./config:/config
      - ${ZIIX_MEDIA:-./media}:/media:ro
      - ${ZIIX_PREVIEWS:-./previews}:/previews
    cap_drop: [ALL]
    cap_add: [CHOWN, FOWNER, DAC_OVERRIDE, SETUID, SETGID]
    security_opt:
      - no-new-privileges:true
    environment:
      PUID: ${PUID:-1000}
      PGID: ${PGID:-1000}
      TZ: ${TZ:-Europe/Copenhagen}
      ZIIX_TMDB_API_KEY: ${ZIIX_TMDB_API_KEY:-}
      ZIIX_TVDB_API_KEY: ${ZIIX_TVDB_API_KEY:-}
      ZIIX_TVDB_PIN: ${ZIIX_TVDB_PIN:-}
      ZIIX_METADATA_LANGUAGE: ${ZIIX_METADATA_LANGUAGE:-en-US}
      ZIIX_SCAN_INTERVAL: ${ZIIX_SCAN_INTERVAL:-15m}
      ZIIX_HWACCEL: ${ZIIX_HWACCEL:-auto}
      ZIIX_PREVIEW_DIR: /previews

Next to it, a file called .env that says where your media is and which user may read it. id on the server shows your user and group numbers.

ZIIX_MEDIA=/path/to/media
PUID=1000
PGID=1000
TZ=Europe/Copenhagen
ZIIX_METADATA_LANGUAGE=en-US

2. Start it

docker compose up -d

Open http://<your server>:8470 in a browser and create the administrator. The first account you create is the administrator of the server.

3. Add your libraries

Under Settings → Libraries, add one library for films and one for series, pointing at their folders under /media. ZiiX.TV scans them straight away. See how to name files and how to add a library.

4. Watch

Watch in the browser, or install an app and link it to your server.

AppWhere
Web browserBuilt in: http://<your server>:8470
Apple TVApp Store (coming soon)
iPhone and iPadApp Store (coming soon)
AndroidGoogle Play (coming soon)
Android TVPlanned

Updating

docker compose pull
docker compose up -d

latest is always the newest release. To stay on one version, use its tag instead, for example ziixeu/ziix-tv:0.9.1. Updates keep your libraries, users and watch history; take a copy of the config folder first all the same.

NVIDIA graphics card

With the NVIDIA driver and the NVIDIA Container Toolkit on the server, ZiiX.TV can convert video on the graphics card. Add a second file, docker-compose.nvidia.yml:

services:
  ziix-tv:
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: all
              capabilities: [gpu]

and start with both files:

docker compose -f docker-compose.yml -f docker-compose.nvidia.yml up -d

More in GPU and transcoding.

Folders

In the containerWhat
/configDatabase and settingsBack it up
/mediaYour films and seriesRead-only is enough
/previewsSeek-bar picturesCan be made again, but that takes hours for a big library

ZiiX.TV starts as root only to hand /config and /previews to PUID:PGID, and then runs as that user without privileges.

Trial and license

A new server runs as a 30-day trial with everything included, no card needed. When you are ready, buy a license under Settings → Server. See pricing.