update readme and sample

This commit is contained in:
Karl0ss 2022-10-25 17:20:37 +01:00
parent 97b2fc702d
commit 588200a139
2 changed files with 11 additions and 0 deletions

View File

@ -19,11 +19,16 @@ There is a `config-sample.json` file that needs to be renamed to `config.json`,
- JDUserName - Your MyJDownloader Username - JDUserName - Your MyJDownloader Username
- JDPassword - Your MyJDownloader Password - JDPassword - Your MyJDownloader Password
- AdminPassword - Password to be set for the WebUI
- WebUIPort - Port for the WebUI to run on
- RSSFeed - The url to the rss feed you want to watch (Only tested with - rlsbb) - RSSFeed - The url to the rss feed you want to watch (Only tested with - rlsbb)
- RSSFeedRefreshMins - How often to poll your rss feed down to local file cache - RSSFeedRefreshMins - How often to poll your rss feed down to local file cache
- JDPostLinksMins - How often to check your file cache for your shows and send found links to JDownloader - JDPostLinksMins - How often to check your file cache for your shows and send found links to JDownloader
- Autostart - Tells JDownloader to add and start the downloads straight away (true/false) - Autostart - Tells JDownloader to add and start the downloads straight away (true/false)
- OnlyHEVC - If false, this will download any files that it finds on the post that matches the quality (true/false) - OnlyHEVC - If false, this will download any files that it finds on the post that matches the quality (true/false)
- TelegramBot - Set to true if you wish to have updates sent via telegramBot
- TelegramBotID - Set this to the id you recieve from TheBotFather
- TelegramChatID - Chat or Group ID for the bot to send messages to
- Shows - This needs to be a comma separated list of json objects of the show and quality you want to check for. - Shows - This needs to be a comma separated list of json objects of the show and quality you want to check for.
An example shown below An example shown below
@ -32,11 +37,16 @@ An example shown below
{ {
"JDUserName": "User", "JDUserName": "User",
"JDPassword": "Pass", "JDPassword": "Pass",
"AdminPassword":"",
"WebUIPort": 3100,
"RSSFeed": "https://mypage.com/feed/", "RSSFeed": "https://mypage.com/feed/",
"RSSFeedRefreshMins": 10, "RSSFeedRefreshMins": 10,
"JDPostLinksMins": 180, "JDPostLinksMins": 180,
"Autostart": false, "Autostart": false,
"OnlyHEVC": true, "OnlyHEVC": true,
"TelegramBot": true,
"TelegramBotID":"",
"TelegramChatID":123456789,
"Shows": [ "Shows": [
{ {
"Name": "Obi-Wan Kenobi", "Name": "Obi-Wan Kenobi",

View File

@ -8,6 +8,7 @@
"JDPostLinksMins": 180, "JDPostLinksMins": 180,
"Autostart": false, "Autostart": false,
"OnlyHEVC": true, "OnlyHEVC": true,
"TelegramBot": true,
"TelegramBotID":"", "TelegramBotID":"",
"TelegramChatID":123456789, "TelegramChatID":123456789,
"Shows": [ "Shows": [