The default, configurable tag expiration time for time machine. Defaults to `2w`.
+
Pattern: ^[0-9]+(w|m|d|h|s)$
+
+
+
+
DISTRIBUTED_STORAGE_CONFIG
+
[object]
+
required
+
+
+
Configuration for storage engine(s) to use in Quay. Each key is a unique ID for a storage engine, with the value being a tuple of the type and configuration for that engine.
The preferred storage engine(s) (by ID in DISTRIBUTED_STORAGE_CONFIG) to use. A preferred engine means it is first checked for pullig and images are pushed to it.
+
Min Items: None
+
Example: [u's3_us_east', u's3_us_west']
+
+
+
+
+
array item
+
[string]
+
+
+
+
+
+
+
+
+
PREFERRED_URL_SCHEME
+
[string]
+
required
+
+
+
The URL scheme to use when hitting Quay. If Quay is behind SSL *at all*, this *must* be `https`
+
enum: http, https
+
Example: https
+
+
+
+
SERVER_HOSTNAME
+
[string]
+
required
+
+
+
The URL at which Quay is accessible, without the scheme.
+
Example: quay.io
+
+
+
+
TAG_EXPIRATION_OPTIONS
+
[array]
+
required
+
+
+
The options that users can select for expiration of tags in their namespace (if enabled)
+
Min Items: None
+
+
+
+
+
array item
+
[string]
+
+
+
+
+
Pattern: ^[0-9]+(w|m|d|h|s)$
+
+
+
+
+
USER_EVENTS_REDIS
+
[object]
+
required
+
+
+
Connection information for Redis for user event handling
+
+
+
+
+
host
+
[string]
+
required
+
+
+
The hostname at which Redis is accessible
+
Example: my.redis.cluster
+
+
+
+
password
+
[string]
+
+
+
+
The password to connect to the Redis instance
+
Example: mypassword
+
+
+
+
port
+
[number]
+
+
+
+
The port at which Redis is accessible
+
Example: 1234
+
+
+
+
+
ALLOW_PULLS_WITHOUT_STRICT_LOGGING
+
[boolean]
+
+
+
+
If true, pulls in which the pull audit log entry cannot be written will still succeed. Useful if the database can fallback into a read-only state and it is desired for pulls to continue during that time. Defaults to False.
+
Example: True
+
+
+
+
AVATAR_KIND
+
[string]
+
+
+
+
The types of avatars to display, either generated inline (local) or Gravatar (gravatar)
+
enum: local, gravatar
+
+
+
+
BITTORRENT_ANNOUNCE_URL
+
[string]
+
+
+
+
The URL of the announce endpoint on the bittorrent tracker
+
Pattern: ^http(s)?://(.)+$
+
Example: https://localhost:6881/announce
+
+
+
+
BITTORRENT_PIECE_SIZE
+
[number]
+
+
+
+
The bittorent piece size to use. If not specified, defaults to 512 * 1024.
+
Example: 524288
+
+
+
+
CONTACT_INFO
+
[array]
+
+
+
+
If specified, contact information to display on the contact page. If only a single piece of contact information is specified, the contact footer will link directly.
+
Min Items: 1
+
Unique Items: True
+
+
+
+
+
array item 0
+
[string]
+
+
+
+
Adds a link to send an e-mail
+
Pattern: ^mailto:(.)+$
+
Example: mailto:support@quay.io
+
+
+
+
array item 1
+
[string]
+
+
+
+
Adds a link to visit an IRC chat room
+
Pattern: ^irc://(.)+$
+
Example: irc://chat.freenode.net:6665/quay
+
+
+
+
array item 2
+
[string]
+
+
+
+
Adds a link to call a phone number
+
Pattern: ^tel:(.)+$
+
Example: tel:+1-888-930-3475
+
+
+
+
array item 3
+
[string]
+
+
+
+
Adds a link to a defined URL
+
Pattern: ^http(s)?://(.)+$
+
Example: https://twitter.com/quayio
+
+
+
+
+
DIRECT_OAUTH_CLIENTID_WHITELIST
+
[array]
+
+
+
+
A list of client IDs of *Quay-managed* applications that are allowed to perform direct OAuth approval without user approval.
Configuration for using Gitlab (Enterprise) for external authentication
+
+
+
+
+
CLIENT_ID
+
[string]
+
required
+
+
+
The registered client ID for this Quay instance
+
Example: 0e8dbe15c4c7630b6780
+
+
+
+
CLIENT_SECRET
+
[string]
+
required
+
+
+
The registered client secret for this Quay instance
+
Example: e4a58ddd3d7408b7aec109e85564a0d153d3e846
+
+
+
+
GITLAB_ENDPOINT
+
[string]
+
required
+
+
+
The endpoint at which Gitlab(Enterprise) is running
+
Example: https://gitlab.com
+
+
+
+
+
GOOGLE_LOGIN_CONFIG
+
[object]
+
+
+
+
Configuration for using Google for external authentication
+
+
+
+
+
CLIENT_ID
+
[string]
+
required
+
+
+
The registered client ID for this Quay instance
+
Example: 0e8dbe15c4c7630b6780
+
+
+
+
CLIENT_SECRET
+
[string]
+
required
+
+
+
The registered client secret for this Quay instance
+
Example: e4a58ddd3d7408b7aec109e85564a0d153d3e846
+
+
+
+
+
MAIL_DEFAULT_SENDER
+
[string]
+
+
+
+
If specified, the e-mail address used as the `from` when Quay sends e-mails. If none, defaults to `support@quay.io`.
+
Example: support@myco.com
+
+
+
+
MAIL_PASSWORD
+
[string]
+
+
+
+
The SMTP password to use when sending e-mails.
+
Example: mypassword
+
+
+
+
MAIL_PORT
+
[number]
+
+
+
+
The SMTP port to use. If not specified, defaults to 587.
+
Example: 588
+
+
+
+
MAIL_SERVER
+
[string]
+
+
+
+
The SMTP server to use for sending e-mails. Only required if FEATURE_MAILING is set to true.
+
Example: smtp.somedomain.com
+
+
+
+
MAIL_USERNAME
+
[string]
+
+
+
+
The SMTP username to use when sending e-mails.
+
Example: myuser
+
+
+
+
MAIL_USE_TLS
+
[boolean]
+
+
+
+
If specified, whether to use TLS for sending e-mails.
+
Example: True
+
+
+
+
MAXIMUM_LAYER_SIZE
+
[string]
+
+
+
+
Maximum allowed size of an image layer. Defaults to 20G
+
Pattern: ^[0-9]+(G|M)$
+
Example: 100G
+
+
+
+
PUBLIC_NAMESPACES
+
[array]
+
+
+
+
If a namespace is defined in the public namespace list, then it will appear on *all* user's repository list pages, regardless of whether that user is a member of the namespace. Typically, this is used by an enterprise customer in configuring a set of "well-known" namespaces.
+
Min Items: None
+
Unique Items: True
+
+
+
+
+
array item
+
[string]
+
+
+
+
+
+
+
+
+
REGISTRY_TITLE
+
[string]
+
+
+
+
If specified, the long-form title for the registry. Defaults to `Quay Enterprise`.
+
Example: Corp Container Service
+
+
+
+
REGISTRY_TITLE_SHORT
+
[string]
+
+
+
+
If specified, the short-form title for the registry. Defaults to `Quay Enterprise`.
+
Example: CCS
+
+
+
+
SECURITY_SCANNER_ENDPOINT
+
[string]
+
+
+
+
The endpoint for the security scanner
+
Pattern: ^http(s)?://(.)+$
+
Example: http://192.168.99.101:6060
+
+
+
+
SECURITY_SCANNER_INDEXING_INTERVAL
+
[number]
+
+
+
+
The number of seconds between indexing intervals in the security scanner. Defaults to 30.
+
Example: 30
+
+
+
+
SUPER_USERS
+
[array]
+
+
+
+
Quay usernames of those users to be granted superuser privileges
+
Min Items: None
+
Unique Items: True
+
+
+
+
+
array item
+
[string]
+
+
+
+
+
+
+
+
+
TEAM_RESYNC_STALE_TIME
+
[string]
+
+
+
+
If team syncing is enabled for a team, how often to check its membership and resync if necessary (Default: 30m)