mirror of
https://github.com/YunoHost-Apps/librespeed_ynh.git
synced 2024-09-03 19:36:23 +02:00
62 lines
2.3 KiB
Markdown
62 lines
2.3 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# LibreSpeed for YunoHost
|
|
|
|
[](https://ci-apps.yunohost.org/ci/apps/librespeed/)  
|
|
|
|
[](https://install-app.yunohost.org/?app=librespeed)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install LibreSpeed 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
|
|
|
|
Self-hosted Speed Test for HTML5 and more. Easy setup, examples, configurable, mobile friendly. Supports PHP, Node, Multiple servers, and more.
|
|
|
|
### Features
|
|
|
|
- Download
|
|
- Upload
|
|
- Ping
|
|
- Jitter
|
|
- IP Address, ISP, distance from server (optional)
|
|
- Telemetry (optional)
|
|
- Results sharing (optional)
|
|
- Multiple Points of Test (optional)
|
|
|
|
|
|
**Shipped version:** 5.4.1~ynh2
|
|
|
|
**Demo:** <https://librespeed.org>
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
- Official app website: <https://librespeed.org>
|
|
- Official user documentation: <https://github.com/librespeed/speedtest/wiki>
|
|
- Official admin documentation: <https://github.com/librespeed/speedtest/wiki>
|
|
- Upstream app code repository: <https://github.com/librespeed/speedtest>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/librespeed>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/librespeed_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade librespeed -u https://github.com/YunoHost-Apps/librespeed_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|