Files
geek-cookbook/manuscript/recipies/miniflux.md
T
2017-08-18 23:56:55 +12:00

2.5 KiB

Miniflux

Miniflux is a lightweight RSS reader, developed by Frédéric Guillot. (Who also happens to be the developer of the favorite Open Source Kanban app, Kanboard)

Features (among many) that I appreciate:

  • Compatible with the Fever API, read your feeds through existing mobile and desktop clients (This is the killer feature for me. I hardly ever read RSS on my desktop, I typically read on my iPhone or iPad, using Fiery Feeds or my new squeeze, Unread)
  • Send your bookmarks to Pinboard, Wallabag, Shaarli or Instapaper (I use this to automatically pin my bookmarks for collection on my blog)
  • Feeds can be configured to download a "full" version of the content (rather than an excerpt)
  • Use the Bookmarklet to subscribe to a website directly from any browsers

Ingredients

  1. Docker swarm cluster with persistent shared storage
  2. Traefik configured per design

Preparation

Setup data locations

Create the location for the bind-mount of the application data, so that it's persistent:

mkdir -p /var/data/miniflux

Setup Docker Swarm

Create a docker swarm config file in docker-compose syntax (v3), something like this:

version: '3'

services:
  miniflux:
    image: saghul/miniflux
    volumes:
     - /etc/localtime:/etc/localtime:ro
     - /var/data/miniflux/:/config/
    networks:
    - traefik
    deploy:
      labels:
        - traefik.frontend.rule=Host:miniflux.example.com
        - traefik.docker.network=traefik
        - traefik.port=80

networks:
  traefik:
    external: true

Serving

Launch Miniflux stack

Launch the Huginn stack by running docker stack deploy miniflux -c <path -to-docker-compose.yml>

Log into your new instance at https://YOUR-FQDN. Default credentials are admin/admin, after which you can change (under 'profile') and add more users.

Chef's Notes

  1. I chose saghul/miniflux's over the "official" miniflux/miniflux image, because currently the official image doesn't log to stdout (which you want, for docker logging commands), and because I have an expectation that nginx is more lightweight (faster) than apache.
  2. Find the bookmarklet under the "about" page. I know, it took me ages too.