๐Ÿ›ก๏ธSentinelOSS

Getting started

5-minute Quickstart

Connect a GitHub repo, get alerts on every push. No agents, no runners, no infra.

1

Sign in with GitHub

Click Sign in (top right). We'll auto-create a free organization for you on first login.

๐Ÿ’ก You only need GitHub read-access โ€” we never request write permissions.

2

Copy your webhook URL + secret

Go to Automation. You'll see:

  • Webhook URL โ€” looks like https://sentineloss.cloudrf.xyz/api/webhooks/github/<your-org-id>
  • Webhook Secret โ€” click Generate Secret if you haven't yet. Copy it now โ€” it's shown once.
3

Add the webhook to your GitHub repo

Open the repo on GitHub, then:

  1. Go to Settings โ†’ Webhooks โ†’ Add webhook
  2. Payload URL: paste the URL from Step 2
  3. Content type: application/json (must change from default!)
  4. Secret: paste the secret from Step 2
  5. SSL verification: Enable (default)
  6. Events: "Just the push event"
  7. Click Add webhook

๐Ÿ’ก Re-use the same URL + secret for every repo you want to scan. One webhook fits all.

4

Pick where to get alerts

Go to Notifications and add at least one channel. Pick whichever you already have:

๐Ÿ’ฌSlack

Incoming Webhook URL from your Slack app

โœˆ๏ธTelegram

Bot token from @BotFather + Chat ID (negative number for groups)

๐ŸŸฆMicrosoft Teams

Incoming Webhook from channel connector

๐ŸŸ Splunk (SIEM)

HEC URL + token โ€” on-prem friendly

๐ŸถDatadog (SIEM)

API key + site (US/EU/etc.)

๐Ÿ’ก Start with Slack or Telegram โ€” both take 1 minute to set up. Add SIEM later for SOC teams.

5

Test it โ€” push a commit

Push anything to the connected repo (even a typo fix). Within ~10 seconds you should see:

  • A message in your Slack / Telegram / Teams channel
  • A new report in your Dashboard
  • Events in your SIEM (if configured) with source:sentineloss

๐Ÿ’ก Nothing arrived? Open GitHub โ†’ repo โ†’ Settings โ†’ Webhooks โ†’ Recent Deliveries โ€” a green โœ“ = we received it, a red โš  = check the content-type is JSON.

Troubleshooting

GitHub delivery: 401 Unauthorized
Secret mismatch. Regenerate on /automation and update it in the GitHub webhook settings.
Delivery returns 200 but nothing happens
No lockfiles in repo (npm / pip / yarn / pipenv). Add one or scan a different repo.
No Slack/Telegram message
Open Notifications โ€” make sure the channel exists. Then check the Recent Deliveries on GitHub.
Telegram: chat not found
Send any message to the bot first. Bots can't initiate conversations.

What's next?

  • ๐Ÿ“˜ SOC detection rules โ€” ready-made Splunk + Datadog queries
  • ๐Ÿ”‘ API keys โ€” push reports from CI/CD
  • ๐Ÿ“Š Dashboard โ€” CVE trend, SSL grades, recent reports
  • ๐Ÿ”’ Vault โ€” store sensitive config with MFA