Skip to content

Miniflux client that deliveres updates to email.

Notifications You must be signed in to change notification settings

skatkov/miniflux-email-client

Repository files navigation

Miniflux Email Client

Miniflux Client to send feed updates over email.

It's perfect "no-cost" solution based on github/smtp for people who always forget to check RSS readers for updates, but never miss emails.

Just Fork it! (c)

Background

There are plenty of "RSS-over-email" services out there - mailbrew, briefcake or tacodigest as example. This project aims to rebuild essential features of those services, but using git + CI + SMTP. In most cases, these things could be used free of charge and available with open source github/gitlab repo.

Prerequisites

  • Github repo + CI support
  • A Miniflux instance with an account
  • SMTP account (I use gmail, but make sure it's not you're main gmail account if you do)

Setup

  1. Fork this repo
  2. Retrieve miniflux API token
  3. Configure gmail smtp based on a following guide
  4. Modify .github/workflows/runner.yml file
  5. Add github/action secrets (SMTP_SERVER, SMTP_USERNAME and SMTP_PASSWORD are required)

Github Action

Every 3 months github will ask if you want to keep running daily actions. Click "yes", if you want to continue receiving updates.

Email

Email template is powered by Acorn framework.