Gradle Enterprise

6.0

Schema URL

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

Gradle Enterprise configuration schema

Properties

version const: 6 required

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

Constant: 6
systemPassword required
All of: HashedSecret string, variant
advanced object
4 nested properties
app object
4 nested properties
heapMemory integer

The amount of heap memory allocated to the application

min=100
offHeapMemory integer

The amount of off-heap memory allocated to the application

min=100
params
All of: Map(ConfigParamKey,String) object, variant
scanPayloadCacheSize integer

The amount of memory for the scan payload event stream cache

appBackgroundProcessor object
3 nested properties
heapMemory integer

The amount of heap memory allocated to the application

min=100
offHeapMemory integer

The amount of off-heap memory allocated to the application

min=100
params
All of: Map(ConfigParamKey,String) object, variant
buildCacheNode object
3 nested properties
heapMemory integer

The amount of heap memory allocated to the application

min=100
offHeapMemory integer

The amount of off-heap memory allocated to the application

min=100
params
All of: Map(ConfigParamKey,String) object, variant
distributionBroker object
3 nested properties
heapMemory integer

The amount of heap memory allocated to the application

min=100
offHeapMemory integer

The amount of off-heap memory allocated to the application

min=100
params
All of: Map(ConfigParamKey,String) object, variant
auth object

Configuration of Gradle Enterprise authentication options

5 nested properties
anonymousPermissions string[]
uniqueItems=true
external null | object
roles Record<string, object>
scim object

Configuration for System for Cross-domain Identity Management (SCIM) support

2 nested properties
enabled boolean

Whether to allow access to the SCIM API for user and group management

token object | null

Token to authenticate with the SCIM API

3 nested properties
hash required
All of: HashedSecret string, variant
length integer required

The length of the token

prefix string required

The prefix of the token

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

3 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
storage object
2 nested properties
incomingStorageType string

Storage type of incoming builds

Values: "database" "s3"
s3 object | null

S3 scan storage configuration

5 nested properties
bucket string required

The name of the bucket to store the scan payloads

credentials object required

The aws credentials

All of: variant, variant
region string required

The region of the bucket

endpoint string | null
prefix string

The prefix

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 null | string
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

network object | null

Network configuration

2 nested properties
additionalTrust string | null

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

format=gradle-enterprise:x509-certs-pempattern=(?:^|\r?\n)-----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*(?:\r?\n)-----END CERTIFICATE-----(?:$|\r?\n)
proxy object | null

Http proxy config

5 nested properties
host string required

Proxy host

format=gradle-enterprise:hostpattern=^(?:(?:(?:[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]))$
auth object | null

Proxy authentication credentials

2 nested properties
password required
All of: EncryptedSecret string, variant
username string required

Proxy username

excludedHosts string[]

A list of hosts that should not be proxied

port integer

Proxy port

min=1max=65535
protocol string

Proxy protocol

Values: "http" "https"

Definitions

ConfigParamKey string
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
HashedSecret string
Map(ConfigParamKey,String) Record<string, string>
Role object
assignToNewExternalUsers boolean
description string | null
displayName string | null
externalValue string | null
permissions string[]
uniqueItems=true
TimeOfDay string