Skip to content

Commit 94be122

Browse files
committedOct 2, 2023
chore: simple instructions for reproducing authorized repository happy path
1 parent 63b6243 commit 94be122

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed
 

‎README.md

+19-3
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,26 @@ npx --package=@finos/git-proxy@1.1.0 -- git-proxy # No installation required...
7575

7676
## Quickstart 🚀
7777

78-
#### 1. Run Git Proxy on your PC
78+
#### 1. Run Git Proxy with simple config
79+
80+
Create a `proxy.config.json` in a workspace with the following:
81+
82+
```json
83+
{
84+
"authorisedList": [
85+
{
86+
"project": "<YOUR-GITHUB-USERNAME>",
87+
"name": "git-proxy",
88+
"url": "https://github.com/<YOUR-GITHUB-USERNAME>/git-proxy.git"
89+
}
90+
],
91+
}
92+
```
93+
94+
Then run Git Proxy and load your `proxy.config.json` configuration file from your workspace:
7995

8096
```bash
81-
npx --package=@finos/git-proxy@1.1.0 -- git-proxy
97+
npx --package=@finos/git-proxy@1.1.0 -- git-proxy --config ./proxy.config.json
8298
```
8399

84100
#### 2. Pick a repository
@@ -136,7 +152,7 @@ git config --global credential.helper manager # Windows
136152
git config --global credential.helper store # Linux
137153
```
138154

139-
#### 6. Success & Next Steps
155+
#### 6. Success
140156

141157
Immediately after a push, you should receive the following message in your terminal:
142158

0 commit comments

Comments
 (0)
Please sign in to comment.