container-images/miniflux-filter
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Activity Actions
miniflux-filter/README.md
mg e9412d5b64 added "--help" (#2) 
Co-authored-by: Michael Grote <michael.grote@posteo.de>
Reviewed-on: mg/miniflux-filter#2
Co-authored-by: mg <michael.grote@posteo.de>
Co-committed-by: mg <michael.grote@posteo.de>
2021-11-02 18:47:26 +01:00

2.5 KiB
Raw Blame History

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

<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

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 Filter-File not found
2 MF_AUTH_TOKEN not set
3 MF_API_URL not set
4 Filter-Datei 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

Build Container

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

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.