Installation - moleculekayak/fertilizer GitHub Wiki
Installation
PyPi Download
- Ensure you have Python >= 3.11 installed
- Run
pip install fertilizer- Use
pipx install fertilizerif you have pipx installed
- Use
- Navigate to the directory that you want to hold your fertilizer config
- Create a file called
config.jsonwith the following contents:
{
"red_key": "<RED KEY HERE>",
"ops_key": "<OPS KEY HERE>"
}
See the Configuration Docs for more
Docker
- 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
- A directory for configuration files which will be mapped to
- 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
statedirectory, for qBittorrent this is called theBT_backupdirectory.
- NOTE: This directory should contain the torrents your client is actively working on. For Deluge this is called the
- 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
/datadirectory here is mapped to the same/datadirectory as your torrent client. For example, my Deluge client maps/datato/shares/bittorrentso I use/shares/bittorrenthere as well. You can specify where the different types of output data gets stored in later steps
- IMPORTANT: If your torrent client is setup using Docker and you want to use torrent injection, it's critical that your
- A directory containing input torrents which will be mapped to
docker run --rm -v /host/path/to/config:/config ghcr.io/moleculekayak/fertilizer:latest- Generate API keys for RED and OPS then add them to
config.jsonin your specified config directory
Unraid
- Search for
fertilizerin the Unraid Community Apps store - Install it, optionally changing the
-oargument in thePost Argumentssection to match your preference- NOTE: You can see the
Post Argumentssection by clickingBasic Viewin the upper right
- NOTE: You can see the
- Once installed, edit the
config.jsonfile in your specified config directory - 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
- Once installed, edit the
config.jsonfile in your specified config directory - Run the app! The
commandsets it to run in server mode
Direct Download (not recommended)
- Download and extract
fertilizer.zipfrom the latest release - Install fertilizer with
pip install --trusted-host pypi.python.org .- NOTE: The minimum supported Python version is 3.10
- Generate API keys for RED and OPS then add them to
src/fertilizer/config.json