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
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 - 16.1. GitProxy configuration file > authentication > authentication
Type objectRequired No Additional properties Any type allowed Defined in #/definitions/authentication 16.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type
Type stringRequired Yes
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 > tls
Type objectRequired No Additional properties Any type allowed Description: TLS configuration for secure connections
Generated using json-schema-for-humans on 2025-05-01 at 18:17:32 +0100