Gradle Enterprise

2.0

Schema URL

https://catalog.lintel.tools/schemas/schemastore/gradle-enterprise/versions/2.0.json
← Back to Gradle Enterprise
Type: object

Gradle Enterprise configuration schema

Properties

version const: 2 required

The version of the config file model (must be 2).

Constant: 2
systemPassword string required

The password for the system user

pattern=^(?:\s*[A-Za-z0-9+/]){43}(?:\s*=):(?:(?:\s*[A-Za-z0-9+/]){4})*(?:(?:\s*[A-Za-z0-9+/]){2}(?:\s*=){2}|(?:\s*[A-Za-z0-9+/]){3}(?:\s*=))?\s*$
additionalTrust string | null

Required if Gradle Enterprise must communicate with servers using certificates not trusted by default

format=gradle-enterprise:x509-certs-pempattern=^(?:^^-----BEGIN CERTIFICATE-----(?:\r?\n)(?:(?:\s*[A-Za-z0-9+/]){4})*(?:(?:\s*[A-Za-z0-9+/]){2}(?:\s*=){2}|(?:\s*[A-Za-z0-9+/]){3}(?:\s*=))?\s*^-----END CERTIFICATE-----(?:\r?\n)?)+$
advanced object
1 nested properties
jvmOptions object
4 nested properties
admin object
4 nested properties
additionalOptions string | null

Extra parameters and configuration for the Java process

heapMemory integer

The amount of heap memory allocated to the Java process

min=100
includeBaseOptions boolean
offHeapMemory integer

The amount of off-heap memory allocated to the Java process

min=100
buildCache object
4 nested properties
additionalOptions string | null

Extra parameters and configuration for the Java process

heapMemory integer

The amount of heap memory allocated to the Java process

min=100
includeBaseOptions boolean
offHeapMemory integer

The amount of off-heap memory allocated to the Java process

min=100
buildScans object
4 nested properties
additionalOptions string | null

Extra parameters and configuration for the Java process

heapMemory integer

The amount of heap memory allocated to the Java process

min=100
includeBaseOptions boolean
offHeapMemory integer

The amount of off-heap memory allocated to the Java process

min=100
distributionBroker object
4 nested properties
additionalOptions string | null

Extra parameters and configuration for the Java process

heapMemory integer

The amount of heap memory allocated to the Java process

min=100
includeBaseOptions boolean
offHeapMemory integer

The amount of off-heap memory allocated to the Java process

min=100
auth object

Configuration of Gradle Enterprise authentication options

3 nested properties
anonymousRoles string[]
uniqueItems=true
external null | object
timeouts object

Timeouts you can specify for user logins in Gradle Enterprise

3 nested properties
accessTokenLifespan integer

The maximum time before an access token is expired (in minutes), default is 10 minutes

ssoSessionIdleTimeout integer

The time a login session is allowed to be idle before it expires (in minutes), default is 4 days (5760 minutes)

ssoSessionMaxLifespan integer

The maximum time before a login session is expired (in minutes), default is 30 days (43200 minutes)

backups object | null

Automatic backup configuration

3 nested properties
schedule object required
All of: variant, variant, variant
1 nested properties
type enum required
Values: "daily" "weekly" "cron"
backupsToRetain integer

How many old backups to keep

min=1
emailNotification boolean

Send an email when backup is complete

buildCache object

Configuration specific to the build cache app

1 nested properties
allowUntrustedNodeSsl boolean

Allow communication with nodes running over untrusted SSL

buildScans object

Configuration specific to the build scans app

2 nested properties
diskSpaceMonitoring object
3 nested properties
autoDeleteWhileFreeSpaceLessThanPercentage integer | null

Threshold of free disk space before old scans will be automatically deleted

min=1max=100
rejectIncomingWhileFreeSpaceLessThanPercentage integer | null

Threshold of free disk space before new scans will be rejected

min=1max=100
sendWarningEmailWhenFreeSpaceLessThanPercentage integer | null

Threshold of free disk space before a warning is sent to users publishing a build scan

min=1max=100
keepDays integer | null

How many days of scans should be retained

min=2
dailyMaintenanceTime
All of: TimeOfDay string, variant
email object | null

SMTP configuration for notifications

5 nested properties
administratorAddress required
All of: EmailAddress string, variant
fromAddress required
All of: EmailAddress string, variant
smtpServer string required

Address and port of the smtp server

pattern=^(?:(?:(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}(?:[0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|(?:(?:[a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*(?:[A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])):(?:[1-9][0-9]{0,3}|[1-6][0-5][0-5][0-3][0-5])$
authentication object | null

SMTP authentication method

3 nested properties
password string required
pattern=^(?:plain:.+|aes256:(?:\s*[A-Za-z0-9+/]){16}:(?:\s*[A-Za-z0-9+/]){16}:(?:(?:\s*[A-Za-z0-9+/]){4})*(?:(?:\s*[A-Za-z0-9+/]){2}(?:\s*=){2}|(?:\s*[A-Za-z0-9+/]){3}(?:\s*=))?\s*)$
type string required
Values: "login" "cramMd5" "plain"
username string required
sslProtocol string | null

SMTP protocol flavour

Values: null "startTls" "implicitTls"
helpContact object

Who users should contact if they have a problem

2 nested properties
email null | EmailAddress

The email address users should contact

name string | null

The name of the contact

Definitions

CronBackupSchedule object
expression string required

Custom cron expression for backup time

pattern=^(?:\*|(?:(?:\*\/)?[1-5]?[0-9])) (?:\*|(?:(?:\*\/)?(?:1?[0-9]|2[0-3]))) (?:\*|(?:(?:\*\/)?(?:[1-9]|[12][0-9]|3[0-1]))) (?:\*|(?:(?:\*\/)?(?:[1-9]|1[0-2]))) (?:\*|(?:(?:\*\/)?[0-6]))$
type const: "cron"
Constant: "cron"
DailyBackupSchedule object
timeOfDay required
All of: TimeOfDay string, variant
type const: "daily"
Constant: "daily"
EmailAddress string

Internet email address conforming to most of RFC 822 syntax rules and by that allowing a majority of internalized email addresses as well.

EncryptedSecret string
ExternalAuthRoleMappings object
administration string

Allows access to installation administrative functions

buildScanPublish string

Allows publishing of build scans

buildScanView string

Allows viewing of build scans

cacheAdministration string

Allows access to build cache administration functions

dataExport string

Allows use of Export API

testDistribution string

Allows use of test distribution

ExternalLdapRoles object
baseDn string required

Base DN for the subtree holding roles

membershipAttribute string required

Name of the LDAP attribute holding role membership

membershipAttributeType string required

Type of the membership-ldap-attribute

Values: "dn" "uid"
nameAttribute string required

Name of the LDAP attribute holding the role name

objectClass string required

LDAP object classes for roles

type const: "external"
Constant: "external"
mappings
All of: ExternalAuthRoleMappings object, variant
recursive boolean

Whether to retrieve roles recursively by traversing a tree (defaults to false)

ExternalSamlRoles object
attribute string required

Name of the SAML attribute holding role names

type const: "external"
Constant: "external"
mappings
All of: ExternalAuthRoleMappings object, variant
LdapExternalAuth object
connectionUrl string required

URL used to connect to LDAP server

displayName string required

Name of this identity provider configuration

roles object required
All of: variant, variant
1 nested properties
type enum required
Values: "external" "local"
users object required
3 nested properties
attributes object required

Describes how user attributes are mapped

5 nested properties
email string required

Name of the LDAP attribute holding email address

firstName string required

Name of the LDAP attribute holding first name

lastName string required

Name of the LDAP attribute holding last name

userName string required

Name of the LDAP attribute holding user name

uuid string required

Name of the LDAP attribute holding a unique id

baseDn string required

Base DN for the subtree holding users

filter
All of: string | null string | null, variant
type const: "ldap"
Constant: "ldap"
bindUser object | null

Binding information used when LDAP requires authentication

2 nested properties
dn string required

Distinguished name for the LDAP user account

password required
All of: EncryptedSecret string, variant
LocalLdapRoles object
type const: "local"
Constant: "local"
defaults string[]
uniqueItems=true
LocalSamlRoles object
type const: "local"
Constant: "local"
defaults string[]
uniqueItems=true
SamlExternalAuth object
displayName string required

Name of this identity provider configuration

idpMetadata string required

SAML metadata that describes this identity provider

pattern=^(?:(?:\s*[A-Za-z0-9+/]){4})*(?:(?:\s*[A-Za-z0-9+/]){2}(?:\s*=){2}|(?:\s*[A-Za-z0-9+/]){3}(?:\s*=))?\s*$
roles object required
All of: variant, variant
1 nested properties
type enum required
Values: "external" "local"
type const: "saml"
Constant: "saml"
options object

Groups all options and is only necessary when one or more needs to be enabled

4 nested properties
requireEncryptedAssertion boolean

Encrypt SAML assertions?

signAuthenticationRequests boolean

Sign authentication requests?

validateAssertionSignature boolean

Enable signature validation of SAML assertions?

validateResponseSignature boolean

Enable signature validation of SAML responses?

userAttributes object

Describes how user attributes are mapped

3 nested properties
email string | null

Name of the SAML attribute holding email address

firstName string | null

Name of the SAML attribute holding first name

lastName string | null

Name of the SAML attribute holding last name

TimeOfDay string
WeeklyBackupSchedule object
dayOfWeek string required

Day (in UTC) to perform the backup

Values: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"
timeOfDay required
All of: TimeOfDay string, variant
type const: "weekly"
Constant: "weekly"