Skip to content

Install on Unraid

Run Tuvima Library with persistent Unraid shares and a browser Dashboard. Allow 10–20 minutes for configuration, plus image and optional model downloads.

Tuvima Library uses the published ghcr.io/tuvima/tuvima-library:latest image. If the NAS cannot download it, use the local source-build path, including its local image tag and no-pull start command.

Use the maintained Compose file

  1. Follow the Docker Compose guide to download the full configuration.

  2. Replace every host path with a real Unraid share path.

  3. Keep all seven mappings: /library, /config, /db, /models, /artwork-cache, /backups, and /transcode.

  4. Set TUVIMA_UID=99 and TUVIMA_GID=100 for the usual nobody:users identity, or use the actual owner of your shares.

  5. Set TZ and the Dashboard origin used by your devices.

  6. If the registry image is accessible, start through a Compose-capable manager, or run these commands in the deployment directory:

    Terminal window
    docker compose config --quiet
    docker compose pull
    docker compose up -d
    docker compose ps

The repository also contains an Unraid template. Import it through a compatible template workflow if you prefer that approach. Its presence in the repository does not guarantee listing in Community Applications.

Check share permissions

The configured user/group needs write access to managed media and every application folder. It needs only read access to an existing protected library.

Keep originals in a separate read-only mapping and add them as a Read-only folder. Do not use the managed /library mapping for originals Tuvima must never change.

If a path is not writable, repair share ownership or ACLs. Do not enable privileged mode to bypass a permission error.

Complete setup

  1. Wait for tuvima-library to report healthy.
  2. Open http://UNRAID-IP:5016/setup.
  3. Create the administrator and save recovery codes outside the server.
  4. Create, download, and test a recovery point in Settings → Manage → System → Backup and recovery.

Only Dashboard port 5016 is published. Leave Engine port 61495 internal.

Claim your server

First-run setup is open to any device that can reach the server until the first administrator exists, so finish it before you open any router port.

  • Open /setup from any device on your home network. No setup code is needed.
  • Once the administrator exists, setup closes for good.

Next steps