Before you startWhat is needed
- QTS 5.x with Container Station 3.x - what the guide was tested on.
- 4 GB of memory or more. The guide names the TS-451+, TS-453D, TS-464 and TS-673A and similar models as comfortable.
- SSH access to the NAS, for the steps below.
No account of any kind is needed to begin. The full guide in the repository: docs/install/qnap.md.
StepsOver SSH: two files and one command
- SSH into the QNAP and become root, make a folder and download the two files.
ssh admin@qnap sudo -i mkdir -p /share/Container/tgarr && cd /share/Container/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 - Fill in
.env. Four values:
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.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 - Start it.
To watch the crawler start:docker compose up -ddocker compose logs -f crawler. - Open
http://<your-host>:8765in 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 wayIn Container Station itself
- Open Container Station → Applications → Create.
- Application Name:
tgarr. - YAML: paste the contents of docker-compose.yml.
- Your values: this way there is no
.envfile, so write them into the YAML - replace${TG_API_ID},${TG_API_HASH},${DB_PASSWORD}and${MEILI_MASTER_KEY}wherever they stand. - Click Validate YAML, then Create.
The guide does not say where Container Station keeps the _data folder of an application made this way. Over SSH you know where it is.
On the diskWhere the files and downloads end up
With the SSH steps, everything tgarr keeps is in /share/Container/tgarr/_data/, beside the two files. The guide suggests a shared folder on an SSD for it: the search index is quicker there.
_data/postgres- the index (PostgreSQL)._data/meili- the search index (Meilisearch)._data/session- the Telegram sign-in. You sign in once._data/downloads- grabbed and opened files. Inside the containers this is/downloads; a grab from Sonarr or Radarr lands in/downloads/tgarr/<release-name>/.
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, over SSH:
cd /share/Container/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.


Sonarr and RadarrOn the same QNAP
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 the QNAP that folder is /share/Container/tgarr/_data/downloads. 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. Put a file named docker-compose.override.yml beside docker-compose.yml:
services:
api:
devices:
- /dev/dri:/dev/driThen docker compose up -d. Docker refuses to start a container that names a card which is not there, so do this only on a machine that has /dev/dri. Settings → Converting films says what is in use. NVIDIA, and the details: docs/install/gpu.md.
If something is offTroubleshooting
- The page does not open. A container did not start. Look at why:
docker logs --tail 50 tgarr-api. - The Dashboard says a newer version is there and nothing happens. Check the updater with
docker ps -a --filter name=tgarr-watchtower. If it saysRestarting, readdocker logs --tail 5 tgarr-watchtower.client version 1.25 is too oldmeans the compose file predates 12 November 2026: download it again. If the message names another version, put the one your Docker accepts (docker versionshows it) in.envasTGARR_DOCKER_API=. - Sonarr's Test on the indexer fails. The address is wrong. On the NAS,
curl "http://localhost:8765/newznab/api?t=caps"should return XML. - A download stays on "downloading". A large file takes time, and Telegram slows large transfers (a
FloodWaitin the log is normal and handled by itself).docker logs --tail 50 tgarr-crawlershows the progress. - The file is there but Sonarr does not import it. Sonarr cannot read the path. See the paragraph on Sonarr and Radarr above.
QuestionsAsked often
Which QNAP models run tgarr?
The guide was tested on QTS 5.x with Container Station 3.x and names the TS-451+, TS-453D, TS-464 and TS-673A and similar models with 4 GB of memory or more as comfortable. The images are published for linux/amd64 and linux/arm64.
Do I need SSH, or is Container Station enough?
Either works. Container Station: Applications, Create, paste the compose file, write your values into the YAML, Validate YAML, Create. The guide calls the SSH way more reliable, and it leaves the files in a folder you chose: /share/Container/tgarr.
Can Sonarr and Radarr on the same QNAP 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 folder 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.