KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #developer-tools #claude-code #codex #cli #agent-skills #ai #dsh-plugin #mcp #windows #agent

kindly-rss-reader

★ 133 Open GitHub ↗

RSS Aggregator optimized for e-ink devices

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img src="images/logo_light.png#gh-light-mode-only" alt="Logo">
 <img src="images/logo_dark.png#gh-dark-mode-only" alt="Logo">
 
 Feed Aggregator for e-ink devices

Kindly RSS Reader is a self-hosted feed aggregator (supporting both RSS and Atom feeds) designed for e-ink devices such as Kindle and optimized for low-end computers like the Raspberry Pi.

Feel free to test it, report issues, or contribute by submitting pull requests with new features.

> **Note:** This project is in its early development stages.

## Features
- Fetch and aggregate RSS and Atom feeds.
- Optimized for e-ink display readability.
- Self-hostable on low-end hardware.

## Running the application

### Configuration: Environment variables

The following environment variables are used to configure some aspects of the app:

- `MAX_ARTICLES_QTY_TO_DOWNLOAD`: When adding a new feed, downloads the specified number of articles from newest to oldest. Additional articles will be fetched on demand. If not specified, all articles will be downloaded.

*Default value: `0`*

- `DATA_PATH`: Path for storing the app data, such as fetched articles, config and the database file.

*Default value: `.`*

**Note**: Do not modify this when running it in docker.

- `STATIC_DATA_PATH`: Path where static folders are located (`migrations`, `static` and `templates`).

*Default value: `.`*

**Note**: Do not modify this when running it in docker.

- `RUST_LOG`: Configure log level:
  - `TRACE`
  - `DEBUG`
  - `INFO` *default*
  - `WARN`
  - `ERROR`

### Docker

At the moment only a docker image is supported. To run the project:

```bash
docker run \
    -d \
    -p 3000:3000 \
    --restart unless-stopped \
    -v "$(pwd)/kindly-rss-data/data:/home/data" \
    --name kindly-rss \
    nicoan/kindly-rss-reader
```

The argument `--restart unless-stopped` will strart the container automatically when the docker daemon stats, unless it is stopped.

**Note**: If you wish to modify some enviroment variable value, add `-e VAR_NAME=<value>` to the `docker run ...` command.

Then open your browser and navigate to the app with the address `http:://<ip_of_device_running_the_docker_image>:3000`. I *highly* recommend to add feeds from a computer.

## Running the Project for development

### Using Cargo

You can run the project with:

```bash
cargo run
```

### Using Docker

1. Build the Docker image:

```bash
   docker build --tag kindly-rss .
   ```

2. Run the container:

```bash
   docker run --rm -p 3000:3000 kindly-rss
   ```

## Showroom

Here are some screenshots of the Kindly RSS Reader in action:

### Light theme

### Dark theme

 <img src="images/1_dark.jpeg" alt="Feed list dark theme" height="350px">
 <img src="images/2_dark.jpeg" alt="Article list dark theme" height="350px">
 <img src="images/3_dark.jpeg" alt="Article dark theme" height="350px">

kindly-rss-reader

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README