One of the easiest ways to configure your JFrog Platform and products is by customizing the YAML files that are installed with the system when it is deployed in your environment. JFrog supports several types of configuration files, each with its own purpose. To make it easier for you to understand how and when to use these different files, this article details the different files being used, their purpose, and where they are located. This article also lists the different places where you will find these files documented in the JFrog documentation.
Before you begin configuring your system, it is important to understand the different file types and their purposes.
Configuration versus Config Descriptor Files
Configuration files, also known as yaml or .yml extension files, are files that are installed with your system, and come with pre-defined defaults. While you can leave these defaults in place, the yaml files also provide a rich array of configuration options that allow you to customize your system configuration.
Config descriptor files, which have an .xml extension, are system files that contain the system definitions. For example, artifactory.config.xml contains the basic information on your system when it gets installed. As a rule, this file should not be changed because any errors introduced into the file can cause the system to not work properly. However, you can use this file to bootstrap another server in your system, by copying the system information to the additional server. The binarystore.xml, meanwhile, contains the information on the filestore that is installed with your system.
system.yaml files
Each JFrog Platform product is installed with a system.yaml file, which is the main configuration file for that product, enabling you to set the main configurations you wish to apply. Each product also includes the following variations on the system.yaml file:
system.basic-template.yamlincludes the most commonly used system configurations and is identical to thesystem.yamlafter a fresh installationsystem.full-template.yamlincludes a list of all available configurations
One additional variation on the system.yaml file is the values.yaml file, which is specific to Helm installations only. Unlike other installations, Helm Chart configurations are made to the values.yaml and are then applied to the system.yaml.
Using the system.yaml File
By default, the system.yaml file applies the default settings included with a fresh installation. A double ## marks a comment or a note, while a single # indicates a parameter that the customer can customize.
Removing the single # means the parameter becomes active and gets the default value set in the file. To change this value, simply enter a different value for the parameter.
Configuration YAML files
In addition to the system.yaml file, the JFrog Platform also includes configuration YAML files that are used to modify Access and the application configuration.
Configuration Files by Product
Artifactory
File Name | Description/Location | Used in... |
|---|---|---|
| This is the main configuration file for JFrog Artifactory, enabling you to set the main configurations you wish to apply.
| |
| This file is used to configure Artifactory in Helm installations. Unlike other installations, Helm Chart configurations are made to the | |
| Once you have configured your YAML file to include all the configuration changes needed, you can apply them by sending a PATCH request to | |
| When Artifactory is bootstrapped for the first time, it stores a copy of its initial configuration under
| |
| This file provides you with flexible filestore management capabilities. By modifying this file you can implement a variety of different storage configurations. These include basic and customizable local and network based file-systems, cloud storage, as well as redundant storage.
| This file provides you with flexible filestore management capabilities. By modifying this file you can implement a variety of different storage configurations. These include basic and customizable local and network based file-systems, cloud storage, as well as redundant storage. |
| This global Artifactory file is used to provide a default set of configuration parameters. The file is loaded by Artifactory during initial startup. Once the file is loaded, Artifactory renames it to
| |
| Unlike the default |
Xray
File Name | Description/Location | Used in... |
|---|---|---|
| This is the main configuration file for JFrog Xray, enabling you to set the main configurations you wish to apply.
| |
| This file is used to configure Xray in Helm installations. Unlike other installations, Helm Chart configurations are made to the |
Insight
File Name | Description/Location | Used in... |
|---|---|---|
| This is the main configuration file for JFrog Insight, enabling you to set the main configurations you wish to apply. | |
| This file is used to configure Insight in Helm installations. Unlike other installations, Helm Chart configurations are made to the |
Distribution
File Name | Description/Location | Used in... |
|---|---|---|
| This is the main configuration file for JFrog Distribution, enabling you to set the main configurations you wish to apply. | |
| This file is used to configure Distribution in Helm installations. Unlike other installations, Helm Chart configurations are made to the | |
| This yaml configuration file offers an alternative way to specify your initial settings for Distribution. To get you up and running as quickly and easily as possible for a new installation, you can configure your basic initial setup through the filesystem, before starting Distribution for the first time. Note that any edits will apply to the whole Distribution cluster. NoteModifying the Distribution configurations is an advanced feature, and if done incorrectly may render the Distribution service in an undefined and unusable state. Since it is easy to overwrite configurations, we strongly recommend backing up the configuration before making any direct changes, and taking great care when doing so.
|
Pipelines
File Name | Description/Location | Used in... |
|---|---|---|
| This is the main configuration file for JFrog Pipelines, enabling you to set the main configurations you wish to apply. | |
| This file is used to configure Pipelines in Helm installations. Unlike other installations, Helm Chart configurations are made to the |
Access Configuration File
File Name | Description/Location | Used in... |
|---|---|---|
| Access provides a flexible means of configuration using a simple YAML configuration file. You can make a single change at a time or multiple configuration changes as needed, to create, update and delete any elements in Access.
|