Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antoniosbarotsis/rss2email
An RSS feed aggregator that notifies you of new posts via email.
https://github.com/antoniosbarotsis/rss2email
atom aws-lambda blog docker email feed hacktoberfest rss rss-aggregator rust sendgrid
Last synced: 19 days ago
JSON representation
An RSS feed aggregator that notifies you of new posts via email.
- Host: GitHub
- URL: https://github.com/antoniosbarotsis/rss2email
- Owner: AntoniosBarotsis
- License: gpl-3.0
- Created: 2022-09-01T15:52:47.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-20T09:36:05.000Z (4 months ago)
- Last Synced: 2024-10-16T05:11:22.789Z (about 1 month ago)
- Topics: atom, aws-lambda, blog, docker, email, feed, hacktoberfest, rss, rss-aggregator, rust, sendgrid
- Language: Rust
- Homepage:
- Size: 515 KB
- Stars: 24
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Rss2Email
[](https://github.com/AntoniosBarotsis/Rss2Email/actions/workflows/ci.yml)
[](https://crates.io/crates/rss2email)
[](https://docs.rs/rss2email/)
[](https://deps.rs/repo/github/AntoniosBarotsis/Rss2Email?path=.)
[](https://hub.docker.com/search?q=antoniosbarotsis%2Frss2email)
[](https://gist.github.com/cheerfulstoic/d107229326a01ff0f333a1d3476e068d)
A small program capable of aggregating content from multiple RSS/Atom feeds and mailing them to you
in a practical summary email. Keep track of your favorite blogs that don't feature an update
newsletter or similar service.
## Dependencies
You'll need [Rust](https://rust-lang.org/) or [Docker](https://www.docker.com/) installed to
compile this software.
## Installation
Each release automatically publishes Docker images for
[x86](https://hub.docker.com/repository/docker/antoniosbarotsis/rss2email-x86) and
[arm](https://hub.docker.com/repository/docker/antoniosbarotsis/rss2email-arm) on DockerHub.
Note that these can only run on AWS Lambda. If you want to run them elsewhere through Docker, read
[here](https://github.com/AntoniosBarotsis/Rss2Email/wiki/4.-More-on-Docker).
Alternatively, you can build this from source. Clone this repository and run:
```bash
cargo build --release
```
Check out the
[build from source](https://github.com/AntoniosBarotsis/Rss2Email/wiki/1.-Home#building-from-source)
section of the wiki for more information.
## Configuration
**Rss2email** requires some environment variables to work. These can be provided either in your
shell or as entries in a `.env` file.
- `EMAIL_ADDRESS`: the mail address you will use to send the emails
- `RECIPIENT_ADDRESSES`: comma delimited list of recipient email addresses
- `SUBJECT`: the email subject (could be `rss2email`). Including `$POST_COUNT` in your subject will
have it replaced with the number of posts fetched. For example `SUBJECT=rss2email - $POST_COUNT new posts`
- `DAYS`: this value indicates up to how many days in the past we go to search for entries
- `FEEDS`: a list of semicolon-separated feed URLs.
_eg:_ `"https://blog.rust-lang.org/feed.xml;https://www.linux.org/articles/index.rss"`
- `EMAIL` (optional, defaults to `SendGrid`): Which provider to use to send the email.
For the supported providers, you can check the
[docs](https://docs.rs/rss2email/latest/rss2email_lib/email/email_provider/enum.EmailProviders.html).
- `API_KEY` (optional): Your email provider's authentication key.
- `SKIP_IF_NO_NEW_POSTS` (optional): Whether an email should be sent if the number of posts fetched is 0.
More details are available in the
[Running the code](https://github.com/AntoniosBarotsis/Rss2Email/wiki/3.-Running-the-Code) wiki
section.
## Usage
Running the code in debug mode won't send any emails and will instead output the generated HTML in
the console.
```bash
cargo run
```
It is recommended to try this out first and make sure that all your feeds and config variables are
correctly set up.
Running the project in release mode will send the emails
```bash
./target/release/Rss2email
# or
cargo run --release
```
## Contributing
Thanks for considering contributing!
Read [this](./CONTRIBUTING.md).
## Thanks to all Contributors!
