cross-seed configuration

Configure cross-seed

This guide explains how to configure cross-seed to communicate with your torrent client.

Open the Configuration File

If you have not yet generated the default configuration, run:

cross-seed gen-config

This creates the configuration file at:

~/.cross-seed/config.js

Edit it using your preferred text editor:

nano ~/.cross-seed/config.js

Find Your Torrent Client URL

Your torrent client URL can be found in the Client Area under your service details.

When configuring torrentClients, simply add your torrent client username and password to the URL.

Example:

torrentClients: [
    "qbittorrent:https://USERNAME:PASSWORD@YOUR-CLIENT-URL"
],

Configure qBittorrent

torrentClients: [
    "qbittorrent:https://USERNAME:PASSWORD@YOUR-CLIENT-URL"
],

Replace USERNAME and PASSWORD with your qBittorrent credentials and replace YOUR-CLIENT-URL with the complete HTTPS URL from your Client Area.

Configure Deluge

torrentClients: [
    "deluge:https://:PASSWORD@YOUR-CLIENT-URL"
],

Replace PASSWORD with your Deluge WebUI password and replace YOUR-CLIENT-URL with the complete HTTPS URL from your Client Area.

Configure rTorrent / ruTorrent

torrentClients: [
    "rtorrent:https://USERNAME:PASSWORD@YOUR-CLIENT-URL"
],

Replace USERNAME and PASSWORD with your rTorrent credentials and replace YOUR-CLIENT-URL with the complete HTTPS URL from your Client Area.

Configure Transmission

torrentClients: [
    "transmission:https://USERNAME:PASSWORD@YOUR-CLIENT-URL"
],

Replace USERNAME and PASSWORD with your Transmission credentials and replace YOUR-CLIENT-URL with the complete HTTPS URL from your Client Area.

Configure Your Indexers

cross-seed requires one or more Torznab indexers provided by Prowlarr, Jackett or another compatible application.

Example:

torznab: [
    "https://YOUR-PROWLARR-URL/1/api?apikey=YOUR_API_KEY"
],

Recommended Settings

The following settings are recommended for most users:

action: "inject",

duplicateCategories: true,

matchMode: "safe",

searchCadence: "1 day",

rssCadence: "20 minutes",

Example Configuration

After configuring your torrent client and Torznab indexers, your configuration should look similar to the example below:

torznab: [
    "https://YOUR-PROWLARR-URL/1/api?apikey=YOUR_API_KEY"
],

action: "inject",

torrentClients: [
    "qbittorrent:https://USERNAME:PASSWORD@YOUR-CLIENT-URL"
],

duplicateCategories: true,

matchMode: "safe",

searchCadence: "1 day",

rssCadence: "20 minutes",

You can, of course, adjust these values to better suit your own workflow and preferences.

Test the Configuration

After saving config.js, verify that the configuration is valid.

First, run:

cross-seed doctor

If no issues are reported, perform a manual search:

cross-seed search

If both commands complete without any errors, your configuration is correct.

Restart cross-seed

If cross-seed is already running, restart it to apply the new configuration:

screen -S cross-seed -X quit

screen -DmS cross-seed cross-seed

Verify that it is running:

screen -ls | grep cross-seed

Troubleshooting

• Always use the complete HTTPS URL copied from your Client Area.
• Do not replace the hostname with localhost, 127.0.0.1 or use custom ports unless your setup specifically requires it.
• If authentication fails, verify that you entered the correct username and password for your torrent client.
• If your username or password contains special characters, they may need to be URL encoded before being placed in the connection string.
• If cross-seed cannot connect to your torrent client, first verify that the client URL is accessible from your web browser.
• Restart cross-seed after making any changes to config.js.
• Make sure cross-seed has access to the same download directory used by your torrent client.