2022-07-09 08:13:19 +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.
|
|
|
|
-->
|
|
|
|
|
2022-07-09 08:13:25 +02:00
|
|
|
# LibreX for YunoHost
|
2022-07-09 08:13:19 +02:00
|
|
|
|
2023-05-22 20:42:28 +02:00
|
|
|
[![Integration level](https://dash.yunohost.org/integration/librex.svg)](https://dash.yunohost.org/appci/app/librex) ![Working status](https://ci-apps.yunohost.org/ci/badges/librex.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/librex.maintain.svg)
|
|
|
|
|
2022-07-09 08:13:25 +02:00
|
|
|
[![Install LibreX with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=librex)
|
2022-07-09 08:13:19 +02:00
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
2022-07-09 08:13:25 +02:00
|
|
|
> *This package allows you to install LibreX quickly and simply on a YunoHost server.
|
2022-07-09 08:13:19 +02:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2022-07-09 08:13:25 +02:00
|
|
|
LibreX gives you results from Google, Qwant and popular torrent sites without spying on you.
|
2022-07-09 08:13:19 +02:00
|
|
|
|
|
|
|
### Features
|
|
|
|
|
2022-07-09 08:31:01 +02:00
|
|
|
- Ad & JavaScript free
|
|
|
|
- Torrent results from popular torrent sites
|
|
|
|
- Tracking snippets from URLs are removed
|
|
|
|
- Popular social media sites (YouTube, Instagram, Twitter etc.) are replaced with privacy friendly front-ends
|
|
|
|
- No 3rd party libs are used
|
2022-07-09 08:13:19 +02:00
|
|
|
|
|
|
|
|
2023-11-14 16:35:30 +01:00
|
|
|
**Shipped version:** 2023.11.14~ynh1
|
2022-08-15 19:19:15 +02:00
|
|
|
|
2023-11-14 16:36:31 +01:00
|
|
|
**Demo:** https://librey.devol.it/
|
|
|
|
|
2022-07-09 08:13:19 +02:00
|
|
|
## Screenshots
|
|
|
|
|
2022-07-09 08:13:25 +02:00
|
|
|
![Screenshot of LibreX](./doc/screenshots/screenshot.png)
|
2022-07-09 08:13:19 +02:00
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
|
2022-07-09 08:13:25 +02:00
|
|
|
* Official admin documentation: <https://github.com/hnhx/librex/wiki>
|
|
|
|
* Upstream app code repository: <https://github.com/hnhx/librex>
|
2023-10-31 15:19:44 +01:00
|
|
|
* YunoHost Store: <https://apps.yunohost.org/app/librex>
|
2022-07-09 08:13:25 +02:00
|
|
|
* Report a bug: <https://github.com/YunoHost-Apps/librex_ynh/issues>
|
2022-07-09 08:13:19 +02:00
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
2022-07-09 08:13:25 +02:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/librex_ynh/tree/testing).
|
2022-07-09 08:13:19 +02:00
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
|
|
|
|
``` bash
|
2022-07-09 08:13:25 +02:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/librex_ynh/tree/testing --debug
|
2022-07-09 08:13:19 +02:00
|
|
|
or
|
2022-07-09 08:13:25 +02:00
|
|
|
sudo yunohost app upgrade librex -u https://github.com/YunoHost-Apps/librex_ynh/tree/testing --debug
|
2022-07-09 08:13:19 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|