mirror of
https://github.com/idanoo/autobrr
synced 2025-07-22 16:29:12 +00:00
docs: readme improvements and additions (#1262)
* docs: improve readme added a ToC, section for contributing etc. * docs: merged rss and usenet sections * docs: fixed dead link to installation guide
This commit is contained in:
soup
GitHub
parent
2cef58c8de
commit
e9e59b38b9
1 changed files with 110 additions and 60 deletions
170
README.md
170
README.md
|
|
@ -3,8 +3,7 @@
|
|||
autobrr
|
||||
</h1>
|
||||
|
||||
<p align="center">autobrr is the modern download automation tool for torrents and usenet.
|
||||
With inspiration and ideas from tools like trackarr, autodl-irssi and flexget we built one tool that can do it all, and then some.</p>
|
||||
<p align="center">autobrr redefines download automation for torrents and Usenet, drawing inspiration from tools like trackarr, autodl-irssi, and flexget. We've combined the best of these worlds into one versatile tool that can do it all, and then some.</p>
|
||||
|
||||
<p align="center"><img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/autobrr/autobrr?style=for-the-badge"> <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/autobrr/autobrr/total?style=for-the-badge"> <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/autobrr/autobrr/release.yml?style=for-the-badge"></p>
|
||||
|
||||
|
|
@ -13,38 +12,28 @@ With inspiration and ideas from tools like trackarr, autodl-irssi and flexget we
|
|||
|
||||
## Documentation
|
||||
|
||||
Installation guide and documentation can be found at https://autobrr.com
|
||||
Full documentation can be found at https://autobrr.com
|
||||
|
||||
## Key features
|
||||
## Table of Contents
|
||||
1. [What Is Autobrr?](#what-is-autobrr)
|
||||
2. [Key Features](#key-features)
|
||||
- [Available Download Clients and Actions](#available-download-clients-and-actions)
|
||||
- [RSS and Usenet Support](#rss-and-usenet-support)
|
||||
4. [Installation](#installation)
|
||||
- [Swizzin](#swizzin)
|
||||
- [Saltbox](#saltbox)
|
||||
- [QuickBox](#quickbox)
|
||||
- [Shared Seedbox](#shared-seedbox)
|
||||
- [Docker Compose](#docker-compose)
|
||||
- [Windows](#windows)
|
||||
- [Linux Generic](#linux-generic)
|
||||
5. [Community](#community)
|
||||
6. [Contributing](#contributing)
|
||||
6. [License](#license)
|
||||
|
||||
- Torrents and usenet support
|
||||
- Support for 75+ torrent trackers with IRC announces
|
||||
- Newznab, Torznab and RSS support to easily get access to hundreds of torrent and usenet indexers
|
||||
- Torrent Magnet support
|
||||
- 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, Pushover, Gotify)
|
||||
- One autobrr instance can communicate with multiple clients (torrent, usenet and \*arr) on remote servers
|
||||
- Base path / Subfolder (and subdomain) support for convenient reverse-proxy support
|
||||
## What Is Autobrr?
|
||||
|
||||
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)
|
||||
- SABnzbd (usenet)
|
||||
- Watch folder
|
||||
- Exec custom scripts
|
||||
- Webhook
|
||||
|
||||
## What is autobrr and how does it fit into the ecosystem?
|
||||
What is autobrr, and how does it fit into the ecosystem?
|
||||
|
||||
We can start by talking about torrent trackers (hereby referred to as indexers) and maintaining ratio. You are required
|
||||
to maintain a ratio with most indexers. Ratio is built by seeding your torrents. The earlier you're seeding a torrent,
|
||||
|
|
@ -65,15 +54,39 @@ want, and then forward it to the torrent client they are set up with.
|
|||
autobrr can also send matches (torrent files that meets your filter's criteria) directly to torrent clients like
|
||||
qBittorrent, Deluge, r(u)Torrent and Transmission. You don't need to use the *arr suite to make use of autobrr.
|
||||
|
||||
### RSS support for indexers without an IRC announcer
|
||||
## Key Features
|
||||
|
||||
- Torrents and Usenet support
|
||||
- Support for 75+ torrent trackers with IRC announces
|
||||
- Newznab, Torznab and RSS support to easily get access to hundreds of torrent and Usenet indexers
|
||||
- Torrent Magnet support
|
||||
- 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, Pushover, Gotify)
|
||||
- One autobrr instance can communicate with multiple clients (torrent, Usenet and \*arr) on remote servers
|
||||
- Base path / Subfolder (and subdomain) support for convenient reverse-proxy support
|
||||
|
||||
### Available Download Clients and Actions
|
||||
|
||||
- **qBittorrent:** Includes built-in re-announce, categories, rules, max active downloads, etc.
|
||||
- **Deluge v1+ and v2+**
|
||||
- **rTorrent**
|
||||
- **Transmission**
|
||||
- **Porla**
|
||||
- **Sonarr, Radarr, Lidarr, Whisparr, Readarr:** Pushes releases directly for early swarm participation, rather than relying on RSS feeds.
|
||||
- **SABnzbd (Usenet):** Integrates smoothly for Usenet downloads.
|
||||
- **Watch Folder:** Monitors specified folders for new files.
|
||||
- **Exec Custom Scripts:** Execute tailored scripts for advanced automation.
|
||||
- **Webhook:** Offers webhook support for diverse integration needs.
|
||||
|
||||
### RSS and Usenet Support
|
||||
|
||||
A lot of indexers do not announce new torrents in an IRC channel. You can still make use of these indexers with autobrr
|
||||
since it has built in support for feeds as well. Both torznab and regular RSS is supported. RSS indexers are treated the
|
||||
same way as regular indexers within autobrr.
|
||||
|
||||
This isn't needed if your use case is feeding the *arrs only. Since they have RSS support already.
|
||||
|
||||
### Usenet support
|
||||
since it has built in support for feeds as well. Both Torznab, Newznab and regular RSS is supported. RSS indexers are treated the same way as regular indexers within autobrr.
|
||||
|
||||
Usenet support via Newznab feeds allows you to easily manage everything in a single application. While there is a lot of
|
||||
applications that handles RSS well, we think autobrr offers very easy to use filtering to help you get the content you
|
||||
|
|
@ -83,10 +96,10 @@ You can use Usenet feeds and send to arrs or send directly to SABnzbd.
|
|||
|
||||
## Installation
|
||||
|
||||
Full installation guide and documentation can be found at https://autobrr.com
|
||||
For comprehensive installation instructions, visit our [Installation Guide](https://autobrr.com/installation/linux). This guide provides detailed steps for different platforms, including Windows, Linux, Docker, and more.
|
||||
|
||||
Remember to head over to our [Configuration Guide](https://autobrr.com/configuration/autobrr) to learn how to set up your indexers, IRC, and download clients after you're done installing.
|
||||
|
||||
Remember to head over to our [Configuration Guide](https://autobrr.com/configuration/autobrr) to learn how to set up
|
||||
your indexers, IRC, and download clients after you're done installing.
|
||||
|
||||
### Swizzin
|
||||
|
||||
|
|
@ -117,19 +130,20 @@ qb install autobrr -u ${username}
|
|||
For more info check
|
||||
the [docs](https://quickbox.io/knowledge-base/v3/applications-v3/autobrr-applications-v3/autobrr-quick-reference/)
|
||||
|
||||
### Shared seedbox
|
||||
### Shared Seedbox
|
||||
|
||||
##### One-click installer & Quick installer
|
||||
#### One-Click Installer & Quick Installer
|
||||
|
||||
- HostingByDesign (former Seedbox.io) via box
|
||||
- Seedit4.me
|
||||
- SeedHost.eu
|
||||
- Ultra.cc
|
||||
|
||||
##### Install scripts
|
||||
We have support for a couple other providers out of the box.
|
||||
In case your provider is missing then please contact us on [Discord](https://discord.gg/WQ2eUycxyT), so we can add support.
|
||||
The scripts require some input but do most of the work.
|
||||
##### Installation Scripts
|
||||
|
||||
We have support for a couple of other providers out of the box.
|
||||
Please contact us on [Discord](https://discord.gg/WQ2eUycxyT) if your provider is missing.
|
||||
The scripts require some input, but do most of the work.
|
||||
|
||||
#### Swizzin.net
|
||||
|
||||
|
|
@ -143,7 +157,7 @@ The scripts require some input but do most of the work.
|
|||
|
||||
wget https://gobrr.sh/install_feral && bash install_feral
|
||||
|
||||
#### Bytesized hosting
|
||||
#### Bytesized Hosting
|
||||
|
||||
wget https://gobrr.sh/install_bytesized && bash install_bytesized
|
||||
|
||||
|
|
@ -154,9 +168,9 @@ on [Discord](https://discord.gg/WQ2eUycxyT)
|
|||
|
||||
wget https://gobrr.sh/install_sbio && bash install_sbio
|
||||
|
||||
### Docker compose
|
||||
### Docker Compose
|
||||
|
||||
docker-compose for autobrr. Modify accordingly if running with unRAID or setting up with Portainer.
|
||||
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
|
||||
|
|
@ -182,15 +196,17 @@ services:
|
|||
- 7474:7474
|
||||
```
|
||||
|
||||
Then start with
|
||||
Then start with:
|
||||
|
||||
docker compose up -d
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
Check the windows setup guide [here](https://autobrr.com/installation/windows)
|
||||
Check the Windows Setup Guide [here](https://autobrr.com/installation/windows).
|
||||
|
||||
### Linux generic
|
||||
### Linux Generic
|
||||
|
||||
Download the latest release, or download the [source code](https://github.com/autobrr/autobrr/releases/latest) and build
|
||||
it yourself using `make build`.
|
||||
|
|
@ -201,8 +217,7 @@ wget $(curl -s https://api.github.com/repos/autobrr/autobrr/releases/latest | gr
|
|||
|
||||
#### 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`.
|
||||
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`.
|
||||
|
||||
```bash
|
||||
tar -C /usr/local/bin -xzf autobrr*.tar.gz
|
||||
|
|
@ -254,9 +269,44 @@ If you are not running a reverse proxy change `host` in the `config.toml` to `0.
|
|||
|
||||
## Community
|
||||
|
||||
Come join us on [Discord](https://discord.gg/WQ2eUycxyT)!
|
||||
Join our friendly and welcoming community on [Discord](https://discord.gg/WQ2eUycxyT)! Connect with fellow autobrr users, get advice, and share your experiences. Whether you're seeking help, wanting to contribute, or just looking to discuss your ideas, our community is a hub of discussion and support. We're all here to help each other out, so don't hesitate to jump in!
|
||||
|
||||
## License
|
||||
## Contributing
|
||||
|
||||
* [GNU GPL v2 or later](https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html)
|
||||
* Copyright 2021-2023
|
||||
Whether you're fixing a bug, adding a feature, or improving documentation, your help is appreciated. Here's how you can contribute:
|
||||
|
||||
### Reporting Issues and Suggestions
|
||||
|
||||
- **Report Bugs:** Encountered a bug? Please report it using our [bug report template](/.github/ISSUE_TEMPLATE/bug_report.md). Include detailed steps to reproduce, expected behavior, and any relevant screenshots or logs.
|
||||
- **Feature Requests:** Submit it using our [feature request template](/.github/ISSUE_TEMPLATE/feature_request.md). Describe your idea and how it will improve `autobrr`.
|
||||
|
||||
### Code Contributions
|
||||
|
||||
- **Fork and Clone:** Fork the `autobrr` repository and clone it to start working on your changes.
|
||||
- **Branching:** Create a new branch for your changes. Use a descriptive name for easy understanding.
|
||||
- **Coding:** Ensure your code is well-commented for clarity.
|
||||
- **Commit Guidelines:** We appreciate the use of [Conventional Commit Guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) when writing your commits.
|
||||
- There is no need for force pushing or rebasing. We squash commits on merge to keep the history clean and manageable.
|
||||
- **Pull Requests:** Submit a pull request with a clear description of your changes. Reference any related issues.
|
||||
- **Code Review:** Be open to feedback during the code review process.
|
||||
|
||||
### Documentation
|
||||
|
||||
See an area that needs clarity or additional information? Feel free to update our documentation [here](https://github.com/autobrr/autobrr.com).
|
||||
|
||||
<!--
|
||||
### Code of Conduct
|
||||
|
||||
- **Respectful Interaction:** We follow a code of conduct that promotes respectful and harassment-free experiences. Please read [our Code of Conduct](CODE_OF_CONDUCT.md) before participating.
|
||||
-->
|
||||
|
||||
## License
|
||||
|
||||
autobrr is proudly open-source and is released under the [GNU General Public License v2 or later (GPLv2+)](https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html). This license allows you the freedom to run, study, share, and modify the software:
|
||||
|
||||
- **Freedom to Run:** You can run autobrr in any environment, for any purpose.
|
||||
- **Freedom to Study and Modify:** Access to the source code allows you to study and modify autobrr to suit your needs.
|
||||
- **Freedom to Share:** You can redistribute copies of autobrr to help others.
|
||||
- **Freedom to Enhance:** Contributions to improve autobrr are always welcome.
|
||||
|
||||
Copyright 2021-2023
|
||||
Loading…
Add table
Add a link
Reference in a new issue