BorrowArr
Docker app from EverettIV's Repository
Discover movies and TV (TMDb), search indexers, send grabs to download clients, and manage your library.
Overview
Readme
View on GitHubBorrowArr on Unraid
The all-in-one image runs the Next.js UI and Express API in a single container (Dockerfile.all-in-one). Use the Community Apps template in community-apps/ for the Unraid GUI, or run the same layout with Compose.
Docker Hub image (you publish)
From the repo root:
docker build -f Dockerfile.all-in-one -t YOUR_DOCKERHUB_USER/borrowarr:latest .
docker push YOUR_DOCKERHUB_USER/borrowarr:latest
Optional: multi-arch
docker buildx build -f Dockerfile.all-in-one \
--platform linux/amd64 \
-t YOUR_DOCKERHUB_USER/borrowarr:latest \
--push .
The UI discovers the API at http://<same-host-as-browser>:3013 when NEXT_PUBLIC_API_URL is not set at build time — no per-NAS image rebuild.
After publishing, set <Repository> in community-apps/templates/borrowarr.xml to YOUR_DOCKERHUB_USER/borrowarr:latest.
GitHub Actions: see .github/workflows/docker-hub-publish.yml (needs DOCKERHUB_USERNAME and DOCKERHUB_TOKEN secrets).
Manual install on Unraid (Docker template)
Step-by-step sheet: MANUAL-SETUP.md (paths, ports, variables, qBittorrent, troubleshooting).
- Docker → Add Container → paste a custom template, or install from Community Apps after you submit your CA repo.
- Use paths like:
- Appdata →
/app/data - Media share →
/media - Downloads share →
/downloads
- Appdata →
- Publish 3012 (UI) and 3013 (API).
- Add extra parameter:
--add-host=host.docker.internal:host-gatewayif download clients run on the host.
Reference compose (pull only, no build): docker-compose.image.yml.
Community Apps submission
Community Apps expects a dedicated public git repository with files at the repository root, not nested under unraid/.
1. Create borrowarr-unraid (recommended name)
# new empty repo on GitHub, then:
cp -R unraid/community-apps/* /path/to/borrowarr-unraid/
cd /path/to/borrowarr-unraid
Edit templates/borrowarr.xml:
<Repository>→ your Docker Hub image (youruser/borrowarr:latest)<Registry>→https://hub.docker.com/r/youruser/borrowarr<TemplateURL>→ raw URL of this file in this CA repo, e.g.https://raw.githubusercontent.com/EverettIV/borrowarr-unraid/main/templates/borrowarr.xmlca_profile.xmlmust use<CommunityApplications>(not legacy<Maintainer>) and a descriptive<Profile>— see Repository Info XML.
2. Add support links
Before submit, add an Unraid forums support thread (optional but common) and put the URL in <Support> if you prefer forums over GitHub issues.
3. Submit
- Push the public CA repo.
- Open ca.unraid.net/submit/new.
- Enter the repo URL → Validate → Scan → submit.
Docs: Community Apps starter · Submission help
Icon
Canonical artwork: data/borrowarr-icon-circle-no-bg.png (circle, transparent). A copy ships in unraid/community-apps/icon.png for the CA repo bundle — refresh it after updating the data/ file:
cp data/borrowarr-icon-circle-no-bg.png unraid/community-apps/icon.png
Keeping in sync
When you change unraid/community-apps/templates/borrowarr.xml in the main BorrowArr repo, copy updates into your borrowarr-unraid repo (or automate with a small release script).
Optional: nested local clone
You can keep the CA repo inside the app tree as its own git checkout (parent .gitignore lists /borrowarr-unraid/):
cd /path/to/borrowarr
git clone https://github.com/EverettIV/borrowarr-unraid.git borrowarr-unraid # once
./scripts/sync-unraid-ca.sh
cd borrowarr-unraid && git add -A && git commit -m "Sync CA template" && git push
GitHub still has two repos; only your laptop stores them in one folder.
Ports and paths
| Host port | Service |
|---|---|
| 3012 | Web UI |
| 3013 | API |
| Container path | Purpose |
|---|---|
/app/data |
SQLite + JWT |
/media |
movies/, tv/ |
/downloads |
movies/, tv/ for clients |
Set BORROWARR_ENSURE_MEDIA_DIRS=true only if you want the app to create those folders on startup.
Categories
Download Statistics
Related apps
Explore more like this
Explore allLinks
Details
everettiv/borrowarr:latestRuntime arguments
- Web UI
http://[IP]:[PORT:3012]/- Network
bridge- Shell
sh- Privileged
- false
- Extra Params
--add-host=host.docker.internal:host-gateway
Template configuration
BorrowArr web interface
- Target
- 3012
- Default
- 3012
- Value
- 3012
BorrowArr API (browser uses same host as UI on this port)
- Target
- 3013
- Default
- 3013
- Value
- 3013
SQLite database and JWT secrets
- Target
- /app/data
- Default
- /mnt/user/appdata/borrowarr
- Value
- /mnt/user/appdata/borrowarr
Library root (movies/ and tv/ subfolders)
- Target
- /media
- Default
- /mnt/user/media
- Value
- /mnt/user/media
Download client root (movies/ and tv/ subfolders)
- Target
- /downloads
- Default
- /mnt/user/downloads
- Value
- /mnt/user/downloads
Env: library root inside container
- Default
- /media
- Value
- /media
Env: downloads root inside container
- Default
- /downloads
- Value
- /downloads
Create media/download folders on startup if missing (set true on fresh install)
- Default
- false
- Value
- false
SQLite file path
- Default
- /app/data/database.sqlite
- Value
- /app/data/database.sqlite
- Default
- production
- Value
- production
Internal API listen port
- Default
- 3013
- Value
- 3013
Internal UI listen port
- Default
- 3012
- Value
- 3012
Optional TMDb v3 API key
Optional TMDb read access token