From 72e7e7e54811c1222212b5a097b4ee799ba304e9 Mon Sep 17 00:00:00 2001 From: Tzahi12345 Date: Thu, 5 Jan 2023 02:47:24 -0500 Subject: [PATCH] Updated RSS Feed (markdown) --- RSS-Feed.md | 55 +++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 39 insertions(+), 16 deletions(-) diff --git a/RSS-Feed.md b/RSS-Feed.md index e1f8ea7..cc49f3f 100644 --- a/RSS-Feed.md +++ b/RSS-Feed.md @@ -1,19 +1,42 @@ -This is WIP documentation. +## Intro + +With v4.3.1, you can now easily generate an unlimited amount of RSS feeds of your downloaded videos. You can filter by a number of fields: +* Title +* File type (video, audio, both) +* User ID +* Subscription +* Only favorites + +You can also limit the number of downloads you'd like to appear, in case you have a lot of them. + +## Generating a link + +### Auto (easy) + +To generate an RSS feed link, first enable it in the `Extra` tab of the settings menu. Then click "Generate RSS URL" and fill in the fields to begin generating the URL. + +### Manual + +You can also generate the RSS feed URL manually by utilizing the `/api/rss` API endpoint, but note that some fields (sort, text_search if using regex) may require URI encoding. + +Link: coming soon! + +## Example + +http://example.com/api/rss +* Generate feed with files downloaded in single-user mode + +http://example.com/api/rss?uid=admin +* Generate feed with files downloaded by user `admin` + +http://example.com/api/rss?uid=admin&text_search=chess +* Generate feed with files downloaded by user `admin`, and filter for files that include the word `chess` + +http://example.com/api/rss?sub_id= +* Generate feed with files from subscription with ID `` + +## Links Helpful validator: https://validator.w3.org/feed/check.cgi -Prettier web-based viewer: https://rssviewer.app/ - -Examples: - -\/api/rss -* Generate feed with files downloaded in single-user mode - -\/api/rss?uid=admin -* Generate feed with files downloaded by user `admin` - -\/api/rss?uid=admin&text_search=chess -* Generate feed with files downloaded by user `admin`, and filter for files that include the word `chess` - -\/api/rss?sub_id= -* Generate feed with files from subscription with ID `` \ No newline at end of file +Pretty web-based viewer: https://rssviewer.app/ \ No newline at end of file