8000 Updated Documentation by c0d3G33k · Pull Request #8 · boringtools/git-alerts · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Updated Documentation #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2023
Merged

Updated Documentation #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a5d01c
Updated Documentation
c0d3G33k Mar 4, 2023
dabb1c8
Fix example
c0d3G33k Mar 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 33 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# GitAlert

GitAlert tool detects and alerts public repositories belonging to an organization and organization users that may leak any secrets along with various misconfigurations
## What problem does it solve?

GitHub repositories created under any organization can be controlled by the administrators. But any repository created under an organization user account is not controllable unless the organisation has adopted the GitHub enterprise-managed user model.

Any public repository created under the organization user account that was created for any testing could leak secrets, internal information, code etc.

### Example

`https://github.com/<org>/<org-repo-name>`

`https://github.com/<org-user>/<org-user-repo-name>`

`git-alert` helps you to detect and monitor public repositories creation under the organization and organization users as well.

## Setup

Setup GitHub personal access token as environment variable
Setup GitHub personal access token as the environment variable

```commandline
export GITHUB_PAT=YOUR_GITHUB_PAT
Expand All @@ -21,7 +33,23 @@ pip3 install -r requirements.txt
```commandline
python3 main.py -o your-organization-name
```
## Documentation

[/docs](https://github.com/boringtools/git-alerts/tree/main/docs)
> For future work & support, please check the issues created
> Run in monitor mode to detect new public repositories

```commandline
python3 main.py -o your-organization-name -m True
```

> Run in monitor mode to detect new public repositories with slack notifications

```commandline
python3 main.py -o your-organization-name -m True -s True
```
Setup slack webhook token as the environment variable
```commandline
export SLACK_WEBHOOK=SLACK_WEBHOOK_TOKEN
```
[docs](https://github.com/boringtools/git-alerts/tree/main/docs)
> For future work & support, please check the issues created

> Please feel to reach out for any feedback and suggestions
0