System YAML Configuration File

One of the important requirements of modern-day applications is the ability to manage configuration as code. Configuration as code means that the file used to configure your system is immutable to the application, except when passwords and secrets are in plain text — in that case, the application encrypts them and writes the encrypted string back to the file.

Configuration as code works in “cloud native” setups, where the configuration file can be injected when the application starts up. You can modify the configuration externally while the application is not running and provide it to the application at startup.

Place the modified file in the correct filesystem path (for Linux, Docker, RPM, and Debian installations) or as a secret in Helm installations using the Helm values.yaml file.

Implementing Configuration as Code in JFrog

JFrog provides a flexible way to configure your system using a single system.yaml configuration file found in the $JFROG_HOME/<product>/var/etc folder for each product.

Using System YAMLs

Reference for the JFrog Platform system.yaml file format, including key-entity structure, syntax rules, and how to apply configuration changes across JFrog services.

Artifactory System YAML

A complete example of the JFrog Artifactory system.yaml file showing all configurable parameters for database, filestore, security, and service settings.

Xray System YAML

A complete example of the JFrog Xray system.yaml file showing all configurable parameters for database, RabbitMQ, storage, and server settings.

Distribution System YAML

The Distribution system YAML file contains all configurable parameters constructed with keys and entities.