Skip to content
This repository has been archived by the owner on Oct 5, 2023. It is now read-only.
/ rummager Public archive

🔍 Let's find tweets that mention you on Twitter. (ego-searching)

License

Notifications You must be signed in to change notification settings

SlashNephy/rummager

Repository files navigation

rummager

🔍 Let's find tweets that mention you on Twitter. (ego-searching)

Kotlin GitHub release (latest by date) GitHub Workflow Status Docker Image Size (tag) Docker Pulls license issues pull requests

これはなに

Twitter のエゴサ結果を Discord Webhook で通知するツールです。

screenshot.png

Requirements

  • Java 17 or later

Get Started

Docker

There are some image tags.

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

docker-compose.yml

version: '3.8'

services:
  rummager:
    container_name: rummager
    image: ghcr.io/slashnephy/rummager:latest
    restart: always
    environment:
      # Twitter の資格情報 (必須)
      TWITTER_CK: xxx
      TWITTER_CS: xxx
      TWITTER_AT: xxx
      TWITTER_ATS: xxx
      # Twitter のプライベート API を使用するかどうか
      # CK, CS に公式キーが必要です
      # 検索結果のリミットがなくなります
      USE_PRIVATE_API: 'false'

      # Twitter の検索クエリ (必須)
      SEARCH_QUERY: hoge OR foo OR bar
      # 検索する間隔 (秒)
      SEARCH_INTERVAL_SECONDS: 30
      # 無視するツイート元 (複数指定可能)
      IGNORE_SOURCES: twittbot.net,今日のツイライフ
      # 無視するユーザのスクリーンネーム (複数指定可能)
      IGNORE_SCREEN_NAMES: TwitterJP
      # Discord Webhook の通知先 (必須)
      DISCORD_WEBHOOK_URL: https://xxx
      # ツイートの投稿者がフォロワーだったときの Discord Webhook の通知先
      DISCORD_WEBHOOK_URL_FROM_FOLLOWERS: https://xxx