adam/ttrss-co-pilot
adam/ttrss-co-pilot
1
0
Fork 0
Code Issues 6 Pull Requests Packages Projects Releases 7 Wiki Activity

Update 'Home'

adam 2023-04-06 15:02:34 -04:00
parent fe47d505f6
commit d077a2b50a
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Home.md

@ -1,6 +1,6 @@
# Basic Usage # Basic Usage
1. copy sample-appsettings.json, see [[#configuration values]] 1. copy sample-appsettings.json, see [configuration values](Home#configuration-values)
2. ttrss will need: 2. ttrss will need:
1. an app password. go to preferences -> preferences tab -> personal data / authentication blade -> app passwords tab. I think theoretically you could just use your own? don't, it's bad for security. 1. an app password. go to preferences -> preferences tab -> personal data / authentication blade -> app passwords tab. I think theoretically you could just use your own? don't, it's bad for security.
2. api enabled. go to preferences -> preferences tab -> preferences blade -> under the general header -> look for a checkbox called Enable Api 2. api enabled. go to preferences -> preferences tab -> preferences blade -> under the general header -> look for a checkbox called Enable Api
@ -12,9 +12,9 @@
1. load configuration, log in, get a session token, all that good stuff. 1. load configuration, log in, get a session token, all that good stuff.
2. get your **unread** feeds, and loop through them. 2. get your **unread** feeds, and loop through them.
3. get the labels with respect to the feed. loop through each match of label (the text of it) to the action (see feedActions in [[#configuration values]]) - meaning it can do multiple things for 1 feed 3. get the labels with respect to the feed. loop through each match of label (the text of it) to the action (see feedActions in [configuration values](Home#configuration-values)) - meaning it can do multiple things for 1 feed
4. check sponsorblock for segments. if check passed (just, not a 404), it moves forward. if not, waits this cycle out (and adds to the article note) 4. check sponsorblock for segments. if check passed (just, not a 404), it moves forward. if not, waits this cycle out (and adds to the article note)
5. performs each action - see [[#internal commands]] for reference. 5. performs each action - see [internal commands](Home#internal-commands) for reference.
6. if successful, **removes the trigger labels**. 6. if successful, **removes the trigger labels**.
6. updates article note with status. 6. updates article note with status.
7. logs out of ttrss 7. logs out of ttrss
@ -31,15 +31,14 @@
| onDoneCopy | when done, move everything under ./tmp/ to onDoneCopy - practically speaking, that's 2 directories; "recent episodes" and "podcasts" | | onDoneCopy | when done, move everything under ./tmp/ to onDoneCopy - practically speaking, that's 2 directories; "recent episodes" and "podcasts" |
| feedActions | array of feed actions (see next) | | feedActions | array of feed actions (see next) |
feedActions: ## feedActions
| title | value | | title | value |
| --- | --- | | --- | --- |
| triggerlabelCaption | the text of the label that will trigger this action, e.g., "please download this from youtube" | | triggerlabelCaption | the text of the label that will trigger this action, e.g., "please download this from youtube" |
| command | the internal name of the action to do, when triggered, e.g., dl. (see next, again) | | command | the internal name of the action to do, when triggered, e.g., dl. (see next, again) |
internal commands: ## internal commands
| title | value | | title | value |
| --- | --- | | --- | --- |