miniflux-filter - new version

This commit is contained in:
Dziad Borowy 2022-01-20 10:06:58 +00:00
parent 5ca32aaf3b
commit d68865a239

View File

@ -1,9 +1,11 @@
# Miniflux-filter # Miniflux-filter
Filter for miniflux - "mark as read" all unwanter articles. Filter for miniflux - "mark as read" all unwanted articles.
I created that before miniflux added some basic filtering. Maybe still useful to someone.
The difference from the built-in filtering is that this marks articles as read, whereas the built-in filtering filters articles out BEFORE adding them to the DB.
I created that before miniflux added some basic filtering.
The difference from the built-in filtering is that the built-in filtering filters articles out BEFORE adding them to the DB, whereas this just marks them as read, so you can still go to "All" and see them if you wish.
<br>
The new version adds a UI for managing filters. The UI "borrows" the css & javascript from Miniflux, so the look & feel is (almost) exactly the same as the main app!
<br> <br>
@ -15,31 +17,18 @@ The difference from the built-in filtering is that this marks articles as read,
--- ---
version: '3' version: '3'
services: services:
miniflux-filter: miniflux-filter:
image: tborychowski/miniflux-filter image: tborychowski/miniflux-filter:latest
container_name: miniflux-filter container_name: miniflux-filter
restart: unless-stopped restart: unless-stopped
environment: environment:
- TZ=Europe/Dublin - TZ=Europe/Dublin
- HOST=https://rss.example.com # if not present - there will be no auth
- API_KEY=<YOUR MINIFLUX API KEY> # - ADMIN_PASSWORD=admin1
- CHECK_EVERY_S=300 # 300 seconds = 5 min # ERROR, WARNING, INFO, DEBUG
- LOG_LEVEL=INFO
ports: ports:
- "5011:3000" - "5020:80"
volumes: volumes:
- ./filters.yml:/app/filters.yml - ./data:/var/www/html/store
- ./logs:/app/logs # optional
```
## filters.yml
This is a simple list of matchers: it loops through the unread articles and for every one of them - it loops through this list. If the article URL matches a filter `url` and the article title contains the string from `title` field - this article will be marked as read.
```yml
filters:
- url: 'feed.example.com' # match feed url
title: 'windows 10' # match title
- url: 'feed.example.com'
title: 'sponsored'
- url: 'feed.another.com'
title: 'spam'
``` ```