mg 6924a0aefb changed delimiter to :: (#6 )

Co-authored-by: Michael Grote <michael.grote@posteo.de>
Reviewed-on: mg/miniflux-filter#6
Co-authored-by: mg <michael.grote@posteo.de>
Co-committed-by: mg <michael.grote@posteo.de>

2021-11-04 19:08:09 +01:00

2.6 KiB

Raw Blame History

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

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.

2.6 KiB Raw Blame History