1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/opentracker_ynh.git synced 2024-09-03 19:46:34 +02:00
opentracker_ynh/README.md

72 lines
2.5 KiB
Markdown
Raw Normal View History

2020-12-24 23:36:49 +01:00
# OpenTracker for YunoHost
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
[![Integration level](https://dash.yunohost.org/integration/opentracker.svg)](https://dash.yunohost.org/appci/app/opentracker) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/opentracker.maintain.svg)
[![Install OpenTracker with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=opentracker)
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
> *This package allows you to install OpenTracker 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.*
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
## Overview
2021-01-27 18:40:35 +01:00
OpenTracker is a open and free bittorrent tracker project. It aims for minimal resource usage.
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
**Shipped version:** 1.0
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
## Screenshots
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
![](Link to a screenshot of this app.)
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
## Configuration
2019-04-11 11:17:42 +02:00
2021-01-27 23:01:09 +01:00
`udp://serverIP:6969`
2019-04-11 11:17:42 +02:00
2020-12-25 14:39:16 +01:00
by default the tracker will run on 6969 port on both UDP and TCP.
2021-01-27 23:26:05 +01:00
visit `http://serverIP:6969/stats` to view the tracker stats.
2020-12-25 14:39:16 +01:00
2020-12-24 23:36:49 +01:00
## Documentation
2019-04-11 11:17:42 +02:00
2020-12-24 23:36:49 +01:00
* Official documentation: http://erdgeist.org/arts/software/opentracker/index/#overview
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
#### Multi-user support
2021-01-27 23:26:05 +01:00
* Are LDAP and HTTP auth supported? **NO**
* Can the app be used by multiple users? **NO**
2020-12-24 23:36:49 +01:00
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/opentracker%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/opentracker/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/opentracker%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/opentracker/)
## Limitations
* Any known limitations.
## Additional information
* Other info you would like to add about this app.
## Links
* Report a bug: https://github.com/YunoHost-Apps/opentracker_ynh/issues
* App website: http://erdgeist.org/arts/software/opentracker/
* Upstream app repository: http://erdgeist.org/gitweb/opentracker/
* YunoHost website: https://yunohost.org/
---
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing --debug
or
sudo yunohost app upgrade opentracker -u https://github.com/YunoHost-Apps/opentracker_ynh/tree/testing --debug
```