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

63 lines
2.5 KiB
Markdown
Raw Normal View History

2021-05-23 12:01:50 +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.
-->
2020-11-09 22:28:22 +01:00
# Invidious for YunoHost
2021-06-19 18:36:44 +02:00
[![Integration level](https://dash.yunohost.org/integration/invidious.svg)](https://dash.yunohost.org/appci/app/invidious) ![](https://ci-apps.yunohost.org/ci/badges/invidious.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/invidious.maintain.svg)
[![Install Invidious with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=invidious)
2020-11-09 22:28:22 +01:00
*[Lire ce readme en français.](./README_fr.md)*
2021-06-19 18:36:44 +02:00
> *This package allows you to install Invidious quickly and simply on a YunoHost server.
2020-11-09 22:28:22 +01:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
2021-09-29 21:41:07 +02:00
Invidious is an interface allowing access to Youtube videos without going through youtube.com
In addition to constituting an advantage in terms of confidentiality (the data does not pass directly through the services of the giant), this interface offers several features:
- Audio only mode,
- Dark mode,
- Ability to display Reddit comments instead of YouTube comments,
- Ability to subscribe to channels without creating a Google account
2020-11-09 22:28:22 +01:00
2021-09-29 21:41:07 +02:00
Testing (#86) * Fix linter warnings * Update README.md * Update README.md delete App website (it's down) brought link in line 26 and 30 up to date with link to new place of documentation * Change version * Update links * Finding an available port * Add more_set_headers to NGINX conf * Silencing PostgreSQL warnings * Update nginx.conf * Update nginx.conf * Make `/embed/` links work properly (#8) Gives them the right headers and redirects them to the right place * Update manifest.json * fix * Update restore * Update install * Fix * Update install * Fix * Update install * Fix * Fix * Update check_process * Fix embeds again (#12) * Fix embeds again * Remove extra repo (#14) * Remove extra repo * Update manifest.json * Cleaning up * Patch * Fix * Fix * Fix * Update manifest.json * Update upgrade * Fix * Preserve config file and protect it * Fix permissions * Fix * Fix * fix * Update README.md (#28) .yml iso .yaml file * Fix * Update install * [autopatch] Update issue and PR templates (#32) Co-authored-by: Yunohost-Bot <> * [autopatch] Update issue and PR templates (#33) Co-authored-by: Yunohost-Bot <> * Fix * Fix * Update install * Auto-update README * Update install * Fix * Update _common.sh * Fix * Auto-update README * Fix * Fix * Create change_url * Fix * Update nginx.conf * Update check_process * Auto-update README * Auto-update README * upgrade crystal * Auto-update README * Update restore * Update upgrade * Update upgrade * Revert "Update upgrade" This reverts commit f533eb02cb99848aadab99afeb3ee5134073fab4. * Update upgrade * Update check_process * Add limitations * Auto-update README * New config file (#44) * Add config * Update check_process * From git commit (#46) * from commit * Fix doc link * Auto-update README * Update upgrade * Update config.yml * Update manifest.json * Auto-update README * Version bump (#54) * upgrade * Update restore * Add description * Auto-update README * config.yml may not exist during upgrade (#58) * Update systemd.service * Update manifest.json * Update manifest.json * Auto-update README * Reorder * Update _common.sh * Fix * Update Crystal (#63) * Update Crystal * Update install * Fix * Update _common.sh * Update _common.sh * 4.3 * Auto-update README * Upgrade * Auto-update README * Config panel (#72) * Add config panel * Update _common.sh * Fix * Auto-update README * upgrade to upstream * Auto-update README * Update _common.sh * Update manifest.json * Auto-update README * Update _common.sh * Update manifest.json * Auto-update README * Bugfix #77 by replace "shards" command (#79) * Bugfix #77 by "shards install" with "--production" See: https://github.com/iv-org/invidious/issues/2918#issuecomment-1048146335 * Upgrade to upstream * Auto-update README * Update check_process * 22.03.03 * Auto-update README * Add admin (#74) * Add admin * add email * Auto-update README * Fix * Update upgrade * Update _common.sh * Update _common.sh * Update manifest.json * Auto-update README * Fix * Update install * Fix * Fix * Auto-update README * Update upgrade * Revert "Update upgrade" This reverts commit a1dce069b4968f00bbaa59bc09ac0ecc9a37fcdb. * upgrade to upstream * Auto-update README Co-authored-by: deckname <58575263+deckname@users.noreply.github.com> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> Co-authored-by: Georgelemental <georgelemental@gmail.com> Co-authored-by: Jules-Bertholet <jules.bertholet@gmail.com> Co-authored-by: clavelc <25869334+clavelc@users.noreply.github.com> Co-authored-by: YunoHost Bot <yunohost-bot@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> Co-authored-by: Jens Diemer <github.com@jensdiemer.de> Co-authored-by: yunohost-bot <yunohost@yunohost.org>
2022-04-13 22:36:14 +02:00
**Shipped version:** 22.04.13~ynh1
2020-11-09 22:28:22 +01:00
2021-05-23 12:01:50 +02:00
**Demo:** https://invidious.site/
2020-11-09 22:28:22 +01:00
2021-05-23 12:01:50 +02:00
## Screenshots
2020-11-09 22:28:22 +01:00
2021-06-19 18:36:44 +02:00
![](./doc/screenshots/screenshot.png)
2020-11-09 22:28:22 +01:00
2021-05-23 12:01:50 +02:00
## Disclaimers / important information
2020-11-09 22:28:22 +01:00
2021-05-23 12:01:50 +02:00
## Configuration
2020-11-09 22:28:22 +01:00
2021-07-29 23:38:52 +02:00
You can configure Invidious by modifying the configuration file `/var/www/invidious/config/config.yml` with the help of this [documentation](https://docs.invidious.io/Configuration.md).
2020-11-09 22:28:22 +01:00
2021-07-28 12:02:03 +02:00
## Limitations
* Invidious needs more than 2GB of RAM to build.
2021-05-23 12:01:50 +02:00
## Documentation and resources
2020-11-09 22:28:22 +01:00
2021-05-23 12:01:50 +02:00
* Official user documentation: https://github.com/iv-org/documentation
2021-07-28 12:02:03 +02:00
* Official admin documentation: https://docs.invidious.io/
2021-06-19 18:36:44 +02:00
* Upstream app code repository: https://github.com/iv-org/invidious
2021-05-23 12:01:50 +02:00
* YunoHost documentation for this app: https://yunohost.org/app_invidious
* Report a bug: https://github.com/YunoHost-Apps/invidious_ynh/issues
2020-11-09 22:28:22 +01:00
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/invidious_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/invidious_ynh/tree/testing --debug
or
sudo yunohost app upgrade invidious -u https://github.com/YunoHost-Apps/invidious_ynh/tree/testing --debug
```
2021-05-23 12:01:50 +02:00
**More info regarding app packaging:** https://yunohost.org/packaging_apps