miniflux-filter/README.md

miniflux-filter

Table of Contents

• Introduction
• Getting Started
  • example docker-compose
  • example filter-file
• Misc
• ToDo
• License

Introduction

miniflux-filter is a small bash-script for miniflux that marks certain articles as read, if the search conditions 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_output=1
    image: quotengrote/miniflux-filter:latest
    volumes:
      - ./filter.txt:/data/filter.txt

example filter-file

<part_of_url>:<search string, anything goes, but not :>
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

ToDo

• search in content, not only title

License

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