Skip to main content

Settings

The Web UI Settings page edits runtime configuration and manages related security state. Open Settings, choose a section, make the change, then select Save.

Field help​

Use the information icon beside a setting’s label to read its effect, constraints and relevant defaults. Help floats near the icon without moving the form. Hover over the icon or focus it with the keyboard; on touch devices, tap to open or close it. You can move the pointer onto the help to read it. Press Escape, move away, or tap outside to dismiss it. Essential warnings remain visible beside the controls. Opening help does not change the setting.

Display names may differ from imported configuration keys. Keys, saved values and API fields are unchanged. Compatibility-only preferences are identified individually; they remain stored but do not implement the named feature.

Configuration actions​

ActionResult
ReloadReloads persisted configuration and discards unsaved edits.
ExportDownloads the current configuration with secrets kept encrypted.
ImportReplaces persisted settings with an imported Python, YAML, or JSON configuration after warning.
SaveValidates edits and activates them when current operations have safely finished.

Invalid configuration is rejected without replacing the active runtime. If an environment variable overrides a field, the stored value can save successfully while the environment value remains active.

A Pending save is not active yet. The Settings page checks for activation when opened and keeps checking while the save is pending. Another save while activation is pending returns busy and preserves your draft. If activation fails, the previous settings remain active; correct the settings and save again. Pending and failed status survive a restart.

Saving the same effective settings does not restart work. Documented compatibility-only controls still save and export, but changing only those controls does not rebuild the runtime or invalidate workflow stages. Active setting changes invalidate the affected stages, while compatible media and confirmed upload records remain available.

Before importing

Export the current configuration first. Import replaces the configuration stored in the database and cannot be undone from the Web UI.

Test a connection​

Where offered, select Test connection beside an integration or configured instance to check the current form values without saving them. Torrent-client checks are available for qBittorrent/qui entries; watch-folder entries have no test button. An unchanged [REDACTED] value uses its preserved secret; an edited credential is tested immediately. The request runs on the server with the integration's applicable proxy and TLS settings.

Wait for the result beside the button. Other instances can be tested independently. Editing the tested fields clears their result and cancels a pending test. Requests have a ten-second timeout; a denied response can also indicate account permissions, IP restrictions, or proxy access.

Cancellation stops waiting for storage, but a filesystem read already blocked by the operating system may need to finish later. Further storage reads wait for that operation or their own cancellation; canceled tests never start a service request afterward.

A successful check proves only the read operation described in its result. It does not prove upload permission. Connection tests do not upload images or torrents, add torrents to clients, save settings, or refresh stored tracker sessions. Public services may have no credentials to check. Image hosts without a verified safe check show an explanation instead of a test button.

The checked credential depends on the provider. API probes check the entered API credentials; cookie probes check the imported session. Where temporary credential login is supported, entering either a username or password selects a fresh login and requires both values. A failed login does not fall back to imported cookies. Announce passkeys and credentials used only during upload are not verified by a session-page check.

The result describes the check's scope and limits. An API key may work for reads while a separate web login, two-factor step or upload permission still needs attention. Some supported upload APIs provide no compatible read-only credential check. Custom upload URLs may also have no verified companion read URL. No upload is attempted in these cases. A provider may record normal request or token-use audit information without creating content or refreshing credentials.

An unverified result means a compatible authenticated read contract has not yet been established. It is not evidence of invalid credentials or proof that the provider cannot support a safe check. No credentials are sent for an unverified check.

Failed checks identify HTTP status codes and recognized API errors, maintenance pages or browser challenges where possible. An HTTP 401 can come from the provider, an upstream service or a reverse proxy; it does not identify a particular bad credential. For qui, use the client-proxy URL and its client-proxy key, which are separate from regular qui API keys. Check the service directly when a diagnostic reports an error notice. Remote response text is not displayed because it can contain credentials or private endpoints.

Pixhost checks a fixed synthetic public image URL without uploading anything. If Pixhost reports that URL as invalid, the result explains that the API was reached but the status check could not be verified; it does not report success.

TMDB reads the details of one fixed public movie using the entered API key and the same API-key authentication as metadata lookup. Success requires the expected movie ID and a nonempty title in an HTTP 200 JSON response. Unidentified JSON, explicit API errors, HTTP 401 and non-JSON pages are reported as failed checks. No metadata is saved.

Secrets and direct actions​

Stored credentials appear as [REDACTED]. Leave that value unchanged to preserve the secret, enter a new value to replace it, or clear it to remove it. Never include configuration exports, API tokens, cookies, passkeys, or announce URLs in public reports.

Most sections stage edits until Save. These sections behave differently:

  • Application Details is read-only.
  • Appearance applies immediately and is saved in this browser; see Appearance.
  • API Tokens creates and revokes tokens immediately.
  • Tracker authentication imports, checks, and deletes auth state immediately.

Unsaved settings edits stay in the draft while you use other Web UI pages or browser Back and Forward. Reload and Log out ask before discarding them. Reloading or closing the browser tab triggers the browser's own unsaved-changes warning. If the session expires, sign in again; the unsaved draft has been discarded.

Use Show advanced only when a section offers it. Advanced fields are active settings unless their reference page identifies a compatibility-only field.

Sections​

SectionPurpose
GeneralMetadata access, browser history, icons, and scene detection.
Image HostingOrdered upload hosts, credentials, and conditional hosts.
MetadataDiscovery, tracker-data, image, and Blu-ray lookup policy.
Screenshot captureScreenshot generation, upload concurrency, and tone mapping.
DescriptionShared description layout, headers, artwork, and signatures.
Sonarr and RadarrSonarr and Radarr metadata enrichment.
Post UploadClient-injection delay and tracker upload concurrency.
TrackersEnabled trackers, defaults, credentials, and tracker options.
Torrent ClientsqBittorrent, qui proxy, watch-folder, linking, and path mapping.
Client HandlingDefault, search, and injection client selection.
Torrent preparationReusable torrent piece preference and rehash scheduling.
Application DetailsBuild, platform, FFmpeg, and uptime diagnostics.
AppearanceBundled themes, color mode, and optional accents.
API TokensScoped bearer-token creation and revocation.
Tracker authenticationEncrypted cookies, remote checks, relogin, and 2FA state.

After changing upload behavior or credentials, inspect every tracker preview and run Dry Run. Dry Run suppresses tracker submission but still attempts client injection by default; select Skip client injection when no torrent should be added. For CLI testing, combine --debug with --no-seed (-ns).

Logging configuration and the live viewer are on the separate Logging page.