Putio-Get

A downloader for content stored in put.io.

It allows you to sync a put.io directory locally when new files are added.

This was created for my own purposes, it's not perfect, but it works for MY needs.

Available on Docker Hub: https://hub.docker.com/r/jokneemo/putio-get

This is not affiliated with nor supported by put.io

Python Package

You can install putio-get directly from PyPI (or local source):

pip install putio-get

Usage:

# Run once and exit
putio-get

# Run as a daemon (monitoring loop)
putio-get --daemon

Docker Compose

services:
  putio-get:
    image: jokneemo/putio-get:latest
    restart: unless-stopped
    environment:
      PUTIO_OAUTH_TOKEN: 'your-oauth-token-here'
      PUTIO_SYNC_ACTION: move
      PUTIO_EMPTY_TRASH: true
      PUTIO_GUESSIT: true
      PUTIO_DIRECTORY_MAP: "/Videos:/Videos,/Comics:/Literature/Comics"
    volumes:
      - ./local-media:/target

Getting an OAuth Token

You can get a put.io OAuth token for this system by navigating to https://app.put.io/oauth.

1. Click Create App in the top right corner
2. Fill in the form:

   Field	Value
   Application Name	putio-get
   Description	A python service to automatically download files from put.io
   Application website	https://github.com/JokneeMo/putio-get
   Callback URL	*
   Don't show in Extensions page	[x]

3. Then click Create App
4. Copy the values of the OAuth token, this is the only thing that will be needed.

Container Variables

Environment variables can control several behaviors in the container

Required Variables

[!IMPORTANT] You must provide one of either the main or _FILE variables for each of the following in this table

Optional Variables

Mirror Usage

Using the put.io mirrors can significantly speed up downloads. Mirror usage is disabled by default.

To benchmark the mirrors, run the following command:

localhost:

putio-get --benchmark-only --benchmark-file ./mirror_speeds.json --min-mirror-speed 50MB/s

Docker:

docker run --rm -v ./mirror_speeds.json:/mirror_speeds.json jokneemo/putio-get:latest --benchmark-only --benchmark-file /mirror_speeds.json --min-mirror-speed 50MB/s

To use the mirrors at runtime, use the argument --enable-mirrors or set the environment variable PUTIO_ENABLE_MIRRORS=true. Use the argument --min-mirror-speed or set the environment variable PUTIO_MIN_MIRROR_SPEED=50MB/s (or desired speed) to the minimum speed required for a mirror to be used.

Be sure to mount the benchmark file to the container if you want to use the same benchmark results across restarts. Otherwise, the mirrors will be benchmarked on every startup.

The default location of the benchmark file is /mirror_speeds.json inside the container. Use the argument --benchmark-file or environment variable PUTIO_BENCHMARK_FILE to specify a different location.

Config File

You can define all, or only some, of the options in a json file. The file can be specified using the --config-file argument or the PUTIO_CONFIG_FILE environment variable. If the file is specified and loaded successfully, it can still be overridden by environment variables, which in turn can be overridden by runtime arguments.

To get the config file format, run the following command:

localhost:

putio-get --print-config

Docker:

docker run --rm jokneemo/putio-get:latest --print-config

This will print the default config file format to the console.

The --print-config argument can also accept a comma separated list of config sections to print.

putio-get --print-config paths,permissions

This will print the config for the paths and permissions sections to the console. You can then store this in a file and use it as needed.