diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..b27e831 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,39 @@ +# The Problem + +YouTube has an extremely invasive privacy policy which relies on using user data in unethical ways. You give them a lot of data - ranging from ideas, music taste, content, political opinions, and much more than you think. + +By using Piped, you can freely watch and listen to content without the fear of prying eyes watching everything you are doing. + +## Features: + +**User Features** + +- [x] No Ads +- [x] No Tracking +- [x] Lightweight on server and client +- [x] Infinite Scrolling +- [x] Light/Dark themes +- [x] Login +- [x] Feeds +- [x] Playlists +- [x] Integration with [SponsorBlock](https://github.com/ajayyy/SponsorBlock) +- [x] Integration with [LBRY](https://lbry.com/) for streaming +- [x] Integration with [Return YouTube Dislike](https://returnyoutubedislike.com/) via [RYD-Proxy](https://github.com/TeamPiped/RYD-Proxy) +- [x] 4K support +- [x] No connections to Google's servers +- [x] Playing just audio +- [x] PWA support +- [x] Locally saved Preferences +- [x] [Available in many languages](src/locales), thanks to [our translators](https://hosted.weblate.org/projects/piped/frontend/) +- [x] Embedded video support +- [x] No age restriction +- [x] Bypasses Geo restrictions if possible through a federated network + +**Technical Features** + +- [x] Multi-region load-balancing +- [x] Performant by design, designed to handle 1000s of users concurrently +- [x] Does not use official YouTube APIs +- [x] Uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to extract information +- [x] Public [JSON API](https://docs.piped.video/docs/api-documentation/) +- [x] Federated protocol on Matrix to let instances collaborate with each other \ No newline at end of file diff --git a/doc/screenshots/channel.png b/doc/screenshots/channel.png new file mode 100644 index 0000000..061daf5 Binary files /dev/null and b/doc/screenshots/channel.png differ diff --git a/doc/screenshots/player.png b/doc/screenshots/player.png new file mode 100644 index 0000000..972c2e6 Binary files /dev/null and b/doc/screenshots/player.png differ diff --git a/manifest.toml b/manifest.toml index a5d9c06..2ec01c7 100644 --- a/manifest.toml +++ b/manifest.toml @@ -4,7 +4,6 @@ id = "piped" name = "Piped" description.en = "An open-source alternative frontend for YouTube which is efficient by design." -description.fr = "An open-source alternative frontend for YouTube which is efficient by design." version = "2024.01.21~ynh1" @@ -20,16 +19,15 @@ code = "https://github.com/TeamPiped/Piped" [integration] yunohost = '>= 11.2' -architectures = "all" # TODO : handle the "all" option (no ["all"]) -multi_instance = true ldap = "not_relevant" # TODO : fixme, use actual booleans + handle the "not_relevant" value -sso = "not_relevant" -# FIXME: replace with an **estimate** minimum disk and RAM requirements. e.g. 20M, 400M, 1G... You may have have a look at CI results +architectures = ["all"] +multi_instance = true +ldap = false +sso = false disk = "50M" ram.build = "50M" ram.runtime = "50M" [install] - [install.domain] type = "domain" @@ -40,20 +38,10 @@ ram.runtime = "50M" [resources] [resources.sources] - [resources.sources.main] - # This will pre-fetch the asset which can then be deployed during the install/upgrade scripts with : - # ynh_setup_source --dest_dir="$install_dir" - # You can also define other assets than "main" and add --source_id="foobar" in the previous command - url = "https://codeload.github.com/TeamPiped/Piped/zip/11610d545cb08c87e4ae1c415f4acc2b37d0f789" - sha256 = "11610d545cb08c87e4ae1c415f4acc2b37d0f7891234567890-1231234567890" - - # These infos are used by https://github.com/YunoHost/apps/blob/master/tools/autoupdate_app_sources/autoupdate_app_sources.py - # to auto-update the previous asset urls and sha256sum + manifest version - # assuming the upstream's code repo is on github and relies on tags or releases - # See the 'sources' resource documentation for more details - - autoupdate.strategy = "latest_github_tag" + url = "https://github.com/TeamPiped/Piped/archive/11610d545cb08c87e4ae1c415f4acc2b37d0f789.tar.gz" + sha256 = "64f56b0d0f02035ef42b561b617a793da2db96e02cb7a8131e2ac9e0c619101b" + autoupdate.strategy = "latest_github_commit" [resources.system_user] @@ -61,5 +49,3 @@ ram.runtime = "50M" [resources.permissions] main.url = "/" - - [resources.ports] diff --git a/scripts/backup b/scripts/backup index ce0d9e0..80b7f80 100644 --- a/scripts/backup +++ b/scripts/backup @@ -16,9 +16,17 @@ source /usr/share/yunohost/helpers #================================================= ynh_print_info --message="Declaring files to be backed up..." -ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" +#================================================= +# BACKUP THE APP MAIN DIR +#================================================= -ynh_backup --src_path="/etc/systemd/system/$app.service" +ynh_backup --src_path="$install_dir" + +#================================================= +# BACKUP THE NGINX CONFIGURATION +#================================================= + +ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 877d2f8..3180007 100644 --- a/scripts/restore +++ b/scripts/restore @@ -32,21 +32,11 @@ ynh_script_progression --message="Restoring system configurations related to $ap ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" -ynh_restore_file --origin_path="/etc/systemd/system/$app.service" -systemctl enable $app.service --quiet - -yunohost service add $app --log="/var/log/$app/$app.log" - -# Other various files... - #================================================= # RELOAD NGINX AND PHP-FPM OR THE APP SERVICE #================================================= ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 -# Typically you only have either $app or php-fpm but not both at the same time... -ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" - ynh_systemd_action --service_name=nginx --action=reload #=================================================