---
sidebar_position: 6
---

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

# Download Client

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

<div className={styles.documentationPage}>

<div className={styles.section}>

<ConfigSection
  id="enable-download-client"
  title="Enable Download Client"
  description="Controls whether this download client instance is active and will be used by Cleanuparr for operations."
  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
  id="client-name"
  title="Client Name"
  description="A descriptive name to identify this download client instance in the Cleanuparr interface."
  icon="🏷️"
>

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

</ConfigSection>

<ConfigSection
  id="client-type"
  title="Client Type"
  description="Specifies which download client software this configuration connects to."
  icon="📱"
>

Specifies which download client software this configuration connects to.

</ConfigSection>

</div>

<div className={styles.section}>

<h2 className={styles.sectionTitle}>
  <span className={styles.sectionIcon}>🌐</span>
  Connection Settings
</h2>

<ConfigSection
  id="client-host"
  title="Client Host"
  description="The complete URL to access your download client's web interface."
  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
  id="url-base-path"
  title="URL Base Path"
  description="URL path prefix if your download client runs behind a reverse proxy with a subpath."
  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>

</div>

<div className={styles.section}>

<h2 className={styles.sectionTitle}>
  <span className={styles.sectionIcon}>🔐</span>
  Authentication
</h2>

<ConfigSection
  id="username"
  title="Username"
  description="Username for download client authentication if required."
  icon="👤"
>

Username for download client authentication if required.

</ConfigSection>

<ConfigSection
  id="password"
  title="Password"
  description="Password for download client authentication."
  icon="🔑"
>

Password for download client authentication.

</ConfigSection>

</div>

</div>
