Skip to content

🔔 Simple RSS feed notifier which supports Discord Webhook

License

Notifications You must be signed in to change notification settings

SlashNephy/feedchime

Repository files navigation

feedchime

🔔 Simple RSS feed notifier which supports Discord Webhook

Kotlin GitHub release (latest by date) GitHub Workflow Status license issues pull requests

screenshot.png

Requirements

  • Java 17 or later

Get Started

config.yml

# フィードの取得間隔 (秒)
# 10 未満の値はエラーになります
interval: 3600
# 一度のチェックで通知する最大数
limit: 1
# User-Agent
# userAgent: xxx
# ログレベル (OFF, ERROR, WARN, INFO, DEBUG, TRACE, ALL)
logLevel: 'TRACE'

# 通知チャンネル定義のリスト
channels:
    #  Discord Webhook URL
  - discordWebhookUrl: 'https://discord.com/api/webhooks/xxx/xxx'
    # チェックするフィード定義のリスト
    feeds:
        # フィード URL
      - url: 'https://www.publickey1.jp/atom.xml'
        # Webhook のユーザ名
        name: 'PublicKey'
        # Webhook のアバター URL
        avatarUrl: 'https://www.publickey1.jp/favicon.ico'
        # フィルター定義
        filter:
          # 含めるタイトル (部分一致)
          titles:
            - 'Docker'
          # 無視するタイトル (部分一致)
          ignoreTitles:
            - '[PR]'

Docker

There are some image tags.

  • ghcr.io/slashnephy/feedchime:latest
    Automatically published every push to master branch.
  • ghcr.io/slashnephy/feedchime:dev
    Automatically published every push to dev branch.
  • ghcr.io/slashnephy/feedchime:<version>
    Coresponding to release tags on GitHub.

docker-compose.yml

version: '3.8'

services:
  feedchime:
    container_name: feedchime
    image: ghcr.io/slashnephy/feedchime:latest
    restart: always
    volumes:
      - ./config.yml:/app/config.yml:ro
      - data:/app/data

volumes:
  data:
    driver: local