Skip to main content

Unraid

Installation

To install in unRAID, the easiest setup will be to use the Community Applications app (Apps section in the unRAID WebUI). Go to the Apps tab and search for cross-seed. We have an official container now, which is under "ambipro's Repository". Click on the "Install" button. This will take you to the template configuration.

Configuration

Volume Mappings

Cross-seed needs to access 3 directories: an input directory with torrent files, an output directory for cross-seed to save new torrent files (when using action: 'save',), and a config directory.

Config TypeNameContainerHostAccess Mode
PathconfigPath/config/mnt/user/appdata/cross-seedRead/Write
PathtorrentDir/torrents/path/to/torrent/client/session/dirRead Only
PathoutputDir/output/path/to/torrent/client/watch/dirRead/Write
Path (Optional)dataDir/torrent/client/path/to/torrent/data/path/to/torrent/client/dataRead/Write
tip

The "dataDir" path is used only for data-based searching. If you wish to add this, you will need to edit the path for dataDir.

The container path for cross-seed will need to be the same as how your torrent client's container path is configured.

Port Mappings

cross-seed can listen for an HTTP request from when a torrent finishes downloading or you receive an announce.

tip

If you don't need to use these features from outside of Docker, then you can skip this step.

Config TypeNameContainer PortHost PortConnection Type
PortPort24682468TCP

Screenshot

Below is a screenshot of what your Docker container configuration might look like. Now, you can try starting the Docker container and editing the resulting configuration file in the next step.

screenshot-cross-seed

You can start the container to create the config file path.

Configuration File

After the container has been created, we need to add a configuration file. Open a terminal in Unraid and issue the following commands:

cd /mnt/user/appdata/cross-seed
curl https://raw.githubusercontent.com/cross-seed/cross-seed/master/src/config.template.docker.cjs -o config.template.docker.js
cp config.template.docker.js config.js

From here, you can edit the configuration options to your liking through your preferred text editor (nano, vim, etc).

Start your container and check the logs. You should see something along the lines of:

Configuration file already exists.
info: Validating your configuration...
info: Your configuration is valid!
info: [server] Server is running on port 2468, ^C to stop.

Automation/Scheduling

cross-seed runs in Daemon mode by default on Unraid.

If you would like to schedule a periodic scan of your library, set the searchCadence option.

If you would like to set up RSS scans, set the rssCadence option.

If you would like to automatically check for cross-seeds when a download finishes, learn how to set up with automatic searches.