ollie.earth / eater
mail based rss feed aggregator eater.ollie.earth
Star 2
Fork 0
Watch
Gleam 98%
Dockerfile <1%
Just <1%
Nix <1%
Shell <1%
159 1 0
db
dev
docs
priv
src
test
.envrc
.gitignore
docker-compose.yml
Dockerfile
flake.lock
flake.nix
gleam.toml
justfile
LICENSE
manifest.toml
metadata.json
README.md
robots.txt
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

First Start #

just keila

Then go to http://localhost:4000. Log in with Username: 'testing@eater.example' Password: 'testing123'

Create a new Project 'testing' and then add a new SMTP sender with the following credentials to your project.

Server: mailpit Port: 1025 Username: sender@eater.example Password: some-smtp-password

Then create an API-Key and add it to .secrets with export KEILA_API_KEY=<your-api-key>

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

Configuration #

Variable Name Required Default Example Description
KEILA_HOST yes http://localhost Hostname of the Keila instance to use.
KEILA_PORT 4000 Optional port to use with Keila.
KEILA_API_KEY yes 3SMynZjJhP5-dfXSVtSMPXswGxrL0CBkbv3HJZg_Kkg Api key for keila. Should have access to the sender you want to use.
KEILA_SENDER_NAME my-sender Optionally specify a sender to use. If this is not present, we default to the first sender returned by Keila.
ADMIN_PASSWORD yes your-secret-password Admin password.
ALLOW_SIGNUPS false true Whether or not new users should be allowed to sign up
DATABASE_URL sqlite:/data/database.sqlite3 the sqlite database url.
PORT 3000 The port the WebUi should run at.

Development env vars #

  • START_OBSERVER whether to start observer when starting eater
    no specific value needed, as long as the variable is present it will start

  • EATER_DEVELOPMENT when present, uses debug logging and pretty printing instead of json formatted > info logging no specific value needed, as long as the variable is present it will start