Skip to content

Commit 7dcb756

Browse files
kriswestkriswest
committed
docs: regenerate schema doc
1 parent f0be1b4 commit 7dcb756

File tree

1 file changed

+147
-38
lines changed

1 file changed

+147
-38
lines changed

‎website/docs/configuration/reference.mdx‎

Lines changed: 147 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ description: JSON schema reference documentation for GitProxy
2626
| **Type** | `string` |
2727
| **Required** | No |
2828

29+
**Description:** Deprecated: Used in early versions of git proxy to configure the remote host that traffic is proxied to. In later versions, the repository URL is used to determine the domain proxied, allowing multiple hosts to be proxied by one instance.
30+
2931
</blockquote>
3032
</details>
3133

@@ -63,11 +65,11 @@ description: JSON schema reference documentation for GitProxy
6365
</summary>
6466
<blockquote>
6567

66-
| | |
67-
| ------------------------- | ---------------- |
68-
| **Type** | `object` |
69-
| **Required** | No |
70-
| **Additional properties** | Any type allowed |
68+
| | |
69+
| ------------------------- | ----------- |
70+
| **Type** | `object` |
71+
| **Required** | No |
72+
| **Additional properties** | Not allowed |
7173

7274
**Description:** Third party APIs
7375

@@ -77,11 +79,11 @@ description: JSON schema reference documentation for GitProxy
7779
</summary>
7880
<blockquote>
7981

80-
| | |
81-
| ------------------------- | ---------------- |
82-
| **Type** | `object` |
83-
| **Required** | No |
84-
| **Additional properties** | Any type allowed |
82+
| | |
83+
| ------------------------- | ----------- |
84+
| **Type** | `object` |
85+
| **Required** | No |
86+
| **Additional properties** | Not allowed |
8587

8688
**Description:** Configuration used in conjunction with ActiveDirectory auth, which relates to a REST API used to check user group membership, as opposed to direct querying via LDAP.<br />If this configuration is set direct querying of group membership via LDAP will be disabled.
8789

@@ -116,11 +118,13 @@ description: JSON schema reference documentation for GitProxy
116118
</summary>
117119
<blockquote>
118120

119-
| | |
120-
| ------------------------- | ---------------- |
121-
| **Type** | `object` |
122-
| **Required** | No |
123-
| **Additional properties** | Any type allowed |
121+
| | |
122+
| ------------------------- | ----------- |
123+
| **Type** | `object` |
124+
| **Required** | No |
125+
| **Additional properties** | Not allowed |
126+
127+
**Description:** Deprecated: Defunct property that was used to provide the API URL for GitHub. No longer referenced in the codebase.
124128

125129
<details>
126130
<summary>
@@ -146,6 +150,79 @@ description: JSON schema reference documentation for GitProxy
146150
</blockquote>
147151
</details>
148152

153+
<details>
154+
<summary>
155+
<strong> <a name="api_gitleaks"></a>4.3. [Optional] Property GitProxy configuration file > api > gitleaks</strong>
156+
</summary>
157+
<blockquote>
158+
159+
| | |
160+
| ------------------------- | ---------------- |
161+
| **Type** | `object` |
162+
| **Required** | No |
163+
| **Additional properties** | Any type allowed |
164+
165+
**Description:** Configuration for the gitleaks (https://github.com/gitleaks/gitleaks) plugin
166+
167+
<details>
168+
<summary>
169+
<strong> <a name="api_gitleaks_enabled"></a>4.3.1. [Optional] Property GitProxy configuration file > api > gitleaks > enabled</strong>
170+
</summary>
171+
<blockquote>
172+
173+
| | |
174+
| ------------ | --------- |
175+
| **Type** | `boolean` |
176+
| **Required** | No |
177+
178+
</blockquote>
179+
</details>
180+
181+
<details>
182+
<summary>
183+
<strong> <a name="api_gitleaks_ignoreGitleaksAllow"></a>4.3.2. [Optional] Property GitProxy configuration file > api > gitleaks > ignoreGitleaksAllow</strong>
184+
</summary>
185+
<blockquote>
186+
187+
| | |
188+
| ------------ | --------- |
189+
| **Type** | `boolean` |
190+
| **Required** | No |
191+
192+
</blockquote>
193+
</details>
194+
195+
<details>
196+
<summary>
197+
<strong> <a name="api_gitleaks_noColor"></a>4.3.3. [Optional] Property GitProxy configuration file > api > gitleaks > noColor</strong>
198+
</summary>
199+
<blockquote>
200+
201+
| | |
202+
| ------------ | --------- |
203+
| **Type** | `boolean` |
204+
| **Required** | No |
205+
206+
</blockquote>
207+
</details>
208+
209+
<details>
210+
<summary>
211+
<strong> <a name="api_gitleaks_configPath"></a>4.3.4. [Optional] Property GitProxy configuration file > api > gitleaks > configPath</strong>
212+
</summary>
213+
<blockquote>
214+
215+
| | |
216+
| ------------ | -------- |
217+
| **Type** | `string` |
218+
| **Required** | No |
219+
220+
</blockquote>
221+
</details>
222+
223+
</blockquote>
224+
</details>
225+
149226
</blockquote>
150227
</details>
151228

@@ -557,18 +634,18 @@ description: JSON schema reference documentation for GitProxy
557634

558635
**Description:** List of authentication sources. The first source in the configuration with enabled=true will be used.
559636

560-
| Each item of this array must be | Description |
561-
| --------------------------------------- | ------------------------------------------ |
562-
| [authentication](#authentication_items) | Configuration for an authentication source |
637+
| Each item of this array must be | Description |
638+
| ---------------------------------------------- | ------------------------------------------ |
639+
| [authenticationElement](#authentication_items) | Configuration for an authentication source |
563640

564-
### <a name="autogenerated_heading_5"></a>16.1. GitProxy configuration file > authentication > authentication
641+
### <a name="autogenerated_heading_5"></a>16.1. GitProxy configuration file > authentication > authenticationElement
565642

566-
| | |
567-
| ------------------------- | ---------------------------- |
568-
| **Type** | `combining` |
569-
| **Required** | No |
570-
| **Additional properties** | Any type allowed |
571-
| **Defined in** | #/definitions/authentication |
643+
| | |
644+
| ------------------------- | ----------------------------------- |
645+
| **Type** | `combining` |
646+
| **Required** | No |
647+
| **Additional properties** | Any type allowed |
648+
| **Defined in** | #/definitions/authenticationElement |
572649

573650
**Description:** Configuration for an authentication source
574651

@@ -1089,11 +1166,11 @@ Specific value: `"jwt"`
10891166

10901167
**Description:** List of authentication sources for API endpoints. May be empty, in which case all endpoints are public.
10911168

1092-
| Each item of this array must be | Description |
1093-
| ------------------------------------------ | ------------------------------------------ |
1094-
| [authentication](#apiAuthentication_items) | Configuration for an authentication source |
1169+
| Each item of this array must be | Description |
1170+
| ------------------------------------------------- | ------------------------------------------ |
1171+
| [authenticationElement](#apiAuthentication_items) | Configuration for an authentication source |
10951172

1096-
### <a name="autogenerated_heading_6"></a>18.1. GitProxy configuration file > apiAuthentication > authentication
1173+
### <a name="autogenerated_heading_6"></a>18.1. GitProxy configuration file > apiAuthentication > authenticationElement
10971174

10981175
| | |
10991176
| ------------------------- | --------------------------------------------- |
@@ -1168,7 +1245,39 @@ Specific value: `"jwt"`
11681245

11691246
<details>
11701247
<summary>
1171-
<strong> <a name="configurationSources"></a>20. [Optional] Property GitProxy configuration file > configurationSources</strong>
1248+
<strong> <a name="sslKeyPemPath"></a>20. [Optional] Property GitProxy configuration file > sslKeyPemPath</strong>
1249+
</summary>
1250+
<blockquote>
1251+
1252+
| | |
1253+
| ------------ | -------- |
1254+
| **Type** | `string` |
1255+
| **Required** | No |
1256+
1257+
**Description:** Deprecated: Path to SSL private key file (use tls.key instead)
1258+
1259+
</blockquote>
1260+
</details>
1261+
1262+
<details>
1263+
<summary>
1264+
<strong> <a name="sslCertPemPath"></a>21. [Optional] Property GitProxy configuration file > sslCertPemPath</strong>
1265+
</summary>
1266+
<blockquote>
1267+
1268+
| | |
1269+
| ------------ | -------- |
1270+
| **Type** | `string` |
1271+
| **Required** | No |
1272+
1273+
**Description:** Deprecated: Path to SSL certificate file (use tls.cert instead)
1274+
1275+
</blockquote>
1276+
</details>
1277+
1278+
<details>
1279+
<summary>
1280+
<strong> <a name="configurationSources"></a>22. [Optional] Property GitProxy configuration file > configurationSources</strong>
11721281
</summary>
11731282
<blockquote>
11741283

@@ -1183,7 +1292,7 @@ Specific value: `"jwt"`
11831292

11841293
<details>
11851294
<summary>
1186-
<strong> <a name="uiRouteAuth"></a>21. [Optional] Property GitProxy configuration file > uiRouteAuth</strong>
1295+
<strong> <a name="uiRouteAuth"></a>23. [Optional] Property GitProxy configuration file > uiRouteAuth</strong>
11871296
</summary>
11881297
<blockquote>
11891298

@@ -1197,7 +1306,7 @@ Specific value: `"jwt"`
11971306

11981307
<details>
11991308
<summary>
1200-
<strong> <a name="uiRouteAuth_enabled"></a>21.1. [Optional] Property GitProxy configuration file > uiRouteAuth > enabled</strong>
1309+
<strong> <a name="uiRouteAuth_enabled"></a>23.1. [Optional] Property GitProxy configuration file > uiRouteAuth > enabled</strong>
12011310
</summary>
12021311
<blockquote>
12031312

@@ -1211,7 +1320,7 @@ Specific value: `"jwt"`
12111320

12121321
<details>
12131322
<summary>
1214-
<strong> <a name="uiRouteAuth_rules"></a>21.2. [Optional] Property GitProxy configuration file > uiRouteAuth > rules</strong>
1323+
<strong> <a name="uiRouteAuth_rules"></a>23.2. [Optional] Property GitProxy configuration file > uiRouteAuth > rules</strong>
12151324
</summary>
12161325
<blockquote>
12171326

@@ -1224,7 +1333,7 @@ Specific value: `"jwt"`
12241333
| ----------------------------------------- | ----------- |
12251334
| [routeAuthRule](#uiRouteAuth_rules_items) | - |
12261335

1227-
#### <a name="autogenerated_heading_7"></a>21.2.1. GitProxy configuration file > uiRouteAuth > rules > routeAuthRule
1336+
#### <a name="autogenerated_heading_7"></a>23.2.1. GitProxy configuration file > uiRouteAuth > rules > routeAuthRule
12281337

12291338
| | |
12301339
| ------------------------- | --------------------------- |
@@ -1235,7 +1344,7 @@ Specific value: `"jwt"`
12351344

12361345
<details>
12371346
<summary>
1238-
<strong> <a name="uiRouteAuth_rules_items_pattern"></a>21.2.1.1. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > pattern</strong>
1347+
<strong> <a name="uiRouteAuth_rules_items_pattern"></a>23.2.1.1. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > pattern</strong>
12391348
</summary>
12401349
<blockquote>
12411350

@@ -1249,7 +1358,7 @@ Specific value: `"jwt"`
12491358

12501359
<details>
12511360
<summary>
1252-
<strong> <a name="uiRouteAuth_rules_items_adminOnly"></a>21.2.1.2. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > adminOnly</strong>
1361+
<strong> <a name="uiRouteAuth_rules_items_adminOnly"></a>23.2.1.2. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > adminOnly</strong>
12531362
</summary>
12541363
<blockquote>
12551364

@@ -1263,7 +1372,7 @@ Specific value: `"jwt"`
12631372

12641373
<details>
12651374
<summary>
1266-
<strong> <a name="uiRouteAuth_rules_items_loginRequired"></a>21.2.1.3. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > loginRequired</strong>
1375+
<strong> <a name="uiRouteAuth_rules_items_loginRequired"></a>23.2.1.3. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > loginRequired</strong>
12671376
</summary>
12681377
<blockquote>
12691378

@@ -1282,4 +1391,4 @@ Specific value: `"jwt"`
12821391
</details>
12831392

12841393
----------------------------------------------------------------------------------------------------------------------------
1285-
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-06-04 at 23:10:45 +0100
1394+
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2025-09-30 at 14:41:38 +0100

0 commit comments

Comments
 (0)