Skip to content

A service for finding and alerting on newly created public repositories for GitHub users who are part of a GitHub organization.

License

Notifications You must be signed in to change notification settings

PerimeterX/gitapp_alert_on_public

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Alert on Public Repos

GitHub issues GitHub forks GitHub stars Latest Release GitHub license Top Languages

A github application for finding and alerting on newly created public repositories for GitHub users who are part of a GitHub organization.

Prepare Things

  1. Create and install a GitHub application to your organization.
    1. The GitHub application requires only one permission: Organization permissions > Members (Read-Only).
    2. Download the private PEM file needed for JWT token creations.
  2. Update the config.json file (see sample file) with the PEM file location and installation ID.
  3. For a single instance on a single organization, add to config.json the GitHub organization and a slack webhook for notifications.
    1. Create a new slack app
    2. Goto Incoming Webhooks and create a new hook
  4. Optional add a mongodb parameters for storing notifications.
  5. run
pip install -r requirements.txt

Config File

{
    "key_file": "./conf/private-key.pem",
    "github_app_id": "1111111",
    "installs": [
        {
            "org": "ORG_NAME",
            "slack_web_hook": "https://hooks.slack.com/services/XXXXXXXXXX/XXXXXXXXXX/XXXXXXXXXX"
        }],
    "use_mongo": false,
    "mongodb_conn": "mongodb://.......", // relevant only if use_mongo is true, can be removed otherwise
    "mongodb_db": "DB name" // relevant only if use_mongo is true, can be removed otherwise
}

Test

The following command will run a single scan and stop

python main.py once

Run

The following command will run forever, scanning repos immediatly, followed by a scan every 30 minutes.

python main.py

Docker Usage

docker build --tag gitapp .
docker run -d gitapp

About

A service for finding and alerting on newly created public repositories for GitHub users who are part of a GitHub organization.

Topics

Resources

License

Stars

Watchers

Forks