TrueNAS Scale Walkthrough

This is a quick walkthrough of setting up the Kometa Docker container in the TrueNAS Scale UI.

The TrueNAS Scale UI may differ from these screenshots, but the concepts are the same:

1. Create a container based on the kometateam/kometa image.
2. Set environment variables to control the container's behavior [optional].
3. Point the container to the directory where your configuration files are to be stored.

This walkthrough discusses only the steps required to set up a Kometa container on a TrueNAS Scale NAS. It does not cover creating a config file for Kometa.

There are two walkthroughs for getting familiar with Kometa:

1. Local Python script
2. Docker container

You should go through one of those prior to doing this container setup, as they will familiarize you with the tool and how it works, and will produce the config.yml you will need to use with this process.

Detailed steps

Kometa Installation Walkthrough for TrueNAS Scale

Thanks to i.am.stonecutter on Discord.

This guide provides step-by-step instructions to install Kometa on TrueNAS Scale (Community Edition, version 25.04.0 or later) using a Docker container.

Prerequisites:

1. TrueNAS Scale (version 25.04.0 or later) with internet access
2. Administrative access to TrueNAS Scale
3. 'sudo' privileges for terminal access
4. Plex Media Server installed
5. Basic understanding of Docker and YAML

Setup

Step 1: Sign into TrueNAS Web Interface

1. Log in to the TrueNAS Scale web interface.

   

Step 2: Create Kometa Dataset

1. Navigate to Datasets.

   

2. Create a dataset named kometa using the Apps preset.

   

   

3. Edit the ACL for the kometa dataset to ensure proper permissions for your user setup. Default settings are usually sufficient, but adjust if issues arise.

Step 3: Set Up Config Directory

1. Connect to TrueNAS Scale via SSH.
2. Run sudo mc to launch Midnight Commander.
3. Navigate to the kometa dataset root.
4. Create a folder named config.

5. Copy your config.yml file to the config directory using Midnight Commander.

   

Step 4: Deploy Kometa Docker Container

1. In the TrueNAS web interface, go to Apps > Discover Apps.
2. Click the three-dot menu and select Install via YAML.

3. In the YAML window, set the container name to kometa and use the following docker-compose template, editing the timezone, volume mapping, and UID/GID as needed:

   services:
     kometa:
       image: kometateam/kometa:latest
       environment:
         - TZ=America/New York
         - KOMETA_CONFIG=/config/config.yml
       network
         mode: host
       restart: unless-stopped
       user: "568:568"
       volumes:
         - /mnt/YOUR-STORAGE-POOL/YOUR-DATASET/kometa/config:/config:rw
   

   

4. Deploy the YAML and verify the kometa status shows RUNNING in green.

   

Step 5: Run Kometa

This is an optional step you can perform if you want to fire off a run right this second to verify that things are working. Whether or not you do this, Kometa will wake up tomorrow at 5AM to process the config [assuming you used the docker-compose YAML just above].

1. Return to the TrueNAS Scale SSH session.

2. Execute the following command to force an immediate library refresh based on your config.yml:

   sudo docker run --rm -it -v "/mnt/YOUR-STORAGE-POOL/YOUR-DATASET/kometa/config:/config:rw" kometateam/kometa --run
   

   Of course, replace YOUR-STORAGE-POOL/YOUR-DATASET to suit your specific setup.

Step 6: Verify and Expand

1. Check your Plex library for updated collections.
2. Explore Kometa’s Defaults for pre-made collections.
3. Refer to the Kometa Wiki for advanced configurations.

Troubleshooting

Container not running: Check Docker logs in TrueNAS for errors.

Config issues: Verify config.yml syntax and permissions.

Plex not updating: Confirm Plex URL, token, and network settings.

Notes

The config.yml is portable; adjust paths if moving.

Regularly update the Kometa image via Apps > Update.