---
sidebar_position: 6
---

import {
  ConfigSection,
  SectionTitle,
  ElementNavigator,
  styles
} from '@site/src/components/documentation';

# Download Client

Configure download client connections for torrents. Cleanuparr supports qBittorrent, Deluge, Transmission and µTorrent download clients.

<ElementNavigator />

<div className={styles.documentationPage}>

<div className={styles.section}>

<ConfigSection
  title="Enable Download Client"
  icon="🔄"
>

Controls whether this download client instance is active and will be used by Cleanuparr for operations.

**When Enabled**:
- Client will be available for slow, stalled and private tracker operations.
- Health checks will monitor this client.

**When Disabled**:
- Client will be ignored by all Cleanuparr operations.
- No health checks will be performed.

</ConfigSection>

<ConfigSection
  title="Client Name"
  icon="🏷️"
>

A descriptive name to identify this download client instance in the Cleanuparr interface.

</ConfigSection>

<ConfigSection
  title="Client Type"
  icon="📱"
>

Specifies which download client software this configuration connects to.

</ConfigSection>

</div>

<div className={styles.section}>

<SectionTitle icon="🌐">
  Connection Settings
</SectionTitle>

<ConfigSection
  title="Client Host"
  icon="🖥️"
>

The complete URL to access your download client's web interface.

**Format**: `protocol://hostname:port`

**Examples**:
- `http://localhost:8080` (local qBittorrent)
- `https://seedbox.example.com:8080` (remote qBittorrent with SSL)
- `http://192.168.1.100:8112` (local network Deluge)
- `http://transmission.lan:9091` (local Transmission)

</ConfigSection>

<ConfigSection
  title="URL Base Path"
  icon="📂"
>

URL path prefix if your download client runs behind a reverse proxy with a subpath.

**When to Use**:
- Client accessed via reverse proxy (Nginx, Apache, Traefik).
- Client uses non-root URL path.
- Multiple services share same domain/port.

**Examples**:
- `qbittorrent` → Full URL: `http://domain.com/qbittorrent`
- `downloads/deluge` → Full URL: `http://domain.com/downloads/deluge`
- `transmission` → Full URL: `http://domain.com/transmission`

</ConfigSection>

<ConfigSection
  title="External URL"
  icon="🔗"
>

Optional external URL used in notification messages instead of the internal host URL. This is useful for Docker users where internal container URLs (e.g., `http://qbittorrent:8080`) are not reachable from outside the Docker network.

**When to Use**:
- Running Cleanuparr in Docker with internal container networking.
- Notification links need to be clickable from your browser or phone.
- Internal URLs differ from externally-accessible URLs.

**Examples**:
- `https://qbit.mydomain.com`
- `http://192.168.1.100:8080`

If not set, the internal host URL will be used in notifications.

</ConfigSection>

</div>

<div className={styles.section}>

<SectionTitle icon="🔐">
  Authentication
</SectionTitle>

<ConfigSection
  title="Username"
  icon="👤"
>

Username for download client authentication if required.

</ConfigSection>

<ConfigSection
  title="Password"
  icon="🔑"
>

Password for download client authentication.

</ConfigSection>

</div>

</div>
