No description
Find a file
Renovate Bot a0071febf6
Some checks failed
lint, build and push / lint (pull_request) Successful in 6s
lint, build and push / build (pull_request) Failing after 11s
chore(deps): update zricethezav/gitleaks docker tag to v8.20.1
2024-10-07 18:06:25 +00:00
.gitea/workflows chore(deps): update zricethezav/gitleaks docker tag to v8.20.1 2024-10-07 18:06:25 +00: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.3 (#30) 2024-09-07 14:23:49 +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 ci: zeiten randomisiert + badges entfernt 2024-09-02 21:30:56 +02: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

miniflux-filter

Table of Contents

Introduction

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

Getting Started

  1. create an api-key in miniflux
  2. create a compose-file
  3. create a filter-file
  4. 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

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.