Sign inSign up

jaimistry/autothrottle

By jaimistry

•Updated 3 days ago

Intelligently throttles download clients while a media server has active playback.

Image
0

526

jaimistry/autothrottle repository overview

AutoThrottle logo

⁠AutoThrottle

Source Code⁠

⁠🚀 Quick start

Docker compose:

services:
  autothrottle:
    image: jaimistry/autothrottle:latest
    container_name: autothrottle
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/Los_Angeles
    volumes:
      - /data:/data
    ports:
      - "7676:7676"
    restart: unless-stopped

Docker run:

docker run -d \
  --name autothrottle \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=America/Los_Angeles \
  -v /data:/data \
  -p 7676:7676 \
  --restart unless-stopped \
  jaimistry/autothrottle:latest

⁠⚙️ Environment variables

All are optional.

VariableDefaultWhat it does
TZAmerica/Los_AngelesTime zone for timestamps.
PUID1000User that owns the data folder.
PGID1000Group that owns the data folder.
AUTH_USERNAMESign-in username from the environment instead of creating an account. Set with AUTH_PASSWORD.
AUTH_PASSWORDSign-in password from the environment. Set with AUTH_USERNAME.
AUTH_DISABLEDfalseTurns off sign-in. Only use this behind a proxy that handles it.

⁠🛠️ First-time setup

Open http://<your-server>:7676 and create your account. Everything else happens on the Configuration page:

  1. Add a media server with its URL and token or API key. For Plex you can sign in with your Plex account instead of pasting a token.

  2. Add a download client with two pairs of rates:

    • Default rates, applied when nothing is playing.
    • Throttled rates, applied while a mapped server is playing.

    Rates are in KB/s, and 0 means unlimited.

  3. Map them. Choose which media servers throttle which download clients.

⁠License

GPL-3.0⁠

Made with ❤️ by JaiMistry⁠

Tag summary

Content type

Image

Digest

sha256:6499f6b40…

Size

6.9 MB

Last updated

3 days ago

docker pull jaimistry/autothrottle