commit 14a3f118abb9cbafd8ba2075c0715bbd1d110342
parent 2a128ada261858d78abcc10d9f87598d6a59e803
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sat, 20 Apr 2024 15:19:22 +0200
Document authentication system
Diffstat:
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -15,8 +15,6 @@ Assuming you host this service under the URL "https://yt2rss.example.com", inser
https://yt2rss.example.com/?channel=UCt_Y3j8CpXx366et1RaHACA
```
-Done. There is nothing more you have to do.
-
Individual video entries can be fetched via:
```
@@ -25,6 +23,22 @@ https://yt2rss.example.com/?video=TV8tEq56vHI
If the video has not been fetched before, this will take a few seconds, as the server needs to download and convert the video to an `.opus` audio file before it can serve it.
+Videos within a feed can be included or excluded based on title-matches:
+
+* Include only videos whose title contain "vlog time": index.php?channel=UCt_Y3j8CpXx366et1RaHACA&include=vlog%20time
+* Exclude all videos whose title contain "vlog time": index.php?channel=UCt_Y3j8CpXx366et1RaHACA&exclude=vlog%20time
+
+## Additional configuration
+
+It is advised to only allow trusted parties to use your service. yt2rss uses a simple authentication key for this, which is included in the URL:
+
+```
+https://yt2rss.example.com/?auth=MY_KEY&channel=UCt_Y3j8CpXx366et1RaHACA
+https://yt2rss.example.com/?auth=MY_KEY&video=TV8tEq56vHI
+```
+
+You can set an auth-key in the `env.php` file. If the value is set to something other than `null` (the default), authentication is enabled.
+
## Requirements:
- [getID3](https://github.com/JamesHeinrich/getID3)
