ollie.earth / eater
mail based rss feed aggregator
2
fork

Configure Feed

Select the types of activity you want to include in your feed.

Gleam 97.6%
Dockerfile 0.9%
Just 0.7%
Nix 0.7%
Shell 0.2%
125 1 0

Clone this repository

https://tangled.org/ollie.earth/eater https://tangled.org/did:plc:cezmtk5bb4zipkps3abnjjl6/eater
git@knot.nuv.sh:ollie.earth/eater git@knot.nuv.sh:did:plc:cezmtk5bb4zipkps3abnjjl6/eater

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

eater#

Email based RSS feed aggregator

Notice: This project lives on Tangled and the main development happens on Tangled. Please report issues and contribute on Tangled.

Development#

nix develop

just

just dev

The webui for eater is now available at: http://localhost:3000
You can log in with
username: sender@eater.example
password: testing123

The sent mails can be seen at: http://localhost:8025

IDEAS#

  • subscription management via email
  • browser extension similar to vivaldi's built in rss feed stuff
  • feed leaderboard

Structure#

A graphic showing the supervision structure of eater
A graphic showing general flow of data in eater

Environment variables#

Required#

  • SMTP_HOST the sqtp server hostname ex: smtp.protonmail.ch

  • SMTP_PORT the sqtp server port ex: 587

  • SMTP_USERNAME the username to authenticate with the smtp server ex: rss@ollie.earth

  • SMTP_PASSWORD the password to use when authenticating with the smtp server

  • ADMIN_PASSWORD the password to use for the default(SMTP_SENDER_EMAIL) admin

Optional#

  • SMTP_SENDER_EMAIL defaults to SMTP_USERNAME when unset

  • SMTP_SENDER_NAME the 'name' of the sender to use

  • PORT the 'port' to use for the web-ui, defaults to 3000

  • ALLOW_SIGNUPS whether new users need to first be added by an admin (false) or can simply log in (true) defaults to false