Compare commits

...

1 Commits

Author SHA1 Message Date
Flaminel
911849c6dd Fix blacklist synchronizer docs (#307) 2025-09-16 23:30:38 +03:00
3 changed files with 64 additions and 45 deletions

View File

@@ -21,7 +21,7 @@
<div class="flex align-items-center justify-content-between p-3 border-bottom-1 surface-border">
<div class="header-title-container">
<h2 class="card-title m-0">Blacklist Sync Configuration</h2>
<span class="card-subtitle">Configure automatic blacklist synchronization</span>
<span class="card-subtitle">Configure automatic blacklist synchronization for qBittorrent clients</span>
</div>
</div>
</ng-template>
@@ -38,7 +38,7 @@
</label>
<div class="field-input">
<p-checkbox formControlName="enabled" [binary]="true" inputId="blacklistSyncEnabled"></p-checkbox>
<small class="form-helper-text">When enabled, blacklist patterns will be synchronized to download clients hourly</small>
<small class="form-helper-text">When enabled, blacklist patterns will be synchronized to enabled qBittorrent clients hourly</small>
</div>
</div>

View File

@@ -0,0 +1,62 @@
---
sidebar_position: 5
---
import { Note, Warning } from '@site/src/components/Admonition';
import {
ConfigSection,
EnhancedNote,
EnhancedWarning,
styles
} from '@site/src/components/documentation';
# Blacklist Synchronizer
The Blacklist Synchronizer automatically synchronizes blacklist entries to all enabled qBittorrent clients every hour. This helps maintain consistent content filtering across your download clients.
<div className={styles.documentationPage}>
<div className={styles.section}>
<h2 className={styles.sectionTitle}>
<span className={styles.sectionIcon}>⛔</span>
Blacklist Sync
</h2>
<ConfigSection
id="enable-blacklist-sync"
title="Enable Blacklist Sync"
icon="✅"
>
When enabled, Cleanuparr will automatically synchronize blacklist entries to all enabled qBittorrent clients every hour. The sync happens when the blacklist path or content changes.
<EnhancedNote>
This feature updates the qBittorrent "Excluded file names" setting, but does not enable it.
</EnhancedNote>
</ConfigSection>
<ConfigSection
id="blacklist-path"
title="Blacklist Path"
icon="🗂️"
>
Path to the blacklist content. This can be a local file path or an HTTP/HTTPS URL. The application computes a content hash and only pushes updates when the content changes.
**Examples:**
```
/data/blacklists/qbit-exclusions.txt
https://example.com/blacklist.txt
```
<EnhancedWarning>
If Blacklist Sync is enabled, this field is required. For remote URLs, ensure the server is reachable from Cleanuparr and the certificate is valid (or adjust HTTP certificate validation settings).
</EnhancedWarning>
</ConfigSection>
</div>
</div>

View File

@@ -157,49 +157,6 @@ mytracker.com
</div>
<div className={styles.section}>
<h2 className={styles.sectionTitle}>
<span className={styles.sectionIcon}>⛔</span>
Blacklist Sync
</h2>
<ConfigSection
id="enable-blacklist-sync"
title="Enable Blacklist Sync"
icon="✅"
>
When enabled, Cleanuparr will automatically synchronize blacklist entries to all enabled qBittorrent clients every hour. The sync happens when the blacklist path or content changes.
<EnhancedNote>
This feature updates the qBittorrent "Excluded file names" setting, but does not enable it.
</EnhancedNote>
</ConfigSection>
<ConfigSection
id="blacklist-path"
title="Blacklist Path"
icon="🗂️"
>
Path to the blacklist content. This can be a local file path or an HTTP/HTTPS URL. The application computes a content hash and only pushes updates when the content changes.
**Examples:**
```
/data/blacklists/qbit-exclusions.txt
https://example.com/blacklist.txt
```
<EnhancedWarning>
If Blacklist Sync is enabled, this field is required. For remote URLs, ensure the server is reachable from Cleanuparr and the certificate is valid (or adjust HTTP certificate validation settings).
</EnhancedWarning>
</ConfigSection>
</div>
</div>
<div className={styles.section}>