Skip to content

Commit

Permalink
Merge pull request finos#618 from DanielVenable/replace-Git-Proxy-wit…
Browse files Browse the repository at this point in the history 
…h-GitProxy

docs: replaced "Git Proxy" with "GitProxy"
  • Loading branch information
@JamieSlome
JamieSlome committed Jun 22, 2024
2 parents ee4eecd + 63d154f commit 3844985
Show file tree
Hide file tree
Showing 10 changed files with 82 additions and 83 deletions.
23 changes: 11 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,24 @@
</div>
<br />

## What is Git Proxy
## What is GitProxy

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.
GitProxy 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.
The main goal of GitProxy 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.

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.
That said, GitProxy 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 GitProxy 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->>+GitProxy: git push proxy
GitProxy-->>-Developer: Failed license check
Developer->>Workstation: git commit -m 'fix license issue'
Developer->>+Git Proxy: git push
Git Proxy-->>-Git Server: Approved
Developer->>+GitProxy: git push
GitProxy-->>-Git Server: Approved
```

## Getting Started 🚀
Expand All @@ -66,7 +66,7 @@ Install & run git-proxy (requires [Nodejs](https://nodejs.org/en/download/)):
$ npx -- @finos/git-proxy
```

Clone a repository, set the remote to the Git Proxy URL and push your changes:
Clone a repository, set the remote to the GitProxy URL and push your changes:

```bash
# Only HTTPS cloning is supported at the moment, see https://github.com/finos/git-proxy/issues/27.
Expand All @@ -81,11 +81,10 @@ $ git remote add proxy http://localhost:8000/yourGithubUser/Hello-World.git
$ git push proxy $(git symbolic-ref refs/remotes/origin/HEAD | sed 's@^refs/remotes/origin/@@')
```

Using the default configuration, Git Proxy intercepts the push and _blocks_ it. To enable code pushing to your fork via Git Proxy, add your repository URL into the Git Proxy config file (`proxy.config.json`). For more information, refer to [our documentation](https://git-proxy.finos.org).
Using the default configuration, GitProxy intercepts the push and _blocks_ it. To enable code pushing to your fork via GitProxy, add your repository URL into the GitProxy config file (`proxy.config.json`). For more information, refer to [our documentation](https://git-proxy.finos.org).

## Documentation

For detailed step-by-step instructions for how to install, deploy & configure Git Proxy and
For detailed step-by-step instructions for how to install, deploy & configure GitProxy and
customize for your environment, see the [project's documentation](https://git-proxy.finos.org/docs/):

- [Quickstart](https://git-proxy.finos.org/docs/category/quickstart/)
Expand Down
14 changes: 7 additions & 7 deletions website/docs/configuration/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ description: How to customise push protections and policies

### Default configuration

On installation, Git Proxy ships with an [out-of-the-box configuration](https://github.com/finos/git-proxy/blob/main/proxy.config.json). This is fine for
On installation, GitProxy ships with an [out-of-the-box configuration](https://github.com/finos/git-proxy/blob/main/proxy.config.json). This is fine for
demonstration purposes but is likely not what you want to deploy into your environment.
### Customise configuration

To customise your Git Proxy configuration, create a `proxy.config.json` in your current
working directory. Git Proxy will load this file and set the values you have specified. Any
To customise your GitProxy configuration, create a `proxy.config.json` in your current
working directory. GitProxy will load this file and set the values you have specified. Any
missing sections will use the default configuration values.

Here is a minimal example:
Expand All @@ -31,7 +31,7 @@ The full configuration reference can be found at the [Reference page](/docs/conf

### Alter the configuration path

To specify a different file name for your Git Proxy configuration, use:
To specify a different file name for your GitProxy configuration, use:

```bash
git-proxy --config ./config.json
Expand All @@ -44,7 +44,7 @@ npx -- @finos/git-proxy --config ./config.json
```

### Set ports with ENV variables
By default, Git Proxy uses port 8000 to expose the Git Server and 8080 for the frontend application.
By default, GitProxy uses port 8000 to expose the Git Server and 8080 for the frontend application.
The ports can be changed by setting the `GIT_PROXY_SERVER_PORT`, `GIT_PROXY_HTTPS_SERVER_PORT` (optional) and `GIT_PROXY_UI_PORT`
environment variables:

Expand All @@ -57,7 +57,7 @@ export GIT_PROXY_HTTPS_SERVER_PORT="9443"
Note that `GIT_PROXY_UI_PORT` is needed for both server and UI Node processes,
whereas `GIT_PROXY_SERVER_PORT` (and `GIT_PROXY_HTTPS_SERVER_PORT`) is only needed by the server process.

By default, Git Proxy CLI connects to Git Proxy running on localhost and default port. This can be
By default, GitProxy CLI connects to GitProxy running on localhost and default port. This can be
changed by setting the `GIT_PROXY_UI_HOST` and `GIT_PROXY_UI_PORT` environment variables:

```
Expand All @@ -67,7 +67,7 @@ export GIT_PROXY_UI_PORT="5000"

### Validate configuration

To validate your Git Proxy configuration, run:
To validate your GitProxy configuration, run:

```bash
git-proxy --validate
Expand Down
44 changes: 22 additions & 22 deletions website/docs/configuration/reference.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Schema Reference
description: JSON schema reference documentation for Git Proxy
description: JSON schema reference documentation for GitProxy
---

# Schema Reference

**Title:** Git Proxy configuration file
**Title:** GitProxy configuration file

| | |
| ------------------------- | ------------------------------------------------------- |
Expand All @@ -16,7 +16,7 @@ description: JSON schema reference documentation for Git Proxy
**Description:** Configuration for customizing git-proxy

<details>
<summary><strong> <a name="authorisedList"></a>1. [Optional] Property Git Proxy configuration file > authorisedList</strong> </summary>
<summary><strong> <a name="authorisedList"></a>1. [Optional] Property GitProxy configuration file > authorisedList</strong> </summary>
<blockquote>

| | |
Expand All @@ -30,7 +30,7 @@ description: JSON schema reference documentation for Git Proxy
| --------------------------------------- | ----------- |
| [authorisedRepo](#authorisedList_items) | - |

### <a name="autogenerated_heading_2"></a>1.1. Git Proxy configuration file > authorisedList > authorisedRepo
### <a name="autogenerated_heading_2"></a>1.1. GitProxy configuration file > authorisedList > authorisedRepo

| | |
| ------------------------- | ------------------------------------------------------------------------- |
Expand All @@ -40,7 +40,7 @@ description: JSON schema reference documentation for Git Proxy
| **Defined in** | #/definitions/authorisedRepo |

<details>
<summary><strong> <a name="authorisedList_items_project"></a>1.1.1. [Required] Property Git Proxy configuration file > authorisedList > authorisedList items > project</strong> </summary>
<summary><strong> <a name="authorisedList_items_project"></a>1.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project</strong> </summary>
<blockquote>

| | |
Expand All @@ -52,7 +52,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="authorisedList_items_name"></a>1.1.2. [Required] Property Git Proxy configuration file > authorisedList > authorisedList items > name</strong> </summary>
<summary><strong> <a name="authorisedList_items_name"></a>1.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name</strong> </summary>
<blockquote>

| | |
Expand All @@ -64,7 +64,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="authorisedList_items_url"></a>1.1.3. [Required] Property Git Proxy configuration file > authorisedList > authorisedList items > url</strong> </summary>
<summary><strong> <a name="authorisedList_items_url"></a>1.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url</strong> </summary>
<blockquote>

| | |
Expand All @@ -79,7 +79,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="sink"></a>2. [Optional] Property Git Proxy configuration file > sink</strong> </summary>
<summary><strong> <a name="sink"></a>2. [Optional] Property GitProxy configuration file > sink</strong> </summary>
<blockquote>

| | |
Expand All @@ -93,7 +93,7 @@ description: JSON schema reference documentation for Git Proxy
| ------------------------------- | ----------- |
| [database](#sink_items) | - |

### <a name="autogenerated_heading_3"></a>2.1. Git Proxy configuration file > sink > database
### <a name="autogenerated_heading_3"></a>2.1. GitProxy configuration file > sink > database

| | |
| ------------------------- | ------------------------------------------------------------------------- |
Expand All @@ -103,7 +103,7 @@ description: JSON schema reference documentation for Git Proxy
| **Defined in** | #/definitions/database |

<details>
<summary><strong> <a name="sink_items_type"></a>2.1.1. [Required] Property Git Proxy configuration file > sink > sink items > type</strong> </summary>
<summary><strong> <a name="sink_items_type"></a>2.1.1. [Required] Property GitProxy configuration file > sink > sink items > type</strong> </summary>
<blockquote>

| | |
Expand All @@ -115,7 +115,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="sink_items_enabled"></a>2.1.2. [Required] Property Git Proxy configuration file > sink > sink items > enabled</strong> </summary>
<summary><strong> <a name="sink_items_enabled"></a>2.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled</strong> </summary>
<blockquote>

| | |
Expand All @@ -127,7 +127,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="sink_items_connectionString"></a>2.1.3. [Optional] Property Git Proxy configuration file > sink > sink items > connectionString</strong> </summary>
<summary><strong> <a name="sink_items_connectionString"></a>2.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString</strong> </summary>
<blockquote>

| | |
Expand All @@ -139,7 +139,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="sink_items_options"></a>2.1.4. [Optional] Property Git Proxy configuration file > sink > sink items > options</strong> </summary>
<summary><strong> <a name="sink_items_options"></a>2.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options</strong> </summary>
<blockquote>

| | |
Expand All @@ -152,7 +152,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="sink_items_params"></a>2.1.5. [Optional] Property Git Proxy configuration file > sink > sink items > params</strong> </summary>
<summary><strong> <a name="sink_items_params"></a>2.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params</strong> </summary>
<blockquote>

| | |
Expand All @@ -168,7 +168,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="authentication"></a>3. [Optional] Property Git Proxy configuration file > authentication</strong> </summary>
<summary><strong> <a name="authentication"></a>3. [Optional] Property GitProxy configuration file > authentication</strong> </summary>
<blockquote>

| | |
Expand All @@ -182,7 +182,7 @@ description: JSON schema reference documentation for Git Proxy
| --------------------------------------- | ----------- |
| [authentication](#authentication_items) | - |

### <a name="autogenerated_heading_4"></a>3.1. Git Proxy configuration file > authentication > authentication
### <a name="autogenerated_heading_4"></a>3.1. GitProxy configuration file > authentication > authentication

| | |
| ------------------------- | ------------------------------------------------------------------------- |
Expand All @@ -192,7 +192,7 @@ description: JSON schema reference documentation for Git Proxy
| **Defined in** | #/definitions/authentication |

<details>
<summary><strong> <a name="authentication_items_type"></a>3.1.1. [Required] Property Git Proxy configuration file > authentication > authentication items > type</strong> </summary>
<summary><strong> <a name="authentication_items_type"></a>3.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type</strong> </summary>
<blockquote>

| | |
Expand All @@ -204,7 +204,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="authentication_items_enabled"></a>3.1.2. [Required] Property Git Proxy configuration file > authentication > authentication items > enabled</strong> </summary>
<summary><strong> <a name="authentication_items_enabled"></a>3.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled</strong> </summary>
<blockquote>

| | |
Expand All @@ -216,7 +216,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="authentication_items_options"></a>3.1.3. [Optional] Property Git Proxy configuration file > authentication > authentication items > options</strong> </summary>
<summary><strong> <a name="authentication_items_options"></a>3.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options</strong> </summary>
<blockquote>

| | |
Expand All @@ -232,7 +232,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="tempPassword"></a>4. [Optional] Property Git Proxy configuration file > tempPassword</strong> </summary>
<summary><strong> <a name="tempPassword"></a>4. [Optional] Property GitProxy configuration file > tempPassword</strong> </summary>
<blockquote>

| | |
Expand All @@ -244,7 +244,7 @@ description: JSON schema reference documentation for Git Proxy
**Description:** Toggle the generation of temporary password for git-proxy admin user

<details>
<summary><strong> <a name="tempPassword_sendEmail"></a>4.1. [Optional] Property Git Proxy configuration file > tempPassword > sendEmail</strong> </summary>
<summary><strong> <a name="tempPassword_sendEmail"></a>4.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail</strong> </summary>
<blockquote>

| | |
Expand All @@ -256,7 +256,7 @@ description: JSON schema reference documentation for Git Proxy
</details>

<details>
<summary><strong> <a name="tempPassword_emailConfig"></a>4.2. [Optional] Property Git Proxy configuration file > tempPassword > emailConfig</strong> </summary>
<summary><strong> <a name="tempPassword_emailConfig"></a>4.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig</strong> </summary>
<blockquote>

| | |
Expand Down
6 changes: 3 additions & 3 deletions website/docs/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
title: Introduction
---

### What is Git Proxy?
### What is GitProxy?

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.
GitProxy 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.
GitProxy 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.
10 changes: 5 additions & 5 deletions website/docs/installation.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
---
title: Installation
description: How to install Git Proxy in your environment
description: How to install GitProxy in your environment
---

### Install via [npm](https://www.npmjs.com/package/@finos/git-proxy)

To install Git Proxy, you must first install [Node.js](https://nodejs.org/en/download). Then, use the [npm package manager](https://www.npmjs.com/):
To install GitProxy, you must first install [Node.js](https://nodejs.org/en/download). Then, use the [npm package manager](https://www.npmjs.com/):

```bash
npm install -g @finos/git-proxy
```

To install the Git Proxy Command Line Interface (CLI), run:
To install the GitProxy Command Line Interface (CLI), run:

```bash
npm install -g @finos/git-proxy-cli
```

### Install a specific version

To install a specific version of Git Proxy, append the version to the end of the install command:
To install a specific version of GitProxy, append the version to the end of the install command:

```bash
npm install -g @finos/git-proxy@latest
```

To install a specific version of the Git Proxy CLI, append the version to the end of the install command:
To install a specific version of the GitProxy CLI, append the version to the end of the install command:

```bash
npm install -g @finos/[email protected]
Expand Down
Loading

0 comments on commit 3844985

Please sign in to comment.