mirror of https://git.juggalol.com/agatha/gitmon.git synced 2024-11-21 23:16:41 +00:00

Monitor GitHub events.

Go to file

agatha 73e5a63565 Add custom log levels. Closes #1		2023-11-11 14:34:14 -05:00
.img	Include console output image	2023-11-11 11:21:56 -05:00
gitmon	Add custom log levels. Closes #1	2023-11-11 14:34:14 -05:00
.gitignore	Exclude configuration	2023-11-10 21:33:46 -05:00
main.py	Add custom log levels. Closes #1	2023-11-11 14:34:14 -05:00
README.md	Update README.md	2023-11-11 11:46:13 -05:00
requirements.txt	Add loguru for logging	2023-11-10 20:35:04 -05:00

README.md

GitMon

Monitor GitHub events and clone repositories to search for secrets, and more.

Overview

GitMon allows an operator to continually monitor the GitHub Events API to collect metadata and look for secret leakage.

When certain events such as CreateEvent or DeleteEvent are observed, GitMon will send the repository URL to a worker that will clone the repository and search for API keys, passwords, endpoints, and more.

GitMon will also build a table that maps commit email addresses to GitHub usernames.

Features

Monitor for CreateEvent and DeleteEvent
~~Commit metadata scraping~~ (Not implemented yet)
~~Automatic secret scraping~~ (Not implemented yet)
~~IRC/Webhook notifications~~ (Not implemented yet)

Installation

git clone https://git.juggalol.com/agatha/gitmon
cd gitmon
pip install -r requirements.txt

Configuration

GitMon works best with a token. Without a token you are limited to 60 API calls per hour. Creating and using a Personal Access Token will raise that limit to 60,000 API calls per hour.

To use a Personal Access Token, create a config.py file:

token = 'ghp_YOUR_TOKEN_HERE'

Caught Slippin'

Contributors

agathanonymous