OSS Review Toolkit configuration

ORT's main configuration file

Type object
File match **/.ort/config/config.yml **/.ort/config/config.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/oss-review-toolkit-configuration/latest.json
Source https://raw.githubusercontent.com/oss-review-toolkit/ort/main/integrations/schemas/ort-configuration-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

The main configuration file for the OSS-Review-Toolkit (ORT). A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/resources/reference.yml.

Properties

ort required
11 nested properties
licenseFilePatterns object
4 nested properties
licenseFilenames string[]
noticeFilenames string[]
patentFilenames string[]
otherLicenseFilenames string[]
severeIssueThreshold enum
Values: "HINT" "WARNING" "ERROR"
severeRuleViolationThreshold enum
Values: "HINT" "WARNING" "ERROR"
enableRepositoryPackageCurations boolean
enableRepositoryPackageConfigurations boolean
analyzer Latest Analyzer Configuration Schema
advisor object
2 nested properties
skipExcluded boolean
config Record<string, object>
downloader object
4 nested properties
allowMovingRevisions boolean
includedLicenseCategories string[]
skipExcluded boolean
sourceCodeOrigins SourceCodeOrigins[]
scanner object
11 nested properties
skipConcluded boolean
skipExcluded boolean
archive object
3 nested properties
enabled boolean
fileStorage object
One of: variant, variant, variant
postgresStorage object
detectedLicenseMapping Record<string, string>
fileListStorage object
2 nested properties
fileStorage object
One of: variant, variant, variant
postgresStorage object
config Record<string, object>
storages Record<string, object>
storageReaders StorageTypes[]
storageWriters StorageTypes[]
ignorePatterns string[]
provenanceStorage object
2 nested properties
fileStorage object
One of: variant, variant, variant
postgresStorage object
reporter object
1 nested properties
config Record<string, object> required
notifier object
2 nested properties
mail object
6 nested properties
hostName string
username string
password string
port integer
useSsl boolean
fromAddress string
jira object
3 nested properties
host string
username string
password string

Definitions

Advisor object
skipExcluded boolean
config Record<string, object>
AdvisorConfig Record<string, object>
Analyzer Latest Analyzer Configuration Schema
Downloader object
allowMovingRevisions boolean
includedLicenseCategories string[]
skipExcluded boolean
sourceCodeOrigins SourceCodeOrigins[]
LicenseFilePatterns object
licenseFilenames string[]
noticeFilenames string[]
patentFilenames string[]
otherLicenseFilenames string[]
Notifier object
mail object
6 nested properties
hostName string
username string
password string
port integer
useSsl boolean
fromAddress string
jira object
3 nested properties
host string
username string
password string
Jira object
host string
username string
password string
Mail object
hostName string
username string
password string
port integer
useSsl boolean
fromAddress string
Reporter object
config Record<string, object> required
ReporterOptions Record<string, object>
Scanner object
skipConcluded boolean
skipExcluded boolean
archive object
3 nested properties
enabled boolean
fileStorage object
One of: variant, variant, variant
3 nested properties
localFileStorage object
httpFileStorage object
s3FileStorage object
postgresStorage object
1 nested properties
connection object required
detectedLicenseMapping Record<string, string>
fileListStorage object
2 nested properties
fileStorage object
One of: variant, variant, variant
3 nested properties
localFileStorage object
httpFileStorage object
s3FileStorage object
postgresStorage object
1 nested properties
connection object required
config Record<string, object>
storages Record<string, object>
storageReaders StorageTypes[]
storageWriters StorageTypes[]
ignorePatterns string[]
provenanceStorage object
2 nested properties
fileStorage object
One of: variant, variant, variant
3 nested properties
localFileStorage object
httpFileStorage object
s3FileStorage object
postgresStorage object
1 nested properties
connection object required
Archive object
enabled boolean
fileStorage object
One of: variant, variant, variant
3 nested properties
localFileStorage object
2 nested properties
directory string required
compression boolean
httpFileStorage object
3 nested properties
url string required
format=uri
query string
headers Record<string, boolean | number | string>
s3FileStorage object
6 nested properties
bucketName string required
accessKeyId string
awsRegion string
compression boolean
customEndpoint string
secretAccessKey string
postgresStorage object
1 nested properties
connection object required
14 nested properties
url string required
username string required
schema string
password string
sslmode string
sslcert string
sslkey string
sslrootcert string
connectionTimeout integer
idleTimeout integer
keepaliveTime integer
maxLifetime integer
maximumPoolSize integer
minimumIdle integer
FileListStorage object
fileStorage object
One of: variant, variant, variant
3 nested properties
localFileStorage object
2 nested properties
directory string required
compression boolean
httpFileStorage object
3 nested properties
url string required
format=uri
query string
headers Record<string, boolean | number | string>
s3FileStorage object
6 nested properties
bucketName string required
accessKeyId string
awsRegion string
compression boolean
customEndpoint string
secretAccessKey string
postgresStorage object
1 nested properties
connection object required
14 nested properties
url string required
username string required
schema string
password string
sslmode string
sslcert string
sslkey string
sslrootcert string
connectionTimeout integer
idleTimeout integer
keepaliveTime integer
maxLifetime integer
maximumPoolSize integer
minimumIdle integer
FileStorage object
localFileStorage object
2 nested properties
directory string required
compression boolean
httpFileStorage object
3 nested properties
url string required
format=uri
query string
headers Record<string, boolean | number | string>
s3FileStorage object
6 nested properties
bucketName string required
accessKeyId string
awsRegion string
compression boolean
customEndpoint string
secretAccessKey string
LocalFileStorage object
directory string required
compression boolean
HttpFileStorage object
url string required
format=uri
query string
headers Record<string, boolean | number | string>
S3FileStorage object
bucketName string required
accessKeyId string
awsRegion string
compression boolean
customEndpoint string
secretAccessKey string
PostgresConfig object
connection object required
14 nested properties
url string required
username string required
schema string
password string
sslmode string
sslcert string
sslkey string
sslrootcert string
connectionTimeout integer
idleTimeout integer
keepaliveTime integer
maxLifetime integer
maximumPoolSize integer
minimumIdle integer
Connection object
url string required
username string required
schema string
password string
sslmode string
sslcert string
sslkey string
sslrootcert string
connectionTimeout integer
idleTimeout integer
keepaliveTime integer
maxLifetime integer
maximumPoolSize integer
minimumIdle integer
DetectedLicenseMapping Record<string, string>
ScannerConfig Record<string, object>
ProvenanceStorage object
fileStorage object
One of: variant, variant, variant
3 nested properties
localFileStorage object
2 nested properties
directory string required
compression boolean
httpFileStorage object
3 nested properties
url string required
format=uri
query string
headers Record<string, boolean | number | string>
s3FileStorage object
6 nested properties
bucketName string required
accessKeyId string
awsRegion string
compression boolean
customEndpoint string
secretAccessKey string
postgresStorage object
1 nested properties
connection object required
14 nested properties
url string required
username string required
schema string
password string
sslmode string
sslcert string
sslkey string
sslrootcert string
connectionTimeout integer
idleTimeout integer
keepaliveTime integer
maxLifetime integer
maximumPoolSize integer
minimumIdle integer
Storages Record<string, object>
Severity enum
SourceCodeOrigins enum
StorageTypes enum
Headers Record<string, boolean | number | string>