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 > privateOrganizations
Type arrayRequired No Description: Pattern searches for listed private organizations are disabled
9. [Optional] Property GitProxy configuration file > urlShortener
Type stringRequired No Description: Customisable URL shortener to share in proxy responses and warnings
10. [Optional] Property GitProxy configuration file > contactEmail
Type stringRequired No Description: Customisable e-mail address to share in proxy responses and warnings
11. [Optional] Property GitProxy configuration file > csrfProtection
Type booleanRequired No Description: Flag to enable CSRF protections for UI
12. [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 - 12.1. GitProxy configuration file > plugins > plugins items
Type stringRequired No
13. [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 - 13.1. GitProxy configuration file > authorisedList > authorisedRepo
Type objectRequired No Additional properties Any type allowed Defined in #/definitions/authorisedRepo 13.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project
Type stringRequired Yes
14. [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 - 14.1. GitProxy configuration file > sink > database
Type objectRequired No Additional properties Any type allowed Defined in #/definitions/database 14.1.1. [Required] Property GitProxy configuration file > sink > sink items > type
Type stringRequired Yes 14.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled
Type booleanRequired Yes 14.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString
Type stringRequired No
15. [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 15.1. GitProxy configuration file > authentication > authentication
Type objectRequired No Additional properties Any type allowed Defined in #/definitions/authentication Description: Configuration for an authentication source
15.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type
Type enum (of string)Required Yes Must be one of:
- "local"
- "ActiveDirectory"
- "OpenIdConnect"
15.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled
Type booleanRequired Yes 15.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > adminGroup
Type stringRequired No Description: Group that indicates that a user is an admin
15.1.4. [Optional] Property GitProxy configuration file > authentication > authentication items > userGroup
Type stringRequired No Description: Group that indicates that a user should be able to login to the Git Proxy UI and can work as a reviewer
15.1.5. [Optional] Property GitProxy configuration file > authentication > authentication items > domain
Type stringRequired No Description: Active Directory domain
15.1.6. [Optional] Property GitProxy configuration file > authentication > authentication items > 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.15.1.6.1. [Required] Property GitProxy configuration file > authentication > authentication items > adConfig > url
Type stringRequired Yes Description: Active Directory server to connect to, e.g.
ldap://ad.example.com.15.1.6.2. [Required] Property GitProxy configuration file > authentication > authentication items > adConfig > baseDN
Type stringRequired Yes Description: The root DN from which all searches will be performed, e.g.
dc=example,dc=com.
16. [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
16.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail
Type booleanRequired No 16.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
Generated using json-schema-for-humans on 2025-04-02 at 15:34:59 +0100