Gradle Enterprise

13.0

Schema URL

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

Develocity configuration schema

Properties

version const: 13 required

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

Constant: 13
systemPassword required
All of: HashedSecret string, variant
advanced object
3 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
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 Develocity authentication options

6 nested properties
anonymousPermissions string[]

Permissions to assign to anonymous users - does not support administerApp, administerCache, or testDistribution

uniqueItems=true
external null | object
projects object

Configuration of project access control related options

2 nested properties
acceptAnonymousProjects boolean

Accept data from builds not associated with a project. Also allows build acceleration features (build caching, test distribution, etc) to work with builds not associated with a project.

enabled boolean

Enables per-project access control.

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 Develocity

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 1 hour (60 minutes)

ssoSessionMaxLifespan integer

The maximum time before a login session is expired (in minutes), default is 1 day (1440 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

3 nested properties
allowUntrustedNodeSsl boolean

Allow communication with nodes running over untrusted SSL

maxArtifactSize integer | null

Maximum artifact size the Built-in Build Cache accepts

storageSize integer

Total amount of storage in mebibytes reserved for the Built-in Build Cache

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
incomingStorageType null | string
keepDays integer | null

How many days of scans should be retained

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

Edge configuration

3 nested properties
develocityLocationName string

Develocity installation location name

edges object[]

Edge configurations

registrationKeys object[]

Edge registration keys

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 Develocity 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
identityProviderAttributeValue string | null
permissions string[]
uniqueItems=true
TimeOfDay string