コンテンツにスキップ

セットアップ手順

KestreLynxはDockerホストごとに1つのコンテナとして動作します。
実行中のコンテナが使用しているイメージを特定してスキャンし、その結果をSlackまたは Webhookへ送信します。

必要なもの

  • Dockerホスト
  • Docker ComposeまたはDocker CLI
  • 次のうち1つ以上の通知先
    • Slack Incoming Webhook
    • Slack Bot Tokenとチャンネル
    • Webhook URL

Docker Composeで実行

リポジトリをダウンロードまたはcloneし、ローカル設定ファイルを作成します。

cp config.example.yml config.yml

以下のように少なくとも1つの通知先を設定してください。

notify:
  slack_webhook_url: "https://hooks.slack.com/services/..."

KestreLynxを起動します。

docker compose up -d
docker compose logs -f

同梱のComposeファイルは、スキャン履歴をkestrelynx-stateボリュームへ 永続化します。
この状態データは、コンテナを再作成した後も差分通知と初回検出日を 維持するために必要です。

Dockerで実行

docker run -d --name kestrelynx \
  -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -v "$PWD/config.yml:/etc/kestrelynx/config.yml:ro" \
  -v kestrelynx-state:/var/lib/kestrelynx \
  ghcr.io/kitsunetrail/kestrelynx:latest

タイムゾーンを設定

schedule.daily_atは、TZで指定したタイムゾーンとして解釈されます。
Composeの例ではUTCが既定値です。必要に応じて、運用するホストのタイムゾーンへ 変更してください。

environment:
  - TZ=Asia/Tokyo

参考ページ