Setup
Setting up Artifactory using the YAML configuration file is a convenient alternative to going through the startup wizard. In addition, it gives you an easy way to save the basic configuration of one instance and then quickly and easily reproduce that configuration in other instances you set up.
When using the YAML configuration file, you don't have to configure all the parameters described in the Overview above. You may configure only some of the parameters using the YAML file, and then configure the others through the start up wizard, or manually later on after Artifactory has started up.
Limitations
These limitations stem from the principle that the YAML configuration file is designated for configuration of new Artifactory instances that essentially, have not been used before. When bootstrapping a new instance of Artifactory, it will load the configuration specified in this file if all of the following conditions are met:
- No repositories have been created
- A proxy has not been set up, or a proxy has been set up and you did not configure proxy setup through the YAML configuration file
- The base URL has not been set up, or the base URL has been set up and you did not configure the base URL through the YAML configuration file
- Artifactory has not been activated with a license, or it has been activated with a license and you did not configure the license through the YAML configuration file
Location and Usage
The YAML configuration file template can be found under $JFROG_HOME/artifactory/app/misc/artifactory.config.template.yml
. To specify your initial bootstrap configuration, un-comment the relevant sections in the file and provide the configuration details. Rename the file, save it as artifactory.config.import.yml
and place it under Artifactory's etc folder. When done you should have the following configuration file: $JFROG_HOME/artifactory/var/etc/artifactory/artifactory.config.import.yml
.
An example of the YAML configuration file template used for Artifactory can be found below:
For example, to set your base URL to be https://acme.artifactory.com
, you should uncomment the baseUrl section and, while keeping the same indentation, set:
baseUrl : "https://acme.artifactory.com"
Indentation
Indentation is significant in YAML. Make sure to maintain the same indentation levels when editing the YAML configuration file.
Exporting a Configuration
When Artifactory is bootstrapped for the first time, it stores a copy of its initial configuration under $JFROG_HOME/artifactory/var/etc/artifactory/artifactory.config.<timestamp>.yml
regardless of whether it was bootstrapped using the Onboarding Wizard, or using a YAML configuration file. To use this configuration to bootstrap additional Artifactory instances, copy the file into the new instance's $JFROG_HOME/artifactory/var/etc/artifactory
folder and rename it to artifactory.config.import.yml
.