# qui

> Modern web interface for qBittorrent

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

## Table of Contents

- [Compatibility](https://getqui.com/docs/advanced/compatibility): :::note
- [Metrics](https://getqui.com/docs/advanced/metrics): Prometheus metrics can be enabled to monitor your qBittorrent instances. When enabled, metrics are served on a **separate port** (default: 9074) wi...
- [API](https://getqui.com/docs/api/overview): Interactive API documentation is available at `/api/docs` using Swagger UI. You can explore all endpoints, view request/response schemas, and test ...
- [Base URL](https://getqui.com/docs/configuration/base-url): If you need to serve qui from a subdirectory (e.g., `https://example.com/qui/`), you can configure the base URL.
- [CLI Commands](https://getqui.com/docs/configuration/cli-commands): Create a default configuration file without starting the server:
- [Environment Variables](https://getqui.com/docs/configuration/environment): Configuration is stored in `config.toml` (created automatically on first run, or manually with `qui generate-config`). You can also use environment...
- [OIDC](https://getqui.com/docs/configuration/oidc): Set `QUI__OIDC_ENABLED=true` to hand authentication off to an external identity provider. The built-in login screen automatically offers a "Sign in...
- [Automations](https://getqui.com/docs/features/automations): Rule-based automation for torrent management.
- [Backups](https://getqui.com/docs/features/backups): Schedule and restore qBittorrent instance backups.
- [autobrr Integration](https://getqui.com/docs/features/cross-seed/autobrr): qui integrates with autobrr through webhook endpoints, enabling real-time cross-seed detection when autobrr announces new releases.
- [Directory Scanner](https://getqui.com/docs/features/cross-seed/dir-scan): Scan local directories and automatically cross-seed completed downloads.
- [Hardlink Mode](https://getqui.com/docs/features/cross-seed/hardlink-mode): Cross-seed using hardlinks or reflinks instead of file renaming.
- [Link Directories](https://getqui.com/docs/features/cross-seed/link-directories): How qui lays out hardlink/reflink trees on disk.
- [Cross-Seed](https://getqui.com/docs/features/cross-seed/overview): Automatically cross-seed torrents across trackers.
- [Rules](https://getqui.com/docs/features/cross-seed/rules): Configure matching behavior in the **Rules** tab on the Cross-Seed page.
- [Troubleshooting](https://getqui.com/docs/features/cross-seed/troubleshooting): Indexers limit how frequently you can make requests. If you see errors like `"indexer TorrentLeech rate-limited until..."`, qui has recorded the co...
- [External Programs](https://getqui.com/docs/features/external-programs): Launch scripts or applications from the torrent context menu.
- [Orphan Scan](https://getqui.com/docs/features/orphan-scan): Find and remove files not associated with any torrent.
- [Reannounce](https://getqui.com/docs/features/reannounce): Automatically fix stalled torrents by reannouncing to trackers.
- [Reverse Proxy](https://getqui.com/docs/features/reverse-proxy): Let external apps access qBittorrent through qui without credentials.
- [Tracker Icons](https://getqui.com/docs/features/tracker-icons): Automatic favicon caching for tracker hosts.
- [Docker](https://getqui.com/docs/getting-started/docker): Run qui in Docker with compose or standalone.
- [Installation](https://getqui.com/docs/getting-started/installation): Install qui on Linux with a single command.
- [Seedbox Installers](https://getqui.com/docs/getting-started/seedbox-installers): One-line installers for popular seedbox providers.
- [Windows](https://getqui.com/docs/getting-started/windows): Install and run qui on Windows as a background service.
- [Introduction](https://getqui.com/docs/intro): Fast, modern interface for qBittorrent with cross-seeding, automations, and backups.
- [Support Development](https://getqui.com/docs/support): Donation options that help fund ongoing qui development.