Schema Reference
Title: GitProxy configuration file
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: Configuration for customizing git-proxy
4. [Optional] Property GitProxy configuration file > api
Type objectRequired No Additional properties Any type allowed Description: Third party APIs
4.1. [Optional] Property GitProxy configuration file > api > ls
Type objectRequired No Additional properties Any type allowed 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.
If this configuration is set direct querying of group membership via LDAP will be disabled.4.1.1. [Optional] Property GitProxy configuration file > api > ls > userInADGroup
Type stringRequired No Description: URL template for a GET request that confirms a user's membership of a specific group. Should respond with a non-empty 200 status if the user is a member of the group, an empty response or non-200 status indicates that the user is not a group member. If set, this URL will be queried and direct queries via LDAP will be disabled. The template should contain the following string placeholders, which will be replaced to produce the final URL:
- "<domain>": AD domain,
- "<name>": The group name to check membership of.
- "<id>": The username to check group membership for.
Example:
"https://somedomain.com/some/path/checkUserGroups?domain=<domain>&name=<name>&id=<id>"
5. [Optional] Property GitProxy configuration file > commitConfig
Type objectRequired No Additional properties Any type allowed Description: Enforce rules and patterns on commits including e-mail and message
6. [Optional] Property GitProxy configuration file > attestationConfig
Type objectRequired No Additional properties Any type allowed Description: Customisable questions to add to attestation form
7. [Optional] Property GitProxy configuration file > domains
Type objectRequired No Additional properties Any type allowed Description: Provide domains to use alternative to the defaults
8. [Optional] Property GitProxy configuration file > rateLimit
Type objectRequired No Additional properties Not allowed Description: API Rate limiting configuration.
8.1. [Required] Property GitProxy configuration file > rateLimit > windowMs
Type numberRequired Yes Description: How long to remember requests for, in milliseconds (default 10 mins).
8.2. [Required] Property GitProxy configuration file > rateLimit > limit
Type numberRequired Yes Description: How many requests to allow (default 150).
9. [Optional] Property GitProxy configuration file > privateOrganizations
Type arrayRequired No Description: Pattern searches for listed private organizations are disabled
10. [Optional] Property GitProxy configuration file > urlShortener
Type stringRequired No Description: Customisable URL shortener to share in proxy responses and warnings
11. [Optional] Property GitProxy configuration file > contactEmail
Type stringRequired No Description: Customisable e-mail address to share in proxy responses and warnings
12. [Optional] Property GitProxy configuration file > csrfProtection
Type booleanRequired No Description: Flag to enable CSRF protections for UI
13. [Optional] Property GitProxy configuration file > plugins
Type array of stringRequired No Description: List of plugins to integrate on GitProxy's push or pull actions. Each value is either a file path or a module name.
Each item of this array must be Description plugins items - 13.1. GitProxy configuration file > plugins > plugins items
Type stringRequired No
14. [Optional] Property GitProxy configuration file > authorisedList
Type arrayRequired No Description: List of repositories that are authorised to be pushed to through the proxy.
Each item of this array must be Description authorisedRepo - 14.1. GitProxy configuration file > authorisedList > authorisedRepo
Type objectRequired No Additional properties Any type allowed Defined in #/definitions/authorisedRepo 14.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project
Type stringRequired Yes
15. [Optional] Property GitProxy configuration file > sink
Type arrayRequired No Description: List of database sources. The first source in the configuration with enabled=true will be used.
Each item of this array must be Description database - 15.1. GitProxy configuration file > sink > database
Type objectRequired No Additional properties Any type allowed Defined in #/definitions/database 15.1.1. [Required] Property GitProxy configuration file > sink > sink items > type
Type stringRequired Yes 15.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled
Type booleanRequired Yes 15.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString
Type stringRequired No
16. [Optional] Property GitProxy configuration file > authentication
Type arrayRequired No Description: List of authentication sources. The first source in the configuration with enabled=true will be used.
Each item of this array must be Description authentication Configuration for an authentication source 16.1. GitProxy configuration file > authentication > authentication
Type combiningRequired No Additional properties Any type allowed Defined in #/definitions/authentication Description: Configuration for an authentication source
One of(Option) Local Auth Config Active Directory Auth Config Open ID Connect Auth Config JWT Auth Config 16.1.1. Property
GitProxy configuration file > authentication > authentication items > oneOf > Local Auth ConfigTitle: Local Auth Config
Type objectRequired No Additional properties Any type allowed Description: Configuration for the use of the local database as the authentication source.
16.1.2. Property
GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth ConfigTitle: Active Directory Auth Config
Type objectRequired No Additional properties Any type allowed Description: Configuration for Active Directory authentication.
16.1.2.1. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > type
Type constRequired Yes Specific value:
"ActiveDirectory"16.1.2.2. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > enabled
Type booleanRequired Yes 16.1.2.3. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > adminGroup
Type stringRequired Yes Description: Group that indicates that a user is an admin
16.1.2.4. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > userGroup
Type stringRequired Yes Description: Group that indicates that a user should be able to login to the Git Proxy UI and can work as a reviewer
16.1.2.5. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > domain
Type stringRequired Yes Description: Active Directory domain
16.1.2.6. [Optional] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > adConfig
Type objectRequired No Additional properties Any type allowed Description: Additional Active Directory configuration supporting LDAP connection which can be used to confirm group membership. For the full set of available options see the activedirectory 2 NPM module docs at https://www.npmjs.com/package/activedirectory2#activedirectoryoptions
Please note that if the Third Party APIs configapi.ls.userInADGroupis set then the REST API it represents is used in preference to direct querying of group memebership via LDAP.16.1.2.6.1. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > adConfig > url
Type stringRequired Yes Description: Active Directory server to connect to, e.g.
ldap://ad.example.com.16.1.2.6.2. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Active Directory Auth Config > adConfig > baseDN
Type stringRequired Yes Description: The root DN from which all searches will be performed, e.g.
dc=example,dc=com.16.1.3. Property
GitProxy configuration file > authentication > authentication items > oneOf > Open ID Connect Auth ConfigTitle: Open ID Connect Auth Config
Type objectRequired No Additional properties Any type allowed Description: Configuration for Open ID Connect authentication.
16.1.3.1. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Open ID Connect Auth Config > type
Type constRequired Yes Specific value:
"openidconnect"16.1.3.2. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Open ID Connect Auth Config > enabled
Type booleanRequired Yes 16.1.3.3. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Open ID Connect Auth Config > oidcConfig
Type objectRequired Yes Additional properties Any type allowed Description: Additional OIDC configuration.
16.1.3.3.1. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Open ID Connect Auth Config > oidcConfig > issuer
Type stringRequired Yes 16.1.3.3.2. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Open ID Connect Auth Config > oidcConfig > clientID
Type stringRequired Yes 16.1.3.3.3. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > Open ID Connect Auth Config > oidcConfig > clientSecret
Type stringRequired Yes 16.1.4. Property
GitProxy configuration file > authentication > authentication items > oneOf > JWT Auth ConfigTitle: JWT Auth Config
Type objectRequired No Additional properties Any type allowed Description: Configuration for JWT authentication.
16.1.4.1. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > JWT Auth Config > type
Type constRequired Yes Specific value:
"jwt"16.1.4.2. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > JWT Auth Config > enabled
Type booleanRequired Yes 16.1.4.3. [Required] Property GitProxy configuration file > authentication > authentication items > oneOf > JWT Auth Config > jwtConfig
17. [Optional] Property GitProxy configuration file > tempPassword
Type objectRequired No Additional properties Any type allowed Description: Toggle the generation of temporary password for git-proxy admin user
17.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail
Type booleanRequired No 17.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig
Type objectRequired No Additional properties Any type allowed Description: Generic object to configure nodemailer. For full type information, please see https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/nodemailer
18. [Optional] Property GitProxy configuration file > apiAuthentication
Type arrayRequired No Description: List of authentication sources for API endpoints. May be empty, in which case all endpoints are public.
Each item of this array must be Description authentication Configuration for an authentication source 18.1. GitProxy configuration file > apiAuthentication > authentication
Type combiningRequired No Additional properties Any type allowed Same definition as authentication_items Description: Configuration for an authentication source
19. [Optional] Property GitProxy configuration file > tls
Type objectRequired No Additional properties Any type allowed Description: TLS configuration for secure connections
20. [Optional] Property GitProxy configuration file > configurationSources
Type objectRequired No Additional properties Any type allowed
21. [Optional] Property GitProxy configuration file > uiRouteAuth
Type objectRequired No Additional properties Any type allowed Description: UI routes that require authentication (logged in or admin)
21.2. [Optional] Property GitProxy configuration file > uiRouteAuth > rules
Type arrayRequired No
Each item of this array must be Description routeAuthRule - 21.2.1. GitProxy configuration file > uiRouteAuth > rules > routeAuthRule
Type objectRequired No Additional properties Any type allowed Defined in #/definitions/routeAuthRule 21.2.1.1. [Optional] Property GitProxy configuration file > uiRouteAuth > rules > rules items > pattern
Type stringRequired No
Generated using json-schema-for-humans on 2025-06-04 at 23:10:45 +0100