### Install qui on HostingByDesign

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/seedbox-installers.md

Use this command to download, make executable, and run the installer script for HostingByDesign.

```bash
wget -O installer.sh https://get.autobrr.com/qui/hostingbydesign && chmod +x installer.sh && ./installer.sh
```

--------------------------------

### Install qui on Whatbox

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/seedbox-installers.md

Use this command to download, make executable, and run the installer script for Whatbox.

```bash
wget -O installer.sh https://get.autobrr.com/qui/whatbox && chmod +x installer.sh && ./installer.sh
```

--------------------------------

### Install qui on Bytesized

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/seedbox-installers.md

Use this command to download, make executable, and run the installer script for Bytesized. Note: This installer has not been tested.

```bash
wget -O installer.sh https://get.autobrr.com/qui/bytesized && chmod +x installer.sh && ./installer.sh
```

--------------------------------

### Install qui on Ultra.cc

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/seedbox-installers.md

Use this command to download, make executable, and run the installer script for Ultra.cc.

```bash
wget -O installer.sh https://get.autobrr.com/qui/ultra && chmod +x installer.sh && ./installer.sh
```

--------------------------------

### Install qui on Seedhost

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/seedbox-installers.md

Use this command to download, make executable, and run the installer script for Seedhost.

```bash
wget -O installer.sh https://get.autobrr.com/qui/seedhost && chmod +x installer.sh && ./installer.sh
```

--------------------------------

### Qui Configuration File Example

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/reference.md

Example `config.toml` file demonstrating various settings for Qui, including host, port, logging, and external program allowlist.

```toml
host = "0.0.0.0"
port = 7476
baseUrl = "/qui/"

logLevel = "INFO"
logPath = "log/qui.log"
logMaxSize = 50
logMaxBackups = 3

trackerIconsFetchEnabled = false

externalProgramAllowList = [
  "/usr/local/bin",
  "/home/user/bin/my-script",
]
```

--------------------------------

### Start qui Service

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/windows.md

Run the qui executable to start the service for the first time. This generates default configuration files and prompts for account creation.

```powershell
.\qui.exe serve
```

--------------------------------

### Install qui on Feral Seedbox

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/seedbox-installers.md

Use this command to download, make executable, and run the installer script for Feral.

```bash
wget -O installer.sh https://get.autobrr.com/qui/feral && chmod +x installer.sh && ./installer.sh
```

--------------------------------

### Start qui with Docker Compose (Postgres)

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/docker.md

Command to start qui and its PostgreSQL database using a specific Docker Compose file.

```bash
docker compose -f docker-compose.postgres.yml up -d
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/autobrr/qui/blob/develop/documentation/README.md

Installs all necessary project dependencies using pnpm. Run this command in the project root.

```bash
pnpm install
```

--------------------------------

### Make qui Executable and Run

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/installation.md

Makes the qui binary executable and then starts the qui server. The web interface will be accessible at http://localhost:7476.

```bash
# Make it executable (Linux/macOS)
chmod +x qui

# Run
./qui serve
```

--------------------------------

### Start Local Development Server

Source: https://github.com/autobrr/qui/blob/develop/documentation/README.md

Starts a local development server for live previewing changes. The server automatically reloads most modifications without requiring a manual restart.

```bash
pnpm start
```

--------------------------------

### OIDC Redirect URL for Default Install

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/oidc.md

Use this format for the OIDC redirect URL when qui is installed by default.

```bash
http://localhost:7476/api/auth/oidc/callback
```

--------------------------------

### Start qui with Docker Compose

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/docker.md

Command to start the qui service in detached mode using Docker Compose.

```bash
docker compose up -d
```

--------------------------------

### Example OIDC Configuration

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/oidc.md

Set environment variables to enable and configure OIDC authentication with your identity provider.

```bash
QUI__OIDC_ENABLED=true \
QUI__OIDC_ISSUER=https://auth.example.com/realms/main \
QUI__OIDC_CLIENT_ID=qui \
QUI__OIDC_CLIENT_SECRET=super-secret-value \
QUI__OIDC_REDIRECT_URL=https://qui.example.com/api/auth/oidc/callback \
QUI__OIDC_DISABLE_BUILT_IN_LOGIN=true
```

--------------------------------

### Example Arguments with Torrent Placeholders

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/external-programs.md

Construct command-line arguments using placeholders that qui substitutes with torrent metadata before execution. Shell-style quoting is used for parsing arguments.

```text
"{hash}" "{name}" --save "{save_path}" --category "{category}" --tags "{tags}"
```

```text
D:\Upload Assistant\upload.py {save_path}\\{name}
```

--------------------------------

### Navigate to qui Directory

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/windows.md

Change the current directory to the qui installation folder. This is a prerequisite for running qui commands.

```powershell
cd C:\qui
```

--------------------------------

### Install qui on Linux x86_64

Source: https://github.com/autobrr/qui/blob/develop/README.md

Download, extract, and run the latest qui release on Linux. The web interface will be available at http://localhost:7476.

```bash
# Download and extract the latest release
wget $(curl -s https://api.github.com/repos/autobrr/qui/releases/latest | grep browser_download_url | grep linux_x86_64 | cut -d" -f4)
tar -C /usr/local/bin -xzf qui*.tar.gz

# Run
./qui serve
```

--------------------------------

### Complete Reverse Proxy URL Example

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/reverse-proxy.md

This is the format for the complete URL to use when configuring external applications to connect to qBittorrent via qui's reverse proxy. Ensure you replace the placeholder API key with your actual generated key.

```text
http://localhost:7476/proxy/abc123def456ghi789jkl012mno345pqr678stu901vwx234yz
```

--------------------------------

### Update Application

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/cli-commands.md

Update the qui installation to the latest available version using the `update` command.

```bash
# Update to the latest version
./qui update
```

--------------------------------

### Generate Default Configuration File

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/cli-commands.md

Create a default configuration file in the OS-specific default location or a custom directory. This command does not start the server.

```bash
# Generate config in OS-specific default location
./qui generate-config
```

```bash
# Generate config in custom directory
./qui generate-config --config-dir /path/to/config/
```

```bash
# Generate config with custom filename
./qui generate-config --config-dir /path/to/myconfig.toml
```

--------------------------------

### Execute External Program via REST API

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/external-programs.md

This example shows how to trigger an external program execution using the qui backend API. It requires program and instance IDs, along with a list of torrent hashes. The endpoint is fire-and-forget.

```http
POST /api/external-programs/execute
Content-Type: application/json

{
  "program_id": 2,
  "instance_id": 1,
  "hashes": ["c0ffee...", "deadbeef..."]
}
```

--------------------------------

### Skipped Scan Response Example

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/dir-scan.md

Example response when a webhook is accepted but a scan is skipped due to filters, such as an disallowed download client.

```json
{"skipped": true, "reason": "download client not allowed"}
```

--------------------------------

### Successful Scan Response Example

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/dir-scan.md

Example of a successful response when a scan is accepted. Includes run ID, directory ID, directory path, and the determined scan root.

```json
{"runId": 42, "directoryId": 3, "directoryPath": "/data/media/tv", "scanRoot": "/data/media/tv/Show Name"}
```

--------------------------------

### Run qui with Docker

Source: https://github.com/autobrr/qui/blob/develop/README.md

Deploy qui using Docker, mapping the port and mounting a volume for configuration.

```bash
docker run -d \
  -p 7476:7476 \
  -v $(pwd)/config:/config \
  ghcr.io/autobrr/qui:latest
```

--------------------------------

### Serve Application with Custom Directories

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/cli-commands.md

Configure the `serve` command to use custom directories for configuration and data files.

```bash
# Specify config directory (config.toml will be created inside)
./qui serve --config-dir /path/to/config/
```

```bash
# Specify data directory for database and other data files
./qui serve --data-dir /path/to/data/
```

--------------------------------

### Create Initial User Account

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/cli-commands.md

Create the initial user account for the system. Passwords must be at least 8 characters long. Interactive prompts use secure input.

```bash
# Create initial user account
./qui create-user --username admin --password mypassword
```

```bash
# Create user with prompts (secure password input)
./qui create-user --username admin
```

```bash
# Pipe passwords for scripting (works with both commands)
echo "mypassword" | ./qui create-user --username admin
```

--------------------------------

### Enable Debug Logging for Qui

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/season-packs.md

Configure Qui to log at the DEBUG level to get more detailed information for troubleshooting.

```toml
loglevel = 'DEBUG'
```

--------------------------------

### Direct Simple Mode Webhook Call

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/dir-scan.md

Example of calling the webhook directly with a JSON payload containing the path. Useful for scripts or other tools.

```bash
curl -X POST "http://localhost:7476/api/dir-scan/webhook/scan?apikey=YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"path": "/data/media/movies/Movie Name (2024)"}'
```

--------------------------------

### Server Environment Variables

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/environment.md

Set the listen address, port, and optional base URL for the server.

```bash
QUI__HOST=0.0.0.0        # Listen address
QUI__PORT=7476           # Port number
QUI__BASE_URL=/qui/      # Optional: serve from subdirectory
```

--------------------------------

### Reset Forgotten Password (Platform Specific)

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/cli-commands.md

Reset a forgotten password using the `change-password` command. Examples are provided for Linux/macOS, Windows, and Docker environments.

```bash
# Linux / macOS:
./qui change-password --username admin --new-password mynewpassword
```

```batch
# Windows (Command Prompt):
qui.exe change-password --username admin --new-password mynewpassword
```

```bash
# Docker:
docker exec -it <container-name> qui change-password --username admin --new-password mynewpassword
```

--------------------------------

### Enable Profiling (pprof)

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/environment.md

Set QUI__PPROF_ENABLED to true to enable the pprof server on port 6060. Defaults to false.

```bash
QUI__PPROF_ENABLED=true  # Optional: enable pprof server on :6060 (default: false)
```

--------------------------------

### Create Program

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/external-programs.md

Creates a new external program configuration.

```APIDOC
## POST /api/external-programs

### Description
Creates a new external program.

### Method
POST

### Endpoint
/api/external-programs
```

--------------------------------

### Enable Trace Logging for Cross-Seed

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/troubleshooting.md

Enable trace logging in your configuration to get detailed rejection reasons for cross-seed matches. This is useful for debugging why a release might have been filtered.

```toml
loglevel = 'TRACE'
```

--------------------------------

### autobrr External Filter Data (All Instances)

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/autobrr.md

Configure the JSON data payload for the autobrr external filter to send torrent information to qui's webhook. This example searches all qBittorrent instances.

```json
{
  "torrentName": {{ toRawJson .TorrentName }},
  "indexer": {{ toRawJson .Indexer }}
}
```

--------------------------------

### Docker Compose with Identical Volume Paths

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/dir-scan.md

This configuration mounts the same storage volume at the same path in both the qui and qBittorrent containers, simplifying path mapping for cross-seeding.

```yaml
services:
  qui:
    volumes:
      - /mnt/storage:/mnt/storage

  qbittorrent:
    volumes:
      - /mnt/storage:/mnt/storage
```

--------------------------------

### Docker Compose Configuration

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/getting-started/docker.md

Use this YAML file to set up qui with Docker Compose. It defines the services, networks, and volumes required for the application.

```yaml
services:
  qui:
    image: ghcr.io/autobrr/qui:latest
    container_name: qui
    ports:
      - "7476:7476"
    volumes:
      - ./config:/config
    restart: unless-stopped

```

--------------------------------

### autobrr External Filter Data for qui

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/autobrr.md

Configure the JSON data payload for the autobrr external filter to send torrent information to qui's webhook. This example searches a specific qBittorrent instance.

```json
{
  "torrentName": {{ toRawJson .TorrentName }},
  "instanceIds": [1],
  "indexer": {{ toRawJson .Indexer }}
}
```

--------------------------------

### autobrr Action Setup - Season Pack Apply Payload

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/features/cross-seed/season-packs.md

Configure this JSON payload in the 'Payload' field of your autobrr webhook for the season pack apply action. It requires the torrent name and base64-encoded torrent data.

```json
{
  "torrentName": {{ toRawJson .TorrentName }},
  "torrentData": "{{ .TorrentDataRawBytes | toString | b64enc }}",
  "instanceIds": [1],
  "indexer": {{ toRawJson .Indexer }}
}
```

--------------------------------

### User Management with Custom Directories

Source: https://github.com/autobrr/qui/blob/develop/documentation/docs/configuration/cli-commands.md

User management commands support specifying custom configuration and data directories for flexibility.

```bash
# All commands support custom config/data directories
./qui create-user --config-dir /path/to/config/ --username admin
```