Skip to content

Instantly share code, notes, and snippets.

@LilTrublMakr
Last active August 20, 2022 01:32
Show Gist options
  • Save LilTrublMakr/a1836cfa52ff1cd3a8398fd0ace23517 to your computer and use it in GitHub Desktop.
Save LilTrublMakr/a1836cfa52ff1cd3a8398fd0ace23517 to your computer and use it in GitHub Desktop.
Updated documentation for cross-seed.
id title
unraid
Unraid

Installation

To install in Unraid, the easiest setup will be to use the Community Applications app. Once the app is installed, go to the App tab and search for cross-seed. 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, and a config directory.

Config Type Name Container Path Host Path Access Mode
Path Config /config /mnt/user/appdata/cross-seed Read/Write
Path Input /torrents /path/to/torrent/client/session/dir Read Only
Path Output /output /path/to/torrent/client/watch/dir Read/Write

Port Mappings

Cross-seed can listen for HTTP requests for 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 Type Name Container Port Host Port Connection Type
Port Port 2468 2468 TCP

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 to your liking through either nano or whatever method you use to edit your files.

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

If you would like to schedule a periodic scan, you can do this with the "User Scripts" plugin for Unraid.

Go to the "Apps" tab and search for "user scripts" by Squid. Click on "Install" to install the plugin.

Now, go to the "Settings" tab. Under "User Utilities", find and click on "User Scripts".

On the bottom of the page, click on the "ADD NEW SCRIPT" button. Name the script to whatever suits your fancy.

On the new script, click on the gear icon and then click on "Edit Script".

In the text box, paste the following code:

#!/bin/bash
docker exec -i cross-seed cross-seed search

Click on "SAVE CHANGES". You can add a schedule by selecting an option in the dropdown. Click "APPLY" on the bottom of the page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment