Install · Unraid

Install tgarr on Unraid

On Unraid tgarr is installed as a stack in the Compose Manager plugin: paste the compose file, fill in four values, press Compose Up. It is not in Community Apps yet - a template has been submitted. Afterwards it is an indexer for Sonarr and Radarr and a media center for the household.

Before you startWhat is needed

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

StepsA stack in Compose Manager

  1. Install the Compose Manager plugin from Unraid Community Apps, if it is not there already.
  2. Compose tab → Add New Stack. Name it tgarr.
  3. Edit stack and paste the contents of docker-compose.yml.
  4. Edit stack → the "Environment Variables" tab. Paste from .env.example and fill in the 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.
  5. Click Compose Up in the Compose tab.
  6. 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.

On the diskWhere the files and downloads end up

The compose file keeps everything in a folder named _data beside itself - that is, in the stack's folder. The guide does not say where Compose Manager puts that folder; look before the first start, because the database and the Telegram sign-in will live there. It suggests keeping _data/ on the cache pool, which makes the crawler faster. Downloads can be sent to a share of your choice with TGARR_DOWNLOADS in the environment variables.

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.

The guide gives no other way for Unraid; none is needed while the updater runs.

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 Unraid server

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 Unraid, set TGARR_DOWNLOADS to the share Sonarr and Radarr already see. Field by field: tgarr in Sonarr and Radarr.

OptionalConverting films on the graphics card

A film the browser cannot play is converted while it is watched. Intel graphics from 2015 on can do that for a fraction of a processor core, and tgarr uses the card by itself once its container is given one. For the api service that is one more entry, devices: - /dev/dri:/dev/dri; where a container is set up in the system's own pages it is the "device" or "extra parameters" setting, --device /dev/dri. Docker refuses to start a container that names a card which is not there. Settings → Converting films says what is in use. NVIDIA, and the details: docs/install/gpu.md.

If something is offTroubleshooting

QuestionsAsked often

Is tgarr in Unraid Community Apps?

Not yet. A template has been submitted; until it is accepted, install tgarr as a stack in the Compose Manager plugin. Releases are announced at github.com/tgarrpro/tgarr/releases.

What does tgarr need on Unraid?

Unraid 6.12 or later, the Compose Manager plugin, 4 GB of memory or more and 10 GB or more of array or cache space, plus room for what you download.

Can Sonarr and Radarr on the same Unraid server use tgarr?

Yes. Add it in Settings, Indexers as a Newznab indexer with the address tgarr's Dashboard shows (http://your-server:8765/newznab/), and as a SABnzbd download client with URL Base /sabnzbd. Set TGARR_DOWNLOADS to a share Sonarr and Radarr can read.

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.