<!--
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.
-->

# PeerTube Remote Runner for YunoHost

[![Integration level](https://dash.yunohost.org/integration/peertube_remote_runner.svg)](https://dash.yunohost.org/appci/app/peertube_remote_runner) ![Working status](https://ci-apps.yunohost.org/ci/badges/peertube_remote_runner.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/peertube_remote_runner.maintain.svg)

[![Install PeerTube Remote Runner with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=peertube_remote_runner)

*[Read this README in other languages.](./ALL_README.md)*

> *This package allows you to install PeerTube Remote Runner quickly and simply on a YunoHost server.*  
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*

## Overview

Remote runner to offload heavy workloads jobs (such as transcoding) from one or several (distant) Peertube server.


**Shipped version:** 1.0~ynh2
## Documentation and resources

- Official app website: <https://docs.joinpeertube.org/admin/remote-runners>
- Official admin documentation: <https://docs.joinpeertube.org/maintain/tools#peertube-runner>
- Upstream app code repository: <https://github.com/Chocobozzz/PeerTube/tree/develop/packages/peertube-runner>
- YunoHost Store: <https://apps.yunohost.org/app/peertube_remote_runner>
- Report a bug: <https://github.com/YunoHost-Apps/peertube_remote_runner_ynh/issues>

## Developer info

Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/peertube_remote_runner_ynh/tree/testing).

To try the `testing` branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/peertube_remote_runner_ynh/tree/testing --debug
or
sudo yunohost app upgrade peertube_remote_runner -u https://github.com/YunoHost-Apps/peertube_remote_runner_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>