# autobrr

> The modern autodl-irssi replacement.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Cross-seed with autobrr](https://autobrr.com/3rd-party-tools/cross-seed): Cross-seed tools that work with autobrr: qui for qBittorrent with built-in support, plus cross-seed and other third-party options.
- [Manage torrents automatically alongside autobrr](https://autobrr.com/3rd-party-tools/manage-torrents): Third-party tools that manage torrents in your client by seed time, ratio and tracker rules, and how they fit together with autobrr.
- [seasonpackarr: hardlink episodes into season packs](https://autobrr.com/3rd-party-tools/seasonpackarr): seasonpackarr is an autobrr companion that hardlinks already downloaded episodes into a season pack folder so you avoid re-downloading them.
- [Sizechecker: stop downloads when disk is full](https://autobrr.com/3rd-party-tools/sizechecker): Sizechecker is an autobrr companion that rejects new downloads when used or free disk space crosses a limit, with Discord and webhook notifications.
- [Upgraderr: upgrade, deduplicate and cross-seed](https://autobrr.com/3rd-party-tools/upgraderr): Upgraderr parses release titles to upgrade existing downloads, remove duplicates and cross-seed, with no configuration required.
- [autobrr REST API reference](https://autobrr.com/api): Reference for the autobrr REST API: authenticating with API keys, the endpoint documentation and examples for integrating autobrr with your own tools.
- [Community](https://autobrr.com/community): Where to find the autobrr community; a Discord server with over 5,500 members and an IRC server at irc.autobrr.com.
- [Authentication methods](https://autobrr.com/configuration/authentication): How authentication works in autobrr: the built-in username and password login and OpenID Connect (OIDC) single sign-on, and how to configure each.
- [Configure autobrr with config.toml](https://autobrr.com/configuration/autobrr): Every setting in autobrr's config.toml explained: host, port, base URL, log level, database, session, OIDC and update checks, with defaults and exa...
- [Set up download clients in autobrr](https://autobrr.com/configuration/download-clients/dedicated): Add qBittorrent, Deluge, rTorrent, Transmission, Porla, aria2, SABnzbd, NZBGet, Sonarr, Radarr, Lidarr, Readarr and Whisparr as clients in autobrr.
- [Connecting to download clients on a shared seedbox](https://autobrr.com/configuration/download-clients/shared-seedboxes): Confirmed connection settings for download clients on shared seedbox providers, so autobrr can reach qBittorrent, Deluge, rTorrent and Transmission.
- [RSS, Torznab and Newznab feeds](https://autobrr.com/configuration/feeds): Add RSS, Torznab and Newznab feeds as indexers in autobrr for trackers without an IRC announce channel, including polling interval and filter setup.
- [Add indexers and trackers to autobrr](https://autobrr.com/configuration/indexers): How to add a tracker to autobrr: pick it from the supported indexer list, enter your passkey or credentials, and connect its IRC announce channel.
- [IRC networks and announce channels](https://autobrr.com/configuration/irc): Set up IRC in autobrr: register a nick with NickServ, add a network, join announce channels, use SASL or a ZNC bouncer, and troubleshoot connections.
- [Notifications for pushes and errors](https://autobrr.com/configuration/notifications): Send autobrr notifications to Discord, Notifiarr, Telegram, Pushover, Gotify, ntfy, LunaSea, Shoutrrr or a webhook on push, error and IRC events.
- [Proxies for indexers and IRC](https://autobrr.com/configuration/proxy): Route autobrr's torrent downloads, indexer API calls, feeds and IRC connections through a SOCKS5 or HTTP proxy, per indexer or per network.
- [Contributing to autobrr](https://autobrr.com/contributing): How to contribute to autobrr: discuss larger changes first, set up the Go and React development environment, run the tests and open a pull request.
- [autobrr FAQ](https://autobrr.com/faqs): Answers to common autobrr questions: indexers not joining announce channels, releases not matching, Deluge in Docker, multiple filters and password...
- [Filter actions](https://autobrr.com/filters/actions): Filter actions decide what autobrr does with a match: send to qBittorrent, Deluge, rTorrent, Transmission, Porla, Sonarr and Radarr, or run a scrip...
- [Advanced filters: regex match and except](https://autobrr.com/filters/advanced): Advanced filter fields in autobrr: regex match and except rules on release names, descriptions, tags and uploaders, using Go regex syntax.
- [Category examples by tracker](https://autobrr.com/filters/categories): Tracker category names to use in autobrr filters, contributed by users, with instructions for exporting categories from autobrr.db.
- [Cross-seed with qui](https://autobrr.com/filters/cross-seed-qui): Set up automatic cross-seeding with autobrr and qui: connect qui's webhook endpoint so new announces are matched against your qBittorrent library.
- [Filter examples for Sonarr, Radarr and racing](https://autobrr.com/filters/examples): Ready-made autobrr filter examples for Sonarr and Radarr, plus filters for building buffer and ratio on private trackers.
- [External filters: scripts and webhooks](https://autobrr.com/filters/external): External filters run a script or call a webhook before autobrr pushes a release, and only continue when the expected exit or HTTP status matches.
- [Freeleech support by indexer](https://autobrr.com/filters/freeleech): Which indexers in autobrr announce freeleech so you can filter on it. Not every tracker includes freeleech in its announce; this table shows which do.
- [General filter settings](https://autobrr.com/filters/general): Every field on the General tab of an autobrr filter: name, indexers, announce type, priority, delay, max downloads and skip duplicates profile.
- [Filters: how autobrr decides what to grab](https://autobrr.com/filters): Filters are the conditions every announce is checked against. Learn how filters, actions and indexers fit together before building your first one.
- [Lists: build filters from Sonarr, Radarr, Trakt and more](https://autobrr.com/filters/lists): Lists transforms items monitored by arrs or lists into autobrr filters. Useful for automating your filters for monitored media or racing criteria.
- [Macros for actions and external filters](https://autobrr.com/filters/macros): Macros inject release data into actions and external filters using variables like {{ .TorrentName }}, {{ .Indexer }} and {{ .Resolution }}.
- [Music filters](https://autobrr.com/filters/music): Music filter fields in autobrr: artists, albums, format, quality, media, log score, cue, perfect FLAC, record labels and release type.
- [Omegabrr](https://autobrr.com/filters/omegabrr): Omegabrr transforms items monitored by arrs or lists into autobrr filters. Useful for automating your filters for monitored media or racing criteria.
- [Skip duplicates](https://autobrr.com/filters/skip-duplicates): How autobrr's Skip Duplicates feature and duplicate profiles work: which release attributes are compared and how to stop grabbing the same content ...
- [TV and movie filters](https://autobrr.com/filters/tv-movies): TV and movie filter fields in autobrr: seasons, episodes, years, resolutions, sources, codecs, containers, HDR and wildcard matching.
- [Install autobrr with Docker](https://autobrr.com/installation/docker): Run autobrr with Docker Compose: the compose file, config volume, port mapping, logging and notes for unRAID and Portainer.
- [Installation instructions](https://autobrr.com/installation/intro): An overview of the ways to install autobrr; on a shared seedbox, a Linux server, Docker, macOS or Windows, with pointers to reverse proxy and datab...
- [Install autobrr on Linux](https://autobrr.com/installation/linux): Install autobrr on a Linux server manually with a systemd service, or through seedbox solutions like Swizzin, Saltbox and QuickBox.
- [Install autobrr on macOS](https://autobrr.com/installation/macos): Install autobrr on macOS with Homebrew and run it as a background service under a dedicated user, so no terminal window has to stay open.
- [Caddy reverse proxy for autobrr](https://autobrr.com/installation/reverse-proxy/caddy): Caddyfile examples for running autobrr behind Caddy on a subdomain or a subfolder, including the matching base URL setting.
- [Reverse proxy overview](https://autobrr.com/installation/reverse-proxy): Why and how to run autobrr behind a reverse proxy, with configuration guides for Caddy, lighttpd, nginx, SWAG, Traefik and Tailscale Serve.
- [lighttpd reverse proxy for autobrr](https://autobrr.com/installation/reverse-proxy/lighttpd): lighttpd mod_proxy example for running autobrr behind lighttpd on a subfolder, including the matching base URL setting.
- [Nginx reverse proxy for autobrr](https://autobrr.com/installation/reverse-proxy/nginx): Nginx location and server block examples for running autobrr behind Nginx on a subfolder or subdomain, with forwarded headers and basic auth.
- [SWAG reverse proxy for autobrr](https://autobrr.com/installation/reverse-proxy/swag): SWAG (LinuxServer nginx) configuration for autobrr on a subdomain, with optional LDAP, Authelia or Authentik authentication.
- [Tailscale Serve as a reverse proxy for autobrr](https://autobrr.com/installation/reverse-proxy/tailscale-serve): Expose autobrr over your tailnet with Tailscale Serve, which gives you HTTPS and a stable hostname without opening ports or running a separate proxy.
- [Traefik reverse proxy for autobrr](https://autobrr.com/installation/reverse-proxy/traefik): Docker Compose labels for running autobrr behind Traefik on a subdomain, with an external proxy network and http and https entry points.
- [Install autobrr on a shared or dedicated seedbox](https://autobrr.com/installation/seedbox): Install autobrr on a dedicated server or a shared, non-root seedbox from Ultra.cc, Whatbox, Seedhost, HostingBy.Design, Feral, Bytesized, Giga-Rapi...
- [Setup autobrr with PostgreSQL](https://autobrr.com/installation/supplementary/postgresql): Run autobrr on PostgreSQL instead of the bundled SQLite: when it makes sense, the config.toml settings and how to migrate an existing database.
- [Transfer your installation](https://autobrr.com/installation/supplementary/transfer-installation): Move an autobrr installation to another host while keeping filters, indexers, IRC networks, feeds, clients, notifications and API keys.
- [Install autobrr on Windows](https://autobrr.com/installation/windows): A guide on how to install autobrr on Windows. In this setup we will create an autobrr user and a Windows service that operates in the background.
- [Introduction](https://autobrr.com/introduction): autobrr is a modern download automation tool and autodl-irssi replacement: it watches IRC announces and feeds, filters releases and pushes them to ...
- [autobrr quick start](https://autobrr.com/quick-start): Get autobrr running end to end: add an indexer and its IRC network, build a filter, connect Sonarr as the action and verify the first push.
- [Support Development](https://autobrr.com/support): Ways to support autobrr development: GitHub Sponsors, Buy Me a Coffee and Ko-Fi donations that help fund the project.
- [Account settings](https://autobrr.com/usage/account): Change your autobrr username and password from the Account settings page. You will need to log in again after saving.
- [Search releases](https://autobrr.com/usage/search): The Releases tab will show you every matched and rejected release. You can search through this list by typing your query and/or with selected keywo...
- [Tips for running autobrr](https://autobrr.com/usage/tips): Practical autobrr tips: stop grabs when disk space runs low, enable and download logs, and troubleshoot filters with the autobrr.log file.