mirror of
https://github.com/khoaliber/LetterFeed.git
synced 2026-03-02 05:29:13 +00:00
faa0382e7562ea358c525437c4c536a921edca18
LetterFeed
LetterFeed is a self-hosted application that transforms your email newsletters into RSS feeds.
It periodically scans your email inbox via IMAP for new emails from the senders you've configured. When it finds a new email, it processes it, and adds it as a new entry to the corresponding newsletter's RSS feed.
Getting Started
Prerequisites
- An existing mailbox with IMAP over SSL on port 993.
- Docker and Docker Compose installed on your system.
Installation
-
Clone the repository:
git clone https://github.com/LeonMusCoden/letterfeed.git cd letterfeed -
Configure environment variables:
Settings related to IMAP, email processing, and username/password can be set via env variables or the UI. All other settings have to be set via env vars. Settings set in the
.envfile are locked in the UI.cp .env.example .envEdit the
.envfile with your specific settings. All settings are explained in the.env.example. -
Run the Docker containers:
docker compose up -d
Languages
Python
51.5%
TypeScript
43.8%
Makefile
1.8%
CSS
1.8%
Dockerfile
0.5%
Other
0.6%
