Code Monkey home page Code Monkey logo

docker-rutorrent's Introduction

docker-rutorrent

Github Docker Version Travis-CI Services
AlpineLinux rTorrent ruTorrent FileBot

Docker rTorrent + ruTorrent + Filebot

Image of origin comes from xataz: docker-rtorrent-rutorrent

Image djerfy/rutorrent:latest use ruTorrent v3.10-beta (works with rTorrent v0.9.8) but stable for use

Features

  • Based on Alpine Linux
  • Tools compiled from sources
  • Filebot is included by default
  • No root process
  • Save custom configuration rTorrent and ruTorrent
  • Logs in output (Supervisor, Nginx, PHP-FPM, rTorrent)
  • Various plugins activated (GeoIP, ratiocolor, showip, checksfs, ...)

Tags

Description

What is ruTorrent?

  • ruTorrent is a frontend for popular Bittorent client rtorrent.
  • This project is released under the GPLv3 license, for more details, see at the LICENSE.md file in the source code.

What is rTorrent?

  • rTorrent is the popular Bittorrent client.

Configuration

Environments

  • UID: define uid to running services (default: 991)
  • GID: define gid to running services (default: 991)
  • WEBROOT: default URI access ruTorrent (default: /)
  • BASEURL: default URL access ruTorrent (default: localhost)
  • BASEURL_SCHEME: default scheme access ruTorrent (default: http)
  • BASEURL_USER: define htpasswd username (default: none)
  • BASEURL_PASS: define htpasswd password (default: none)
  • RTORRENT_PORT: port used for rTorrent (default: 6881)
  • RTORRENT_DHT: if DHT is to be used (default: off)
  • FILEBOT_FOLDER: define emplacement to create files (default: Media)
  • FILEBOT_METHOD: method for rename media (default: symlink)
  • FILEBOT_MOVIES: regex for rename movies (default: "{n} ({y})")
  • FILEBOT_MUSICS: regex for rename musics (default: "{n}/{fn}")
  • FILEBOT_SERIES: regex for rename tvshow (default: "{n}/Season {s.pad(2)}/{s00e00} - {t}")
  • FILEBOT_ANIMES: regex for rename animes (default: "{n}/{e.pad(3)} - {t}")
  • FILEBOT_LICENSE_FILE: define the license file (default: none)
  • FILEBOT_EXCLUDE_FILE: define the exclude file, related with $FILEBOT_FOLDER (default: /data/Media/amc.excludes)
  • FILEBOT_SCRIPT: execute script after executing filebot command (default: no)
  • FILEBOT_SCRIPT_DIR: define emplacement to have script postexec (default: null)
  • FILEBOT_LANG: define language used for filebot (default: en)
  • FILEBOT_CONFLICT: define actions for conflicts (default: skip)
  • DEBUG: running with debug output (bool) (default: false)
  • SKIP_PERMS: don't apply chown on medias (movies, tvshow, animes, ...) (default: no)
  • EXECUTE_CUSTOM_COMMANDS: execute custom actions, ex apk add -U package && rm -rf /tmp/test (default: none)
  • GEOIP_ACCOUNT_ID: account required to download geoip databases (read GeoIP section) (default: none)
  • GEOIP_LICENSE_KEY: license required (free) to download geoip databases (read GeoIP section) (default: none)

Volumes

  • /data: folder for download torrents
  • /config: folder for rTorrent and ruTorrent configuration

Ports

  • 8080: ruTorrent interface
  • 6881: rTorrent (override with RTORRENT_PORT)

GeoIP

To receive a free license and to download the GeoLite2 databases (City/Country) sign up for a GeoLite2 account here. More details on this page.

In the left menu, select Services and My License Key. Here generate a new license key, in the output you have ACCOUNT ID and LICENSE KEY.

Usage

Basic

Access to ruTorrent interface: http://xxx.xxx.xxx.xxx:8080/

docker container run -d --name rutorrent -p 8080:8080 -p 6881:6881 djerfy/rutorrent:latest

Advanced

With custom values:

docker container run -d \
    --name rutorrent \
    -p 8080:8080 \
    -p 9999:9999 \
    -e WEBROOT=/ \
    -e BASEURL=seedbox.example.com \
    -e BASEURL_SCHEME=https \
    -e RTORRENT_DHT=on \
    -e RTORRENT_PORT=9999 \
    -e FILEBOT_METHOD=move \
    -e GEOIP_ACCOUNT_ID=123456 \
    -e GEOIP_LICENSE_KEY=AZERTY123 \
    -e UID=1001 \
    -e GID=1001 \
    -e DEBUG=true \
    -v $(pwd)/data/data:/data \
    -v $(pwd)/data/config:/config \
    djerfy/rutorrent:latest

Tests

Docker image is built and tested via Travis CI. Status of the last build Build Status

By default the last build (success) is pushed into Docker Hub with tag nightly (djerfy/rutorrent:nightly).

Contributing

Any contributions, are very welcome!

docker-rutorrent's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.