https://github.com/skatkov/miniflux-email-client

Miniflux client that deliveres updates to email.
https://github.com/skatkov/miniflux-email-client

github-actions miniflux miniflux-extension miniflux2 smtp

Last synced: about 23 hours ago
JSON representation

Miniflux client that deliveres updates to email.

• Host: GitHub
• URL: https://github.com/skatkov/miniflux-email-client
• Owner: skatkov
• Created: 2023-03-20T00:15:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-20T18:45:34.000Z (6 months ago)
• Last Synced: 2024-05-20T19:51:23.270Z (6 months ago)
• Topics: github-actions, miniflux, miniflux-extension, miniflux2, smtp
• Language: Go
• Homepage: https://skatkov.com
• Size: 106 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Miniflux Email Client

A Miniflux Client that sends feed updates via email.

This is a perfect "no-cost" solution based on GitHub and SMTP for people who often forget to check RSS readers for updates but never miss emails.

Just Fork it! ©

## Background

While there are numerous "RSS-over-email" services available, such as Mailbrew, Briefcake, or Tacodigest, this project aims to recreate essential features of those services using Git, CI, and SMTP. In most cases, these tools can be used free of charge and are available with open-source GitHub/GitLab repositories.

## Prerequisites

- GitHub repository with CI support

- A Miniflux instance with an account

- SMTP account (Gmail is recommended, but ensure it's not your main Gmail account if you choose to use it)

## Setup

1. Fork this repository

2. Retrieve your Miniflux API token

3. Configure Gmail SMTP by following this [guide](https://community.cloudflare.com/t/solved-how-to-use-gmail-smtp-to-send-from-an-email-address-which-uses-cloudflare-email-routing/382769/2)

4. Modify the `.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 continue running daily actions. Click "Yes" if you wish to keep receiving updates.

## Email

The email template is powered by the [Acorn framework](http://docs.thememountain.com/acorn/).