Giter VIP home page Giter VIP logo

autobrr's Introduction

autobrr logo
autobrr

autobrr is the modern download automation tool for torrents. With inspiration and ideas from tools like trackarr, autodl-irssi and flexget we built one tool that can do it all, and then some.

GitHub release (latest by date) GitHub all releases GitHub Workflow Status

autobrr ui

Documentation

Installation guide and documentation can be found at https://autobrr.com

Key features

  • Support for 45+ trackers with IRC announces
  • Torznab/RSS support via Prowlarr to easily get access to hundreds of trackers
  • Powerful but simple filtering with RegEx support (like in autodl-irssi)
  • Easy to use and mobile friendly web UI (with dark mode!) to manage everything
  • Built on Go and React making autobrr lightweight and perfect for supporting multiple platforms (Linux, FreeBSD, Windows, macOS) on different architectures (e.g. x86, ARM)
  • Great container support (Docker, k8s/Kubernetes)
  • Database engine supporting both PostgreSQL and SQLite
  • Notifications (Discord, Telegram, Notifiarr)
  • One autobrr instance can communicate with multiple clients (both torrent and *arr) on remote servers
  • Base path / Subfolder (and subdomain) support for convenient reverse-proxy support

Available download clients and actions

  • qBittorrent (with built in re-announce, categories, rules, max active downloads, etc)
  • Deluge v1+ and v2+
  • rTorrent
  • Transmission
  • Sonarr, Radarr, Lidarr, Whisparr and Readarr (pushes releases directly to them and gets in the early swarm, instead of getting them via RSS when it's already over)
  • Watch folder
  • Exec custom scripts
  • Webhook

Installation

Full installation guide and documentation can be found at https://autobrr.com

Remember to head over to our Configuration Guide to learn how to set up your indexers, IRC, and download clients after you're done installing.

Swizzin

Swizzin users can simply run:

sudo box install autobrr

Saltbox

Saltbox users can simply run:

sb install sandbox-autobrr

For more info check the docs

QuickBox (v3)

QuickBox users can simply run:

qb install autobrr -u ${username}

For more info check the docs

Shared seedbox

We have support for a couple of providers out of the box and if yours are missing then please write on Discord so we add support.

The scripts require some input but does most of the work.

Seedbox.io

curl https://gobrr.sh/install_sbio | bash

Swizzin.net

curl https://gobrr.sh/install_sbio | bash

Ultra.cc

curl https://gobrr.sh/install_ultra | bash

WhatBox

curl https://gobrr.sh/install_whatbox | bash

Other providers

For other providers the Seedboxio installer should work. If not, open an issue or contact us on Discord

curl https://gobrr.sh/install_sbio | bash

Docker compose

docker-compose for autobrr. Modify accordingly if running with unRAID or setting up with Portainer.

  • Logging is optional
  • Host port mapping might need to be changed to not collide with other apps
  • Change BASE_DOCKER_DATA_PATH to match your setup. Can be simply ./data
  • Set custom network if needed

Create docker-compose.yml and add the following. If you have a existing setup change to fit that.

version: "3.7"

services:
  autobrr:
    container_name: autobrr
    image: ghcr.io/autobrr/autobrr:latest
    restart: unless-stopped
    environment:
      - PUID=${PUID}
      - PGID=${GUID}
      - TZ=${TZ}
    volumes:
      - ${BASE_DOCKER_DATA_PATH}/autobrr/config:/config
    ports:
      - 7474:7474

Then start with

docker compose up -d

Windows

Check the windows setup guide here

Linux generic

Download the latest release, or download the source code and build it yourself using make build.

wget $(curl -s https://api.github.com/repos/autobrr/autobrr/releases/latest | grep download | grep linux_x86_64 | cut -d\" -f4)

Unpack

Run with root or sudo. If you do not have root, or are on a shared system, place the binaries somewhere in your home directory like ~/.bin.

tar -C /usr/local/bin -xzf autobrr*.tar.gz

This will extract both autobrr and autobrrctl to /usr/local/bin. Note: If the command fails, prefix it with sudo and re-run again.

Systemd (Recommended)

On Linux-based systems, it is recommended to run autobrr as sort of a service with auto-restarting capabilities, in order to account for potential downtime. The most common way is to do it via systemd.

You will need to create a service file in /etc/systemd/system/ called autobrr.service.

touch /etc/systemd/system/[email protected]

Then place the following content inside the file (e.g. via nano/vim/ed):

[Unit]
Description=autobrr service for %i
After=syslog.target network-online.target

[Service]
Type=simple
User=%i
Group=%i
ExecStart=/usr/bin/autobrr --config=/home/%i/.config/autobrr/

[Install]
WantedBy=multi-user.target

Start the service. Enable will make it startup on reboot.

systemctl enable -q --now --user autobrr

It's highly advised to put it behind a reverse-proxy like nginx or traefik etc.

Community

Come join us on Discord!

autobrr's People

Contributors

3744111 avatar agneevx avatar alexkmdev avatar ckcr4lyf avatar deruntote avatar f4n4t avatar ghostserverd avatar gl0ryus avatar gregtroar avatar handsomematt avatar kaiserbh avatar kylesanderson avatar lancehilliard avatar ludviglundgren avatar martylukyy avatar paperclip-go-brr avatar quorn23 avatar shapechecker avatar slingamn avatar smallobject avatar sweetmnm avatar tmd20 avatar varoop avatar vktr avatar voltron4lyfe avatar yanando avatar zmiguel avatar zze0s avatar

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.