Installation - moleculekayak/fertilizer GitHub Wiki

Installation

PyPi Download

  1. Ensure you have Python >= 3.11 installed
  2. Run pip install fertilizer
    • Use pipx install fertilizer if you have pipx installed
  3. Navigate to the directory that you want to hold your fertilizer config
  4. Create a file called config.json with the following contents:
{
  "red_key": "<RED KEY HERE>",
  "ops_key": "<OPS KEY HERE>"
}

See the Configuration Docs for more

Docker

  1. Create new directories needed for the container to run and ensure they're writable by the container:
    • A directory for configuration files which will be mapped to /config
  2. Identify existing directories needed for the container to run and ensure they're writable by the container:
    • A directory containing input torrents which will be mapped to /torrents
      • NOTE: This directory should contain the torrents your client is actively working on. For Deluge this is called the state directory, for qBittorrent this is called the BT_backup directory.
    • A directory that will store output files which will be mapped to /data
      • IMPORTANT: If your torrent client is setup using Docker and you want to use torrent injection, it's critical that your /data directory here is mapped to the same /data directory as your torrent client. For example, my Deluge client maps /data to /shares/bittorrent so I use /shares/bittorrent here as well. You can specify where the different types of output data gets stored in later steps
  3. docker run --rm -v /host/path/to/config:/config ghcr.io/moleculekayak/fertilizer:latest
  4. Generate API keys for RED and OPS then add them to config.json in your specified config directory

Unraid

  1. Search for fertilizer in the Unraid Community Apps store
  2. Install it, optionally changing the -o argument in the Post Arguments section to match your preference
    • NOTE: You can see the Post Arguments section by clicking Basic View in the upper right
  3. Once installed, edit the config.json file in your specified config directory
  4. Run the app! It runs in server mode by default

Docker Compose (incl. Portainer)

services:
  fertilizer:
    image: ghcr.io/moleculekayak/fertilizer:latest
    ports:
      - 9713:9713
    volumes:
      # !TODO! Change the paths to the correct path on your system
      - /shares/appdata/fertilizer:/config
      - /shares/appdata/deluge/state:/torrents
      - /shares/bittorrent:/data
    command: fertilizer -o /data/fertilizer/torrent-files -i /torrents -c /config/config.json --server
  1. Once installed, edit the config.json file in your specified config directory
  2. Run the app! The command sets it to run in server mode

Direct Download (not recommended)

  1. Download and extract fertilizer.zip from the latest release
  2. Install fertilizer with pip install --trusted-host pypi.python.org .
    • NOTE: The minimum supported Python version is 3.10
  3. Generate API keys for RED and OPS then add them to src/fertilizer/config.json