1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/autobrr_ynh.git synced 2024-09-03 18:15:56 +02:00
autobrr_ynh/README.md

48 lines
2 KiB
Markdown
Raw Normal View History

2023-04-15 22:17:26 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2023-04-15 22:17:30 +02:00
# Autobrr for YunoHost
2023-04-15 22:17:26 +02:00
2023-04-15 22:17:30 +02:00
[![Integration level](https://dash.yunohost.org/integration/autobrr.svg)](https://dash.yunohost.org/appci/app/autobrr) ![Working status](https://ci-apps.yunohost.org/ci/badges/autobrr.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/autobrr.maintain.svg)
[![Install Autobrr with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=autobrr)
2023-04-15 22:17:26 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2023-04-15 22:17:30 +02:00
> *This package allows you to install Autobrr quickly and simply on a YunoHost server.
2023-04-15 22:17:26 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2023-04-15 22:26:27 +02:00
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.
2023-04-15 22:17:26 +02:00
2023-04-15 22:17:30 +02:00
**Shipped version:** 1.23.0~ynh1
2023-04-15 22:17:26 +02:00
## Screenshots
2023-04-15 22:17:30 +02:00
![Screenshot of Autobrr](./doc/screenshots/autobrr-front.png)
2023-04-15 22:17:26 +02:00
## Documentation and resources
2023-04-15 22:17:30 +02:00
* Official app website: <https://autobrr.com/>
2023-04-15 22:26:27 +02:00
* Official admin documentation: <https://autobrr.com/installation/>
2023-04-15 22:17:30 +02:00
* Upstream app code repository: <https://github.com/autobrr/autobrr>
* YunoHost documentation for this app: <https://yunohost.org/app_autobrr>
* Report a bug: <https://github.com/YunoHost-Apps/autobrr_ynh/issues>
2023-04-15 22:17:26 +02:00
## Developer info
2023-04-15 22:17:30 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/autobrr_ynh/tree/testing).
2023-04-15 22:17:26 +02:00
To try the testing branch, please proceed like that.
``` bash
2023-04-15 22:17:30 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/autobrr_ynh/tree/testing --debug
2023-04-15 22:17:26 +02:00
or
2023-04-15 22:17:30 +02:00
sudo yunohost app upgrade autobrr -u https://github.com/YunoHost-Apps/autobrr_ynh/tree/testing --debug
2023-04-15 22:17:26 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>