Skip to content

Commit 3844985

Browse files
authored
Merge pull request finos#618 from DanielVenable/replace-Git-Proxy-with-GitProxy
docs: replaced "Git Proxy" with "GitProxy"
2 parents ee4eecd + 63d154f commit 3844985

File tree

10 files changed

+82
-83
lines changed

10 files changed

+82
-83
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,24 @@
3838
</div>
3939
<br />
4040

41-
## What is Git Proxy
41+
## What is GitProxy
4242

43-
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.
43+
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.
4444

45-
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.
45+
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.
4646

47-
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.
47+
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.
4848

4949
```mermaid
5050
sequenceDiagram
5151
actor Developer
5252
Developer->>+Git Server: git clone
5353
Developer->>Workstation: git remote add proxy <proxy-server>
54-
Developer->>+Git Proxy: git push proxy
55-
Git Proxy-->>-Developer: Failed license check
54+
Developer->>+GitProxy: git push proxy
55+
GitProxy-->>-Developer: Failed license check
5656
Developer->>Workstation: git commit -m 'fix license issue'
57-
Developer->>+Git Proxy: git push
58-
Git Proxy-->>-Git Server: Approved
57+
Developer->>+GitProxy: git push
58+
GitProxy-->>-Git Server: Approved
5959
```
6060

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

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

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

84-
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).
84+
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).
8585

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

9190
- [Quickstart](https://git-proxy.finos.org/docs/category/quickstart/)

website/docs/configuration/overview.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ description: How to customise push protections and policies
55

66
### Default configuration
77

8-
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
8+
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
99
demonstration purposes but is likely not what you want to deploy into your environment.
1010
### Customise configuration
1111

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

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

3232
### Alter the configuration path
3333

34-
To specify a different file name for your Git Proxy configuration, use:
34+
To specify a different file name for your GitProxy configuration, use:
3535

3636
```bash
3737
git-proxy --config ./config.json
@@ -44,7 +44,7 @@ npx -- @finos/git-proxy --config ./config.json
4444
```
4545

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

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

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

6363
```
@@ -67,7 +67,7 @@ export GIT_PROXY_UI_PORT="5000"
6767

6868
### Validate configuration
6969

70-
To validate your Git Proxy configuration, run:
70+
To validate your GitProxy configuration, run:
7171

7272
```bash
7373
git-proxy --validate

website/docs/configuration/reference.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Schema Reference
3-
description: JSON schema reference documentation for Git Proxy
3+
description: JSON schema reference documentation for GitProxy
44
---
55

66
# Schema Reference
77

8-
**Title:** Git Proxy configuration file
8+
**Title:** GitProxy configuration file
99

1010
| | |
1111
| ------------------------- | ------------------------------------------------------- |
@@ -16,7 +16,7 @@ description: JSON schema reference documentation for Git Proxy
1616
**Description:** Configuration for customizing git-proxy
1717

1818
<details>
19-
<summary><strong> <a name="authorisedList"></a>1. [Optional] Property Git Proxy configuration file > authorisedList</strong> </summary>
19+
<summary><strong> <a name="authorisedList"></a>1. [Optional] Property GitProxy configuration file > authorisedList</strong> </summary>
2020
<blockquote>
2121

2222
| | |
@@ -30,7 +30,7 @@ description: JSON schema reference documentation for Git Proxy
3030
| --------------------------------------- | ----------- |
3131
| [authorisedRepo](#authorisedList_items) | - |
3232

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

3535
| | |
3636
| ------------------------- | ------------------------------------------------------------------------- |
@@ -40,7 +40,7 @@ description: JSON schema reference documentation for Git Proxy
4040
| **Defined in** | #/definitions/authorisedRepo |
4141

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

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

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

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

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

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

8181
<details>
82-
<summary><strong> <a name="sink"></a>2. [Optional] Property Git Proxy configuration file > sink</strong> </summary>
82+
<summary><strong> <a name="sink"></a>2. [Optional] Property GitProxy configuration file > sink</strong> </summary>
8383
<blockquote>
8484

8585
| | |
@@ -93,7 +93,7 @@ description: JSON schema reference documentation for Git Proxy
9393
| ------------------------------- | ----------- |
9494
| [database](#sink_items) | - |
9595

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

9898
| | |
9999
| ------------------------- | ------------------------------------------------------------------------- |
@@ -103,7 +103,7 @@ description: JSON schema reference documentation for Git Proxy
103103
| **Defined in** | #/definitions/database |
104104

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

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

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

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

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

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

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

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

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

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

170170
<details>
171-
<summary><strong> <a name="authentication"></a>3. [Optional] Property Git Proxy configuration file > authentication</strong> </summary>
171+
<summary><strong> <a name="authentication"></a>3. [Optional] Property GitProxy configuration file > authentication</strong> </summary>
172172
<blockquote>
173173

174174
| | |
@@ -182,7 +182,7 @@ description: JSON schema reference documentation for Git Proxy
182182
| --------------------------------------- | ----------- |
183183
| [authentication](#authentication_items) | - |
184184

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

187187
| | |
188188
| ------------------------- | ------------------------------------------------------------------------- |
@@ -192,7 +192,7 @@ description: JSON schema reference documentation for Git Proxy
192192
| **Defined in** | #/definitions/authentication |
193193

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

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

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

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

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

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

234234
<details>
235-
<summary><strong> <a name="tempPassword"></a>4. [Optional] Property Git Proxy configuration file > tempPassword</strong> </summary>
235+
<summary><strong> <a name="tempPassword"></a>4. [Optional] Property GitProxy configuration file > tempPassword</strong> </summary>
236236
<blockquote>
237237

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

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

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

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

262262
| | |

website/docs/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Introduction
33
---
44

5-
### What is Git Proxy?
5+
### What is GitProxy?
66

7-
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.
7+
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.
88

9-
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.
9+
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.

website/docs/installation.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
---
22
title: Installation
3-
description: How to install Git Proxy in your environment
3+
description: How to install GitProxy in your environment
44
---
55

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

8-
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/):
8+
To install GitProxy, you must first install [Node.js](https://nodejs.org/en/download). Then, use the [npm package manager](https://www.npmjs.com/):
99

1010
```bash
1111
npm install -g @finos/git-proxy
1212
```
1313

14-
To install the Git Proxy Command Line Interface (CLI), run:
14+
To install the GitProxy Command Line Interface (CLI), run:
1515

1616
```bash
1717
npm install -g @finos/git-proxy-cli
1818
```
1919

2020
### Install a specific version
2121

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

2424
```bash
2525
npm install -g @finos/git-proxy@latest
2626
```
2727

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

3030
```bash
3131
npm install -g @finos/[email protected]

0 commit comments

Comments
 (0)