Skip to content

Latest commit

 

History

History
130 lines (84 loc) · 4.79 KB

README.md

File metadata and controls

130 lines (84 loc) · 4.79 KB
Raw

🍿 Bobarr

The all-in-one alternative for Sonarr, Radarr, Jackett... with a VPN and running in docker

Bobarr is a movies and tv shows collection manager for BitTorrent users. It uses themoviedb.org to search movies and tv shows to add to your library. Then it searchs into your favorites torrent trackers the best match and downloads it for you through a VPN.

Screenshot

This is a beta release!

Need help? Join the discord => https://discord.gg/PFwM4zk

Why ?

One of the main idea for bobarr is to be simple to setup, simple to use and having everything at the same place. You don't have to choose a torrent client, to setup a VPN, to setup radarr, sonarr, then jackett and connect them all together.

It's also built from scratch and it will try to solve long term problem like download multiple qualities and keep them or managing tvshows and movies at the same place. You can follow the roadmap to check what next features are implemented.

And to have something with a better ui, less configuration and faster 🚀

Setup

Requirement

Installation

  1. Clone the repo $ git clone https://github.com/iam4x/bobarr.git && cd bobarr
  2. Set PUID and PGID in .env (see .env for explanation)
  3. (Optional) If you already have a library (/movies & /tvshows) edit docker-compose.yml: Look for - ./library:/usr/library, and change ./library to the folder where your (/movies & /tvshows) are.

As example, having:

/mnt/storage/
|- movies/
|- tvshows/

The line should be: - /mnt/storage:/usr/library

How to start

There are two way to start bobarr stack, first without VPN:

If you want to enforce all torrent traffic through a VPN:

OpenVPN

  • Copy your open vpn config file (.ovpn) into the folder packages/vpn name it vpn.conf
  • $ docker-compose -f docker-compose.yml -f docker-compose.vpn.yml up --build --force-recreate -d

If you have NPM you can just run $ npm run start or $ npm run start:vpn

WireGuard

  • Copy your wireguard config file (wg0.conf) into the folder packages/vpn
  • $ docker-compose -f docker-compose.yml -f docker-compose.wireguard.yml up --build --force-recreate -d

If you have NPM you can just run $ npm run start or $ npm run start:wireguard

Configuration

Torrent account

Bobarr configuration

  • Go to http://localhost:3000/settings
  • Set your region and language according to your torrent tracker
  • Create and order your preferred tags found in torrent file (ex: vost, multi, english...)
  • Order your preferred qualities to download

Usage

  • After configuration, go to http://localhost:3000/search and just start searching!
  • The files will be downloaded into library/downloads
  • The files will be moved/copied/simlinked (you can set this in settings) and organized into library/tvshows or library/movies

The only requirement is to have a folder tvshows and a folder movies then bobarr can catch up and download to your user defined library folder.

If your movies or tvshow folder have a different name, you can edit .env file with your folder names:

LIBRARY_MOVIES_FOLDER_NAME=movies
LIBRARY_TV_SHOWS_FOLDER_NAME=tvshows

You can now head to http://localhost:3000 and hit that "Scan library folder" button.

How to update

Since bobarr is still in early development and hasn't reached a state where an updater is already built-in you have to update from sources. You need to pull master to get latest changes, something can break, you are a beta tester 😎

  • $ cd bobarr
  • $ git stash (will keep your changes of docker-compose or transmission config)
  • $ git pull origin master
  • $ git stash apply (re-apply your custom changes)

You can then re-start bobarr stack:

  • $ docker-compose up --build --force-recreate -d
  • OR with VPN $ docker-compose -f docker-compose.yml -f docker-compose.vpn.yml up --build --force-recreate -d

Services

Development

You can run bobarr API and Web UI in dev watch mode and display logs with:

  • With npm
    • $ yarn dev
  • Without npm
    • $ docker-compose up -f docker-compose.yml -f docker-compose.dev.yml up --force-recreate -d
    • $ docker-compose logs --tail 20 -f api web