Install · TrueNAS Scale

Install tgarr on TrueNAS Scale

On TrueNAS Scale tgarr is installed with docker compose over SSH: two files in a folder on your pool and one command. There is no catalog app yet - one is being prepared. This page is short because the guide is.

Before you startWhat is needed

No account of any kind is needed to begin. The full guide in the repository: docs/install/truenas.md.

StepsTwo files and one command

  1. SSH into TrueNAS, make a folder on your pool and download the two files. Put the name of your pool where it says <pool>.
    ssh root@truenas
    mkdir -p /mnt/<pool>/tgarr && cd /mnt/<pool>/tgarr
    curl -fsSL https://raw.githubusercontent.com/tgarrpro/tgarr/main/docker-compose.yml -o docker-compose.yml
    curl -fsSL https://raw.githubusercontent.com/tgarrpro/tgarr/main/.env.example -o .env
    chmod 600 .env
  2. Fill in .env. Four values:
    TG_API_ID=          # from https://my.telegram.org/apps
    TG_API_HASH=        # from https://my.telegram.org/apps
    DB_PASSWORD=        # a secret of your own: openssl rand -hex 24
    MEILI_MASTER_KEY=   # a secret of your own: openssl rand -hex 32
    The two Telegram values may be left empty: tgarr then asks for them in the browser when they are first needed. The two secrets are yours to make up; do not reuse them elsewhere.
  3. Start it.
    docker compose up -d
  4. Open http://<your-host>:8765 in a browser. To sign in to Telegram, scan the QR code with the Telegram app, or enter your phone number and the code Telegram sends you. Nothing is typed in a terminal, and the code never touches a file.

Another wayThe Custom App form

The repository's guide also walks through Apps → Discover Apps → Custom App, one container at a time. That part was written for an earlier tgarr: it names one tgarr image, and tgarr today is two (tgarr-crawler and tgarr-api, the one that serves port 8765) beside PostgreSQL, Meilisearch and the updater. We do not repeat it here until it has been brought up to date. The compose file is the complete description of what runs.

On the diskWhere the files and downloads end up

Everything tgarr keeps is in /mnt/<pool>/tgarr/_data/, beside the two files:

To keep downloads somewhere else - the folder Sonarr and Radarr import from, say - set TGARR_DOWNLOADS in .env to that path. The port is 8765; TGARR_PORT changes it. If others can reach the port, set TGARR_UI_PASSWORD as well.

UpdatesIt keeps itself up to date

The compose file brings an updater with it: a container named tgarr-watchtower that looks only at tgarr's own two containers - nothing else on the NAS - and checks for a new release every half hour. The index, the settings and the Telegram sign-in are kept. In tgarr, Settings → Updating tgarr has an Update now button. To stay on one version, set TGARR_TAG in .env.

By hand:

cd /mnt/<pool>/tgarr
docker compose pull
docker compose up -d

At homeHow the household reaches it

Every browser at home opens the same address: http://<the-NAS>:8765. Open Media Center & PIN and set a PIN, and every browser that has not entered it gets only the Media Center - films, music, books and photos, and only what you ticked - with time rules for the children if you want them. More on that: a learning library for the family.

tgarr's Media Center: four shelves - Watch, Listen, Read, Photos - and a row of covers
The Media Center on a phone
What the other screens at home get once a PIN is set.

Sonarr and RadarrOn the same TrueNAS

In Sonarr and Radarr: Settings → Indexers → + → Newznab, URL http://<the-NAS>:8765/newznab/ - tgarr's Dashboard shows the exact address, with a Copy button. For grabs from Telegram, add tgarr as a download client too: Settings → Download Clients → + → SABnzbd, same host and port, URL Base /sabnzbd. Sonarr and Radarr must be able to read the finished file: either set TGARR_DOWNLOADS to the folder they import from, or mount tgarr's _data/downloads into their containers as /downloads - then the path is the same on both sides and no remote path mapping is needed. On TrueNAS that folder is /mnt/<pool>/tgarr/_data/downloads. Field by field: tgarr in Sonarr and Radarr.

If something is offTroubleshooting

QuestionsAsked often

Is tgarr in the TrueNAS apps catalog?

Not yet. A community catalog entry is being prepared. Until then tgarr is installed with docker compose over SSH. Releases are announced at github.com/tgarrpro/tgarr/releases.

Which TrueNAS versions does it run on?

The guide was tested on TrueNAS Scale 23.x and 24.x. tgarr needs Docker and docker compose v2; the images are published for linux/amd64 and linux/arm64.

Can Sonarr and Radarr on the same TrueNAS use tgarr?

Yes. Add it in Settings, Indexers as a Newznab indexer with the address tgarr's Dashboard shows (http://your-nas:8765/newznab/), and as a SABnzbd download client with URL Base /sabnzbd. Give Sonarr and Radarr the downloads folder, or point TGARR_DOWNLOADS at the dataset they import from.

Do I need a Telegram account to install it?

Not to begin. The two Telegram values in .env may be left empty; tgarr then asks for them in the browser when they are first needed. The Internet Archive and your own files work with no account of any kind.

How does tgarr update on a NAS?

By itself. The compose file includes an updater that looks only at tgarr's own containers and checks for a new release every half hour. Setting TGARR_TAG in .env keeps it on one version.