AUTOBRR(1)

📦 version 1.80.0, in alpine 3.24

✨ AUTOBRR(1) ✨

okay so bestie, buckle up — this is the autobrr manual page (it lives in the User Commands section of the man pages, very demure, very official) 💅

🌸 NAME 🌸

autobrr — modern download automation for torrents and usenet, and yes it's as iconic as it sounds 🎀

🦋 SYNOPSIS 🦋

autobrr [--config path]

autobrrctl [--config path] action [options]

two binaries, one vibe. autobrr is the main character, autobrrctl is the sidekick that does the admin stuff ✨

💖 DESCRIPTION 💖

so autobrr is literally a download automation tool — it sits there watching IRC announce channels and RSS feeds, and when it spots content you want, it automatically downloads it from torrent and usenet sources. no cap, it just does that 🫶

the app supports over 75 torrent trackers with IRC announces, plus Newznab, Torznab and RSS feeds. it's giving powerful filtering with RegEx support and a mobile-friendly web UI. honestly? obsessed 😭

👑 OPTIONS 👑

🍓 autobrr options

  • --config=PATH — path to the configuration directory (default: ~/.config/autobrr) 📁

🧚 autobrrctl actions

  • create-user username — makes a brand new user, slay
  • change-password username — changes the password for a user 🔐
  • db:seed — seeds the sqlite database. needs --db-path and --seed-db, no shortcuts bestie
  • db:reset — resets and seeds the sqlite database. also needs --db-path and --seed-db
  • version — displays version information, aka the receipts
  • help — shows the help message 🫶

💜 autobrrctl options

  • --db-path=PATH — path to the database file (for db:seed and db:reset) 💾
  • --seed-db=PATH — path to the SQL seed file (for db:seed and db:reset) 🌱

🔥 FEATURES 🔥

🌈 Download Clients

  • qBittorrent with built-in re-announce and categories 👑
  • Deluge v1+ and v2+
  • rTorrent
  • Transmission
  • Porla
  • SABnzbd
  • Watch Folder support

⭐ Integration

  • Sonarr, Radarr, Lidarr, Whisparr, Readarr support
  • Custom script execution
  • Webhook support
  • Notifications (Discord, Telegram, Notifiarr, Pushover, Gotify) 🦋

🎀 FILES 🎀

  • ~/.config/autobrr/config.toml — default configuration file location. that's where the config lives, iykyk

🌸 ENVIRONMENT 🌸

  • AUTOBRR__HOST — listen address (default: 127.0.0.1)
  • AUTOBRR__PORT — listen port (default: 7474)
  • AUTOBRR__BASE_URL — base URL for reverse proxy (default: /)
  • AUTOBRR__LOG_LEVEL — log level (DEBUG, INFO, WARN, ERROR) (default: INFO)
  • AUTOBRR__DATABASE_TYPE — database type (sqlite/postgres) (default: sqlite)

for a complete list of environment variables, see: https://autobrr.com 👀

💅 EXAMPLES 💅

basic usage with default configuration:

autobrr

using a custom configuration directory:

autobrr --config=/path/to/config

💀 BUGS 💀

report bugs at https://github.com/autobrr/autobrr/issues — they're nice about it, promise 🙈

🫶 AUTHORS 🫶

Ludvig Lundgren and the autobrr contributors ✨

Copyright (C) 2021-2024 Ludvig Lundgren License GPLv2+: GNU GPL version 2 or later

🌈 SEE ALSO 🌈

🌟 EXIT STATUS 🌟

  • 0 — successful program execution. we love a happy ending 💚
  • 1 — usage, syntax or configuration file error. something went wrong bestie 😭
heads up: those exit statuses are literally the whole story — 0 good, 1 bad. no in-between energy 🎀

and that's the page! this autobrr man page (version 2024-03-24) was brought to you by the one and only autobrr — go forth and automate, bestie 💅✨🦋

📦 where this page comes from