# RSSNotifier

**Repository Path**: dooring/RSSNotifier

## Basic Information

- **Project Name**: RSSNotifier
- **Description**: RSS Notifier是一个RSS Feed阅读器,它设计成一个Window托盘程序随Windows的启动一起加载.它用基于使用RSS文件的新闻订阅方式来阅读即时新闻. 下载地址
- **Primary Language**: Java
- **License**: Unlicense
- **Default Branch**: main
- **Homepage**: https://www.oschina.net/p/rss+notifier
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-03-21
- **Last Updated**: 2025-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rss-notifier [![](https://img.shields.io/github/stars/omrilotan/rss-notifier?label=star&logo=github&style=flat-square) ![](https://img.shields.io/github/workflow/status/omrilotan/rss-notifier/publish?logo=github&style=flat-square)](https://github.com/omrilotan/rss-notifier) [![](https://img.shields.io/docker/cloud/automated/omrilotan/rss-notifier?label=build&logo=docker&logoColor=fff&style=flat-square) ![](https://img.shields.io/docker/pulls/omrilotan/rss-notifier?label=pulls&logo=docker&logoColor=fff&style=flat-square)](https://hub.docker.com/repository/docker/omrilotan/rss-notifier) [![](https://img.shields.io/npm/v/rss-notifier?label=&logo=npm&logoColor=fff&style=flat-square) ![](https://img.shields.io/npm/dt/rss-notifier?label=downloads&logo=npm&logoColor=fff&style=flat-square)](https://www.npmjs.com/package/rss-notifier)

## 💬 Send RSS update notifications to Slack

#### Docker
```bash
docker run omrilotan/rss-notifier -- --interval 10 --webhook https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX --channel "#notifications-channel" --feeds https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss --log-level debug
```

#### NPX
```bash
npx rss-notifier --interval 10 --webhook https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX --channel "#notifications-channel" --feeds https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss --log-level debug
```

#### Docker with env vars
```bash
docker run -e INTERVAL=10 -e WEBHOOK=https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX -e CHANNEL="#notifications-channel" -e FEEDS=https://www.githubstatus.com/history.rss,https://status.docker.com/ ages/533c6539221ae15e3f000031/rss -e LOG-LEVEL=debug omrilotan/rss-notifier
```
or
```bash
export INTERVAL=10
export WEBHOOK=https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
export CHANNEL="#notifications-channel"
export FEEDS=https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss
export LOG-LEVEL=debug

docker run -e INTERVAL -e WEBHOOK -e CHANNEL -e FEEDS -e LOG-LEVEL omrilotan/rss-notifier
```
and so on

<img width="600" src="https://user-images.githubusercontent.com/516342/105033778-3dcb6700-5a61-11eb-90ec-783d29481c80.png">

### CLI options

| Name | Config File | Env Var | Type | Default
| - | - | - | - | -
| `webhook` | `webhook` | `WEBHOOK` | Webhook address | ✘
| `feeds` | `feeds` | `FEEDS` | Comma separated URLs | ✘
| `interval` | `interval` | `INTERVAL` | Minutes | Fifteen minutes
| `channel` | `channel` | `CHANNEL` | Webhook channel | Default webhook channel
| `emoji` | `emoji` | `EMOJI` | Slack emoji | :rolled_up_newspaper: ( 🗞 )
| `dry-run` | `dryRun` | N/A | Boolean | no
| `log-level` | N/A | `LOG_LEVEL` | debug, verbose, info, warn, error, critical | warn
| `log-format` | N/A | `LOG_FORMAT` | plain, json | plain
| `config` | N/A | `CONFIG` | Config file | None

Options preference order is: CLI argument (1st), Config File (2nd), Environment variable (3rd), default (where applicable)

> Some options can not be configured in config file

## How To Use

#### Interval
Run this as scheduled task, specify the interval in which you run it.

_Examples:_

If you are running a cron as `*/15 * * * *` (each 15 minutes), set the interval argument to `15`.

If you are running a cron as `0 9 */1 * *` (every day at 09:00), set the interval argument to `1440` (60 * 24).

#### Feed(s)
The feed(s) is a list of one or more URLs.

_Example:_

If you want to "subscribe" to GitHub and Docker statuses set your feeds to both `--feeds https://www.githubstatus.com/history.rss,https://status.docker.com/pages/533c6539221ae15e3f000031/rss`

#### Yaml configuration
```yml
interval: 10
webhook: https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX
channel: "#notifications-channel"
feeds:
  - https://www.cloudflarestatus.com/history.atom
  - https://www.githubstatus.com/history.rss
```

#### Feed filter
You can add a filter to the feed. Only items including this substring in their title or content will be sent. Filters are case insensitive.
```yml
feeds:
  - https://www.cloudflarestatus.com/history.atom:
      include:
        - DNS
```

```yml
feeds:
  - https://www.cloudflarestatus.com/history.atom:
      exclude:
        - WARP
```