Skip to content

Latest commit

 

History

History
525 lines (382 loc) · 17.2 KB

reference.mdx

File metadata and controls

525 lines (382 loc) · 17.2 KB
title description
Schema Reference
JSON schema reference documentation for GitProxy

Schema Reference

Title: GitProxy configuration file
Type object
Required No
Additional properties [Not allowed]

Description: Configuration for customizing git-proxy

1. [Optional] Property GitProxy configuration file > proxyUrl
Type string
Required No
2. [Optional] Property GitProxy configuration file > cookieSecret
Type string
Required No
3. [Optional] Property GitProxy configuration file > sessionMaxAgeHours
Type number
Required No
4. [Optional] Property GitProxy configuration file > api
Type object
Required No
Additional properties [Any type: allowed]

Description: Third party APIs

5. [Optional] Property GitProxy configuration file > commitConfig
Type object
Required 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 object
Required No
Additional properties [Any type: allowed]

Description: Customisable questions to add to attestation form

7. [Optional] Property GitProxy configuration file > privateOrganizations
Type array
Required No

Description: Pattern searches for listed private organizations are disabled

8. [Optional] Property GitProxy configuration file > urlShortener
Type string
Required No

Description: Customisable URL shortener to share in proxy responses and warnings

9. [Optional] Property GitProxy configuration file > contactEmail
Type string
Required No

Description: Customisable e-mail address to share in proxy responses and warnings

10. [Optional] Property GitProxy configuration file > csrfProtection
Type boolean
Required No

Description: Flag to enable CSRF protections for UI

11. [Optional] Property GitProxy configuration file > plugins
Type array of string
Required 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 -

11.1. GitProxy configuration file > plugins > plugins items
Type string
Required No
12. [Optional] Property GitProxy configuration file > authorisedList
Type array
Required No

Description: List of repositories that are authorised to be pushed to through the proxy.

Each item of this array must be Description
authorisedRepo -

12.1. GitProxy configuration file > authorisedList > authorisedRepo
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/authorisedRepo
12.1.1. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > project
Type string
Required Yes
12.1.2. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > name
Type string
Required Yes
12.1.3. [Required] Property GitProxy configuration file > authorisedList > authorisedList items > url
Type string
Required Yes
13. [Optional] Property GitProxy configuration file > sink
Type array
Required 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 -

13.1. GitProxy configuration file > sink > database
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/database
13.1.1. [Required] Property GitProxy configuration file > sink > sink items > type
Type string
Required Yes
13.1.2. [Required] Property GitProxy configuration file > sink > sink items > enabled
Type boolean
Required Yes
13.1.3. [Optional] Property GitProxy configuration file > sink > sink items > connectionString
Type string
Required No
13.1.4. [Optional] Property GitProxy configuration file > sink > sink items > options
Type object
Required No
Additional properties [Any type: allowed]
13.1.5. [Optional] Property GitProxy configuration file > sink > sink items > params
Type object
Required No
Additional properties [Any type: allowed]
14. [Optional] Property GitProxy configuration file > authentication
Type array
Required 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 -

14.1. GitProxy configuration file > authentication > authentication
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/authentication
14.1.1. [Required] Property GitProxy configuration file > authentication > authentication items > type
Type string
Required Yes
14.1.2. [Required] Property GitProxy configuration file > authentication > authentication items > enabled
Type boolean
Required Yes
14.1.3. [Optional] Property GitProxy configuration file > authentication > authentication items > options
Type object
Required No
Additional properties [Any type: allowed]
15. [Optional] Property GitProxy configuration file > tempPassword
Type object
Required No
Additional properties [Any type: allowed]

Description: Toggle the generation of temporary password for git-proxy admin user

15.1. [Optional] Property GitProxy configuration file > tempPassword > sendEmail
Type boolean
Required No
15.2. [Optional] Property GitProxy configuration file > tempPassword > emailConfig
Type object
Required 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 2024-10-02 at 13:21:09 -0400