mirror of
https://github.com/juherr/kill-the-news.git
synced 2026-06-20 22:03:48 +00:00
Young Lee
119 lines
3.4 KiB
Markdown
119 lines
3.4 KiB
Markdown
# Email-to-RSS
|
|
|
|
Convert email newsletters into a private RSS feed using Cloudflare Workers + ForwardEmail.
|
|
|
|
This project is self-hosted, uses your own domain, and keeps your data in your own Cloudflare account.
|
|
|
|
## Why this exists
|
|
|
|
Many newsletters only support email delivery. RSS readers offer a better reading experience, but getting email-only newsletters into RSS usually means relying on shared third-party infrastructure.
|
|
|
|
Email-to-RSS keeps the same workflow while avoiding shared domains and shared data stores.
|
|
|
|
## Features
|
|
|
|
- One-click feed creation from an admin dashboard
|
|
- Unique newsletter addresses per feed (for example `apple.mountain.42@yourdomain.com`)
|
|
- ForwardEmail webhook ingestion with source-IP verification
|
|
- RSS generation on demand (`/rss/:feedId`)
|
|
- Cloudflare KV storage for feed config + email metadata/content
|
|
- Password-protected admin UI
|
|
- Fully self-hosted on your Cloudflare account
|
|
|
|
## Architecture
|
|
|
|
1. ForwardEmail forwards inbound messages to `https://yourdomain.com/api/inbound`.
|
|
2. The Worker validates the request source against ForwardEmail MX IP ranges.
|
|
3. The Worker parses and stores incoming content in KV.
|
|
4. `https://yourdomain.com/rss/:feedId` renders RSS from stored items.
|
|
5. `/admin` provides feed management and email deletion.
|
|
|
|
Main routes:
|
|
|
|
- `src/routes/inbound.ts`: webhook ingestion
|
|
- `src/routes/rss.ts`: RSS rendering
|
|
- `src/routes/admin.ts`: admin UI + feed CRUD
|
|
|
|
## Requirements
|
|
|
|
- Node.js 20+
|
|
- A Cloudflare account
|
|
- A domain managed in Cloudflare DNS
|
|
- A ForwardEmail account
|
|
|
|
## Setup
|
|
|
|
1. Clone this repository.
|
|
2. Authenticate Wrangler:
|
|
```bash
|
|
npx wrangler login
|
|
```
|
|
3. Run setup:
|
|
```bash
|
|
bash setup.sh
|
|
```
|
|
|
|
`setup.sh` will:
|
|
|
|
- install npm dependencies
|
|
- verify Cloudflare auth (`wrangler whoami`)
|
|
- create KV namespaces (`EMAIL_STORAGE` + preview)
|
|
- set the `ADMIN_PASSWORD` secret in `production`
|
|
- generate `wrangler.toml` from `wrangler-example.toml`
|
|
- stamp `compatibility_date` to the current date
|
|
|
|
4. Configure ForwardEmail DNS records in Cloudflare:
|
|
|
|
| Type | Name | Content | Notes |
|
|
| ---- | ---- | ---------------------------------------------------- | ----------------------- |
|
|
| MX | @ | `mx1.forwardemail.net` | Priority `10`, DNS only |
|
|
| MX | @ | `mx2.forwardemail.net` | Priority `10`, DNS only |
|
|
| TXT | @ | `"forward-email=https://yourdomain.com/api/inbound"` | webhook target |
|
|
| TXT | @ | `"v=spf1 include:spf.forwardemail.net -all"` | SPF |
|
|
|
|
5. Deploy:
|
|
|
|
```bash
|
|
npm run deploy
|
|
```
|
|
|
|
6. Open `https://yourdomain.com/admin` and sign in.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
npm test
|
|
npm run build
|
|
```
|
|
|
|
## Configuration notes
|
|
|
|
- `wrangler-example.toml` is the template; `wrangler.toml` is generated locally.
|
|
- Keep `compatibility_date` fresh when doing runtime upgrades.
|
|
- `ADMIN_PASSWORD` is a Cloudflare Worker secret, not a plain env var in config.
|
|
|
|
## Security notes
|
|
|
|
- Inbound webhook access is IP-restricted to ForwardEmail MX sources.
|
|
- Admin auth is cookie-based (`HttpOnly`, `SameSite=Strict`).
|
|
- You should use a strong admin password and rotate periodically.
|
|
|
|
## Upgrading dependencies
|
|
|
|
To refresh dependencies to latest:
|
|
|
|
```bash
|
|
npm outdated
|
|
npm install
|
|
npm test
|
|
npm run build
|
|
```
|
|
|
|
Then update `compatibility_date` and redeploy.
|
|
|
|
## License
|
|
|
|
MIT
|