29 releases
0.5.19 | Apr 15, 2024 |
---|---|
0.5.18 | Apr 15, 2024 |
0.5.16 | Dec 15, 2023 |
0.5.15 | Nov 27, 2023 |
0.1.2 | Sep 17, 2023 |
#1166 in Network programming
48 downloads per month
61KB
1.5K
SLoC
putioarr
Proxy that allows put.io to be used as a download client for sonarr/radarr/whisparr. The proxy uses the Transmission protocol.
Installation
There are a few ways to install putioarr:
Cargo
Make sure you have a proper rust installation
cargo install putioarr
Usage
First, generate a config using putio generate-config
. This will generate a config file in ~/.config/putioarr/config.toml
. Use -c
to override the configuration file location.
Edit the configuration file and make sure you configure the username and password, as well as the sonarr/radarr/whisparr details.
- Run the proxy:
putioarr run
- Configure the Transmission download client in sonarr/radarr/whisparr:
- Url Base: /transmission
- Username:
- Password:
Docker
Docker images are based on linuxserver.io images.
Usage
The first time you run your docker container, run it without the -d
option, since you'll need a put.io API key. When no configuration is found, it will present you a link and a code that will generate an API key. After the key is generated, putioarr will write a default config in your config volume (see docker compose
and docker cli
below). Modify the config (like username, password and sonarr/radarr/whisparr configuration) in order to properly use putioarr.
Supported Architectures
We utilise the docker manifest for multi-platform awareness.
Simply pulling ghcr.io/wouterdebie/putioarr:latest
should retrieve the correct image for your arch (amd64 or arm64).
docker-compose (recommended, click here for more info)
---
version: "2.1"
services:
putioarr:
image: ghcr.io/wouterdebie/putioarr:latest
container_name: putioarr
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
volumes:
- /path/to/putioarr/config:/config
- /path/to/your/downloads:/downloads
ports:
- 9091:9091
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=putioarr \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-p 9091:9091 \
-v /path/to/putioarr/config:/config \
-v /path/to/your/downloads:/downloads \
--restart unless-stopped \
ghcr.io/wouterdebie/putioarr:latest
Parameters
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal>
respectively. For example, -p 8080:80
would expose port 80
from inside the container to be accessible from the host's IP on port 8080
outside the container.
Parameter | Function |
---|---|
-p 9091 |
Port connecting to putioarr |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Etc/UTC |
specify a timezone to use, see this list. |
-v /config |
putioarr configs |
-v /downloads |
torrent download directory |
Behavior
The proxy will upload torrents or magnet links to put.io. It will then continue to monitor transfers. When a transfer is completed, all files belonging to the transfer will be downloaded to the specified download directory. The proxy will remove the files after sonarr/radarr/whisparr has imported them and put.io is done seeding. The proxy will skip directories named "Sample".
Configuration
A configuration file can be specified using -c
, but the default configuration file location is:
- Linux: ~/.config/putioarr/config.toml
- MacOS: ~/Library/Application Support/nl.evenflow.putioarr
TOML is used as the configuration format:
# Required. Username and password that sonarr/radarr/whisparr use to connect to the proxy
username = "myusername"
password = "mypassword"
# Required. Directory where the proxy will download files to. This directory has to be readable by
# sonarr/radarr/whisparr in order to import downloads
download_directory = "/path/to/downloads"
# Optional bind address, default "0.0.0.0"
bind_address = "0.0.0.0"
# Optional TCP port, default 9091
port = 9091
# Optional log level, default "info"
loglevel = "info"
# Optional UID, default 1000. Change the owner of the downloaded files to this UID. Requires root.
uid = 1000
# Optional polling interval in secs, default 10.
polling_interval = 10
# Optional skip directories when downloding, default ["sample", "extras"]
skip_directories = ["sample", "extras"]
# Optional number of orchestration workers, default 10. Unless there are many changes coming from
# put.io, you shouldn't have to touch this number. 10 is already overkill.
orchestration_workers = 10
# Optional number of download workers, default 4. This controls how many downloads we run in parallel.
download_workers = 4
[putio]
# Required. Putio API key. You can generate one using `putioarr get-token`
api_key = "MYPUTIOKEY"
# Both [sonarr] and [radarr] are optional, but you'll need at least one of them
[sonarr]
url = "http://mysonarrhost:8989/sonarr"
# Can be found in Settings -> General
api_key = "MYSONARRAPIKEY"
[radarr]
url = "http://myradarrhost:7878/radarr"
# Can be found in Settings -> General
api_key = "MYRADARRAPIKEY"
TODO:
- Better Error handling and retry behavior
- The session ID provided is hard coded. Not sure if it matters.
- (Add option to not delete downloads)
- Figure out a better way to map a transfer to a completed import. Since a transfer can contain multiple files (e.g. a whole season) we currently check if all video files have been imported. Most of the time this is fine, except when there are sample videos. sonarr/radarr/whisparr will not import samples, but will make no mention of the fact that the sample was skipped. Right now we check against the
skip_directories
list, which works, but might be tedious. - Automatically pick the right putio proxy based on speed
Thanks
Thanks to davidchalifoux for borrowed code from kaput-cli.
Dependencies
~24–39MB
~676K SLoC