No description

Find a file

Renovate Bot b4c7058f43 All checks were successful ci/woodpecker/push/lint Pipeline was successful Details ci/woodpecker/push/build Pipeline was successful Details chore(deps): update docker docker tag to v27 (#20 ) This PR contains the following updates: \| Package \| Update \| Change \| \|---\|---\|---\| \| docker \| major \| `26.1.4` -> `27.0.2` \| --- ### Configuration 📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied. ♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 Ignore: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MTcuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQxOS4xIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbXX0=--> Reviewed-on: #20 Co-authored-by: Renovate Bot <renovate@mgrote.net> Co-committed-by: Renovate Bot <renovate@mgrote.net>		2024-06-27 21:57:24 +02:00
.woodpecker	chore(deps): update docker docker tag to v27 (#20 )	2024-06-27 21:57:24 +02:00
docker-compose.yml	remove image digest	2024-02-07 15:14:17 +01:00
Dockerfile	chore(deps): update alpine docker tag to v3.20.1 (#19 )	2024-06-21 02:12:08 +02:00
filter.sh	SC2086	2023-03-21 17:56:36 +01:00
filter.txt	Filter - heise, sz, mdr	2022-06-18 10:08:20 +02:00
LICENSE	first commit	2021-10-28 18:53:59 +02:00
README.md	add badge	2023-11-08 13:22:58 +01:00
renovate.json	configure: renovatebot	2024-05-08 15:01:35 +02:00
sort_and_remove_double_entries.sh	Added script to clean up filter.txt	2022-06-18 11:06:16 +02:00

README.md

miniflux-filter

Introduction
Getting Started
- example docker-compose
- example filter-file
Misc
Debug
- Exit-Codes
Build Container
License

Introduction

miniflux-filter is a small bash-script for miniflux that marks certain articles as read, if the search conditions are met.

Getting Started

create an api-key in miniflux
create a compose-file
create a filter-file
docker-compose up

example docker-compose

version: '3.2'
services:
  mf-filter:
    container_name: mf-filter
    restart: always
    environment:
      TZ: Europe/Berlin
      MF_AUTH_TOKEN: XN2klsvvD[...]-dcHPaeQ=
      MF_API_URL: https://miniflux.[...].net/v1
      MF_SLEEP: 60
      #- MF_DEBUG=1
    image: quotengrote/miniflux-filter:latest
    volumes:
      - ./filter.txt:/data/filter.txt

example filter-file

Format: url::search
case-insensitive

<part_of_url>::<search string, anything goes>
sueddeutsche.de::FC Bayern
heise.de::software-architektur.tv
heise.de::heise-angebot
tagesschau.de::FC Barcelona
heise.de::TechStage |
[...]

Misc

tborychowski/miniflux-filter
jqplay.org
To clean up your filter.txt you can use the following script: ./sort_and_remove_double_lines.sh

Debug

If MF_DEBUG is set to 1, miniflux-filter will print extra output to stdout.

the current Variable
URL + Values for filtering
almost all function calls

Exit-Codes

RC	Description
1	`$MF_FILTERLIST_FILE` not found
2	`$MF_AUTH_TOKEN` not set
3	`$MF_API_URL` not set
4	`$MF_FILTERLIST_FILE` is a dir
5	`jq` is not installed
6	`curl` is not installed
7	could not connect to `miniflux`
8	`xargs` is not installed
9	`sed` is not installed
10	`sort` is not installed
11	`awk` is not installed

Build Container

git clone https://git.mgrote.net/mg/miniflux-filter
cd miniflux-filter
export MF_DOCKERHUB_PASS=<your_docker_hub_pass>
export MF_DOCKERHUB_USER=<your_docker_hub_user>
./build.sh

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.