# upbrr

> Prepare, review, and submit private-tracker uploads

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

## Table of Contents

- [API reference](https://upbrr.com/docs/api/): Authenticate to the versioned release-workflow API, choose token scopes, and use the embedded OpenAPI documentation.
- [CLI reference](https://upbrr.com/docs/cli/): Commands, interaction modes, aliases, and upload preparation flags supported by upbrr.
- [Configuration](https://upbrr.com/docs/configuration/): Where upbrr stores state, how setting groups map to behavior, and how to import or export configuration.
- [Web server and reverse proxy](https://upbrr.com/docs/configuration/web-server): Configure the embedded Web UI listener, environment variables, browse policy, and reverse proxy base path.
- [Contributing and support](https://upbrr.com/docs/contributing): Report issues safely, discuss changes, and run repository checks for documentation contributions.
- [Installation](https://upbrr.com/docs/getting-started/installation): Install upbrr from a release binary or Docker image and provide FFmpeg.
- [Migrate from Upload Assistant](https://upbrr.com/docs/getting-started/migrate-from-upload-assistant): Import an Upload Assistant config.py directly or convert it to reviewable YAML first.
- [Quick start](https://upbrr.com/docs/getting-started/quick-start): Start the Web UI, complete first-run setup, configure services, and prepare a safe first upload.
- [Upgrading](https://upbrr.com/docs/getting-started/upgrading): Back up upbrr state, replace the binary or image, and verify automatic database migration.
- [Introduction](https://upbrr.com/docs/introduction): What upbrr does, who it is for, and where operator review remains essential.
- [Trackers](https://upbrr.com/docs/trackers/): Configure tracker credentials, authentication, default selection, duplicate checks, and tracker-specific review.
- [Troubleshooting](https://upbrr.com/docs/troubleshooting/): Diagnose startup, browse access, reverse proxy, FFmpeg, tracker auth, image, and unattended workflow failures.
- [Web UI](https://upbrr.com/docs/web-ui/): Navigate the embedded browser workflow, settings, history, logging, and host browse access.
- [Logging](https://upbrr.com/docs/web-ui/logging): Configure runtime logging and use the Web UI live log viewer.
- [API Tokens](https://upbrr.com/docs/web-ui/settings/api-tokens): Create least-privilege bearer tokens, preserve the one-time secret, and revoke access.
- [Application Details](https://upbrr.com/docs/web-ui/settings/application-details): Read build, platform, FFmpeg capability, and uptime diagnostics from the running instance.
- [Arr settings](https://upbrr.com/docs/web-ui/settings/arr): Enrich prepared releases through one or more Sonarr and Radarr instances.
- [Client Handling settings](https://upbrr.com/docs/web-ui/settings/client-handling): Select which configured torrent clients are used by default, for search, and for injection.
- [Description settings](https://upbrr.com/docs/web-ui/settings/description): Configure shared description artwork, screenshot layout, headers, episode text, and signatures.
- [Image Hosting settings](https://upbrr.com/docs/web-ui/settings/image-hosting): Order image-upload hosts and configure only the credentials each selected host needs.
- [Settings](https://upbrr.com/docs/web-ui/settings/): Save, reload, import, and verify every section of the Web UI Settings page.
- [Main settings](https://upbrr.com/docs/web-ui/settings/main): Configure metadata access, input history, tracker icons, and scene detection.
- [Metadata settings](https://upbrr.com/docs/web-ui/settings/metadata): Control torrent discovery, tracker-data lookup, and Blu-ray metadata matching.
- [Post Upload settings](https://upbrr.com/docs/web-ui/settings/post-upload): Configure client-injection delay and concurrent tracker submissions.
- [Screens settings](https://upbrr.com/docs/web-ui/settings/screens): Configure screenshot counts, partial image-upload success, tone mapping, overlays, and concurrency.
- [Torrent Clients settings](https://upbrr.com/docs/web-ui/settings/torrent-clients): Configure qBittorrent, qui proxy, watch-folder, staging-link, and path-mapping behavior.
- [Torrent-Specific settings](https://upbrr.com/docs/web-ui/settings/torrent-specific): Prefer reusable torrents with smaller pieces and delay rehash-dependent submissions.
- [Tracker Auth](https://upbrr.com/docs/web-ui/settings/tracker-auth): Manage encrypted tracker cookies, remote validation, automatic relogin, and 2FA state.
- [Trackers settings](https://upbrr.com/docs/web-ui/settings/trackers): Add supported trackers, choose defaults, and configure tracker-owned credentials and upload options.
- [Upload workflow](https://upbrr.com/docs/workflow/): How upbrr turns one source into reviewed tracker operations and registered torrent artifacts.