Skip to content

Commit

Permalink
Merge branch 'main' into reconcile
Browse files Browse the repository at this point in the history
  • Loading branch information
JamieSlome committed Jan 8, 2024
2 parents 646cc37 + 1c4f875 commit 0648576
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 19 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,25 @@
</div>
<br />

## About Git Proxy
## What is Git Proxy

<img align="right" width="550" src="./docs/img/demo.png" alt="Git Proxy Demonstration" />
Git Proxy is an application that stands between developers and a Git remote endpoint (e.g., `github.com`). It applies rules and workflows (configurable as `plugins`) to all outgoing `git push` operations to ensure they are compliant.

The main goal of Git Proxy is to marry the defacto standard Open Source developer experience (git-based workflow of branching out, submitting changes and merging back) with security and legal requirements that firms have to comply with, when operating in highly regulated industries like financial services.

Git Proxy deploys custom push protections and policies on top of Git. It is a highly configurable framework allowing developers and organizations to enforce push protections relevant to their developer workflow, security posture and risk appetite.

Git Proxy is built with a developer-first mindset. By presenting simple-to-follow remediation instructions in the CLI/Terminal, it minimises the friction of use and adoption, and keeps developers focused on what matters; committing and pushing code.
That said, Git Proxy can also be used on a local environment to enforce a single developer's best practices, which tends to be the easiest setup to start with and the most comfortable one to build new Git Proxy plugins.

```mermaid
sequenceDiagram
actor Developer
Developer->>+Git Server: git clone
Developer->>Workstation: git remote add proxy <proxy-server>
Developer->>+Git Proxy: git push proxy
Git Proxy-->>-Developer: Failed license check
Developer->>Workstation: git commit -m 'fix license issue'
Developer->>+Git Proxy: git push
Git Proxy-->>-Git Server: Approved
```

## Getting Started 🚀

Expand Down
26 changes: 13 additions & 13 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"react-chartist": "0.14.4",
"react-dom": "^16.13.1",
"react-html-parser": "^2.0.2",
"react-router-dom": "6.21.0",
"react-router-dom": "6.21.1",
"uuid": "^9.0.0",
"yargs": "^17.7.2"
},
Expand Down

0 comments on commit 0648576

Please sign in to comment.