torrentclaw/unarr
1
0
Fork 0
Code Issues Pull requests Projects Releases 4 Packages Wiki Activity Actions

docs(docker): refresh Docker Hub README + sync description in CI
Some checks failed
Release / release (push) Failing after 0s
Details
Release / docker (push) Has been skipped
Details
Release / virustotal (push) Failing after 0s
Details

Browse source 
- DOCKERHUB.md: update stale 0.3.5 examples to 0.9.0, multi-arch note, mirrors
  section (.com/.to/.onion), point all links to torrentclaw.com (GitHub 404s
  anonymously under the org shadow-ban)
- release.yml: add peter-evans/dockerhub-description step so a tag push also
  syncs the Docker Hub page from DOCKERHUB.md (continue-on-error)
This commit is contained in:
Deivid Soto 2026-05-21 15:56:07 +02:00
parent 2efd5f2764
commit c7af7681a2
2 changed files with 121 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

12
.github/workflows/release.yml vendored
View file

@ -84,6 +84,18 @@ jobs:
build-args: | build-args: |
VERSION=${{ github.ref_name }} VERSION=${{ github.ref_name }}
# Sync the Docker Hub repo description from DOCKERHUB.md. Non-fatal: a
# description-API auth hiccup must not undo a successful image push.
- name: Update Docker Hub description
uses: peter-evans/dockerhub-description@v4
continue-on-error: true
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: torrentclaw/unarr
readme-filepath: ./DOCKERHUB.md
short-description: "unarr — the single binary that replaces your *arr stack"
virustotal: virustotal:
needs: release needs: release

149
DOCKERHUB.md
View file

@ -1,12 +1,20 @@
# unarr # unarr
Powerful terminal tool for torrent search and management. Search 30+ sources, inspect quality, discover popular content, find streaming providers, and manage downloads — all from your terminal. **The single binary that replaces your whole *arr stack.** Search 30+ torrent
sources, inspect real quality before you download, grab subtitles, and manage
your media library — all from one terminal tool or a headless daemon.
**[GitHub](https://github.com/torrentclaw/unarr)** | **[Documentation](https://github.com/torrentclaw/unarr#readme)** | **[Releases](https://github.com/torrentclaw/unarr/releases)** **[Website & docs](https://torrentclaw.com/unarr)** · **[Install guide](https://torrentclaw.com/cli)** · **[Get an API key](https://torrentclaw.com)**
## Quick Start > Powered by [TorrentClaw](https://torrentclaw.com) — an aggregator that unifies
> YTS, EZTV, Knaben, Torrentio, Bitmagnet and more, enriched with TMDB metadata
> and a 0–100 quality score per release.
### 1. Setup (interactive wizard) ---
## Quick start
### 1. First-time setup (interactive wizard)
```bash ```bash
docker run -it --rm \ docker run -it --rm \
@ -14,6 +22,9 @@ docker run -it --rm \
torrentclaw/unarr setup torrentclaw/unarr setup
``` ```
The wizard asks for your TorrentClaw API key (free at
[torrentclaw.com](https://torrentclaw.com)) and your download directory.
### 2. Run the daemon ### 2. Run the daemon
```bash ```bash
@ -26,6 +37,10 @@ docker run -d --name unarr \
torrentclaw/unarr torrentclaw/unarr
``` ```
That's it — `unarr` now runs headless, watching for jobs and managing downloads.
---
## Docker Compose ## Docker Compose
```yaml ```yaml
@ -45,45 +60,54 @@ services:
environment: environment:
- TZ=UTC - TZ=UTC
# - UNARR_API_KEY=tc_your_key_here # - UNARR_API_KEY=tc_your_key_here
network_mode: host # recommended for full P2P performance
deploy: deploy:
resources: resources:
limits: limits:
memory: 512M memory: 512M
cpus: "2.0" cpus: "2.0"
network_mode: host
volumes: volumes:
unarr-data: unarr-data:
``` ```
```bash
docker compose run --rm unarr setup # one-time wizard
docker compose up -d # start the daemon
```
---
## Volumes ## Volumes
| Path | Purpose | | Path | Purpose |
|------|---------| |--------------|--------------------------------------------------|
| `/config` | Configuration file (`config.toml`) | | `/config` | Configuration file (`config.toml`) |
| `/downloads` | Finished media downloads | | `/downloads` | Finished media downloads |
| `/data` | Internal state: torrent metadata, cache | | `/data` | Internal state: torrent metadata, cache |
## Environment Variables ## Environment variables
| Variable | Description | Default | | Variable | Description | Default |
|----------|-------------|---------| |------------------------|--------------------------------------|---------------------------|
| `TZ` | Timezone | `UTC` | | `UNARR_API_KEY` | TorrentClaw API key | from config |
| `UNARR_API_KEY` | TorrentClaw API key | from config | | `UNARR_API_URL` | API endpoint | `https://torrentclaw.com` |
| `UNARR_API_URL` | API endpoint | `https://torrentclaw.com` | | `UNARR_DOWNLOAD_DIR` | Download directory | `/downloads` |
| `UNARR_DOWNLOAD_DIR` | Download directory | `/downloads` | | `UNARR_CONFIG_DIR` | Config directory | `/config` |
| `UNARR_CONFIG_DIR` | Config directory | `/config` | | `UNARR_COUNTRY` | Country code (ISO 3166) | `US` |
| `UNARR_COUNTRY` | Country code (ISO 3166) | `US` | | `TZ` | Timezone | `UTC` |
Any config value can be overridden by its matching `UNARR_*` environment variable.
## Networking ## Networking
**Host mode** (recommended) gives full P2P performance with no port management: **Host mode (recommended)** — full P2P performance, no port mapping:
```yaml ```yaml
network_mode: host network_mode: host
``` ```
**Bridge mode** — more isolated, but requires explicit ports: **Bridge mode** — more isolated, but you must expose the BitTorrent ports:
```yaml ```yaml
ports: ports:
@ -91,7 +115,7 @@ ports:
- "6881-6889:6881-6889/udp" - "6881-6889:6881-6889/udp"
``` ```
## Running Commands ## Running commands
Use `docker exec` for one-off commands while the daemon is running: Use `docker exec` for one-off commands while the daemon is running:
@ -99,32 +123,77 @@ Use `docker exec` for one-off commands while the daemon is running:
docker exec unarr unarr search "inception" --quality 1080p docker exec unarr unarr search "inception" --quality 1080p
docker exec unarr unarr popular --limit 10 docker exec unarr unarr popular --limit 10
docker exec unarr unarr status docker exec unarr unarr status
docker exec unarr unarr doctor docker exec unarr unarr doctor # diagnose config / connectivity
``` ```
## Supported Architectures ---
| Architecture | Tag |
|-------------|-----|
| `linux/amd64` | `latest`, `0.3`, `0.3.5` |
| `linux/arm64` | `latest`, `0.3`, `0.3.5` |
## Tags ## Tags
| Tag | Description | | Tag | Description |
|-----|-------------| |----------|--------------------------------------------------|
| `latest` | Latest stable release | | `latest` | Latest stable release |
| `X.Y.Z` | Specific version (e.g. `0.3.5`) | | `X.Y.Z` | Exact version (e.g. `0.9.0`) |
| `X.Y` | Latest patch for minor version (e.g. `0.3`) | | `X.Y` | Latest patch within a minor (e.g. `0.9`) |
## Image Details Pin a tag in production (`torrentclaw/unarr:0.9.0`) for reproducible deploys.
- **Base image:** Alpine 3.22 ## Supported architectures
- **User:** `unarr` (UID 1000, GID 1000)
Multi-arch image — Docker pulls the right one automatically:
- `linux/amd64`
- `linux/arm64` (Apple Silicon, Raspberry Pi 4/5, ARM servers)
## Image details
- **Base:** Alpine 3.22 (minimal, regularly patched)
- **User:** `unarr` (UID 1000, GID 1000) — runs as **non-root**
- **Entrypoint:** `unarr start` (daemon mode) - **Entrypoint:** `unarr start` (daemon mode)
- **Read-only filesystem** — only mounted volumes are writable - **Read-only rootfs** — only mounted volumes are writable
- **No root required** — runs as non-root by default - **Bundled `ffmpeg` / `ffprobe`** for media inspection — nothing else to install
- **Self-contained updates** — binaries are served from TorrentClaw's own
infrastructure, no third-party registry dependency
---
## Other install methods
Not using Docker? Install the native binary instead:
```bash
# Linux / macOS
curl -fsSL https://torrentclaw.com/install.sh | sh
# Windows (PowerShell)
irm https://torrentclaw.com/install.ps1 | iex
# Go toolchain
go install github.com/torrentclaw/unarr/cmd/unarr@latest
```
## Mirrors
The installer and release binaries are served from every TorrentClaw mirror, so
you can install even if one domain is blocked in your region. Each mirror is
self-contained (it serves its own binaries — no cross-domain dependency):
| Mirror | Install command |
|--------|-----------------|
| `torrentclaw.com` (primary) | `curl -fsSL https://torrentclaw.com/install.sh \| sh` |
| `torrentclaw.to` | `curl -fsSL https://torrentclaw.to/install.sh \| sh` |
| Tor (`.onion`) | `torsocks sh -c "$(curl http://torrentf3aifidcsaaanmnmuhv2s53r6hqsl3zkmfidiaxainkeqk5id.onion/install.sh)"` |
The Tor address routes everything (install script + binaries) through the hidden
service, so no clearnet exit is needed.
## Links
- **Website & docs:** https://torrentclaw.com/unarr
- **CLI install guide:** https://torrentclaw.com/cli
- **API & account:** https://torrentclaw.com
- **Mirror status:** https://torrentclaw.com/mirrors
## License ## License
MIT License — see [LICENSE](https://github.com/torrentclaw/unarr/blob/main/LICENSE) for details. MIT.