#14 Allow for alternative credential handling
~jlkde filed ticket on minifluxWorker todo
Filters Miniflux entries based on enhanced rules.
minifluxWorker reads rules from a configuration file and marks entries as read based on them.
The following options are supported:
USAGE
minifluxWorker [OPTION]
OPTIONS
--config <path>
Path to config file (default "config.json")
--dry-run
Do not change anything
--help
Print this help
--interactive
Confirm entries to mark by hand
--version
Show version
The sample config looks like this:
A config file consists of some top-level headers and a list of rules where every key is required.
The server config consists of the following keys: The general part consists of a server configuration and the log level:
server
(object): The server config
url
(string): The servers URLtoken
(string): A token as obtained via Settings > API Keysloglevel
(string, one of "DEBUG", "INFO", "WARN", "ERROR" or "FATAL): The
log levelThe log level has to be must be set to "DEBUG" (useful to learn what minifluxWorker is attempting to do), "INFO" (useful to monitor), "WARN" (useful to mitigate problems), "ERROR" (problems occurred) or "FATAL" (problems fatal enough to crash the application).
"server": {
"url": "https://hosting.miniflux.app",
"token": "SE1KUGI5YWxIcWFJekJhbHBRaktkTHRRY1pBV01CXzZI="
},
"loglevel": "INFO",
A rule consists of the following keys:
name
(string): A name for the rule, can be chosen freelycondition
(object): What trigger the rule should act on
type
(string, one of "time", "title", "fulltext" or "duplicate"): What kind
of rule is enforcedkeys
(list of strings, integer durations and one of "m", "h", "d" or "w" for
rules based on time, else keywords or sentences of choice): The specific
values the rule considers. For type duplicate
the scopes where duplicates
should be marked read has to be supplied. Type title
supports Golangs
regex syntax (escaped into JSON).scope
(object): On what the rule should be enforced
type
(string, one of "all", "category" or "feed"):operator
(string, one of "with" or "without"): Inverts the rule: Either
only the scope or everything without the scope is evaluatedkeys
(list of strings): A freely chosen keyword or sentence to match the
feeds/categories name(s)include_starred
(boolean): Disregards all starred entries if false
All in a valid configuration file looks like this:
{
"server": {
"url": "https://hosting.miniflux.app",
"token": ""
},
"loglevel": "INFO",
"rules": [
{
"name": "All entries except category 'Knowledge' after two weeks",
"condition": {
"type": "time",
"keys": ["2w"]
},
"scope": {
"type": "category",
"operator": "without",
"keys": ["Knowledge", "Popular blog"]
},
"include_starred": true
},
{
"name": "Unstarred entries with 'boring topic' in it's title",
"condition": {
"type": "title",
"keys": ["boring topic", "Weekly report \\d{2}"]
},
"scope": {
"type": "all"
},
"include_starred": false
},
{
"name": "Sort out duplicates of the personal blog from aggregator",
"condition": {
"type": "duplicate",
"keys": ["aggregator"]
},
"scope": {
"type": "feed",
"operator": "with",
"keys": ["aggregator", "personal blog"]
},
"include_starred": false
}
]
}
minifluxWorker will act as soon as started. For scheduling a cronjob or a systemd timer can be used.
The config file must be mounted to run via Docker:
docker run --rm -v $(pwd)/config.json:/app/config.json:ro <your-name>/minifluxworker
go build .
docker build -t <your-name>/minifluxworker .
The build architecture can be supplied optionally too:
docker build -t <your-name>/minifluxworker --build-arg arch=arm64 .
Please write your commit messages as Conventional Commits.
This project is licensed under the European Union Public License v1.2. Please see License for more information.
As the use case is not uncommon the following projects provide similar functionality: