From c6fe1ca49c1cc4f7028f02d3f60e6ebc5d589a8b Mon Sep 17 00:00:00 2001 From: girst Date: Fri, 24 Jul 2020 15:10:06 +0200 Subject: [PATCH] document proxy endpoint --- README.md | 7 +++++++ config/config.ini | 5 ++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 676b41e..d9013f1 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,13 @@ endpoint might not be as reliable (e.g. invidious-api being blocked) [Flask Blueprints]: https://flask.palletsprojects.com/en/1.1.x/blueprints/ +## Proxying videos + +This is useful to watch videos that are IP-locked. add the `proxy` blueprint to +the `[frontend]modules` list in `config.ini` to enable (disabled by default, as +it is resource-intensive, blocks a gunicorn thread and hasn't been tested +w.r.t. googlebanning). + ## Guest User The guest user doesn't really exist; you can't log in as guest, and all guest diff --git a/config/config.ini b/config/config.ini index d945de2..11ab896 100644 --- a/config/config.ini +++ b/config/config.ini @@ -7,7 +7,10 @@ database = /opt/yt/subscriptions.sqlite secret_key = # a message to show anonymous users when they navigate to /. note that you may not put newlines in it, as the perl ini parser can't handle them. welcome_message =

This is the development instance of the (yet) unnamed youtube frontend, a privacy-friendly way to catch up with your Youtube subscriptions. Contributors wanted (see repo README)!

You're seeing the guest user's subscription feed right now; feel free to explore! -# comma seperated list of blueprints to load. you may put your own blueprints in a subdirectory of app/ and list them here. modules mentioned first will shadow routes of those mentioned last. +# comma seperated list of blueprints to load. you may put your own blueprints +# in a subdirectory of app/ and list them here. modules mentioned first will +# shadow routes of those mentioned last. the 'proxy' endpoint is disabled by +# default. modules = invidious,youtube,reddit [websub] -- 2.39.3