Artifactory Bootstrap YAML File

Bootstrap Artifactory at startup using artifactory.config.import.yml for license, base URL, proxy, and repository settings.

Setting up JFrog Artifactory using the Bootstrap YAML configuration file is a convenient alternative to going through the startup wizard. It also gives you an easy way to save the basic configuration of one instance and reproduce that configuration in other instances.

For a new installation, you can configure your initial setup through the filesystem before starting Artifactory for the first time.

You can configure the following settings.

License
Base URL
Proxy server
Initial default repositories

When using the YAML configuration file, you do not have to configure all the above parameters. Configure only some of the parameters using the YAML file, then configure the others through the startup wizard, or manually after Artifactory starts.

📘
Note
From Artifactory version 7.58 and forward, the Artifactory Bootstrap YAML no longer contains LDAP (from Artifactory version 7.54), Crowd (from Artifactory version 7.57), or HTTP SSO (from Artifactory version 7.58) authentication provider configuration settings. Use the Access Configuration Bootstrap YAML to set up authentication provider configuration.
You can configure the following basic authentication settings through the Access Bootstrap YAML file:

httpSsoSettings

crowdSettings

ldapSettings

ldapGroupSettings

Limitations of Access Bootstrap YAML File

The limitations stem from the principle that the YAML configuration file is designated for configuration of new Artifactory instances that have not been used before.

No similar YAML file already exists — if a similar configuration file exists, it might override this file
After loading, the YAML configuration file is deleted
The base URL has not been set up, or the base URL has been set up and you did not configure it 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 of Artifactory Bootstrap YAML File

To configure the Artifactory Bootstrap YAML file:

Find the template file at $JFROG_HOME/artifactory/app/misc/artifactory.config.template.yml.
Uncomment the relevant sections and provide your configuration details.
Rename the file to artifactory.config.import.yml.
Place the renamed file in Artifactory's etc folder: $JFROG_HOME/artifactory/var/etc/artifactory/artifactory.config.import.yml.

The following snippet shows an example of the Artifactory Bootstrap YAML configuration file template.

Artifactory Bootstrap YAML configuration file template

---
version: 1
## This file is complementary to the JFrog Artifactory startup wizard, and may be used to specify the initial basic
## settings for a new Artifactory installation, namely:
## * License Key(s)
## * Base URL
## * Proxy
## * Default repositories
##
##
## HOW TO USE THIS FILE:
##
## To import these settings when bootstrapping Artifactory, save this file as artifactory.config.import.yml under Artifactory’s /etc folder
## Artifactory will load this file if all of the following conditions are met:
## - no repositories have been created
## - a proxy has not been set up, or you did set up a proxy externally, but did not configure proxy setup through this file
## - the base URL has not been set up, or you did set up the base URL externally, but did not configure the base URL setup through this file
## - Artifactory has not been activated with a license, or Artifactory has been activated with a license, and you did not specify a license in this file
##
## To have any of these parameters automatically configured when you bootstrap an Artifactory instance using this file,
## simply uncomment the relevant sections below, and where required, provide values.

##################################################################################
# General Configurations #
##################################################################################
GeneralConfiguration:
## License key to import in onboarding
       licenseKey : "Enter your license key"

## Setup the Artifactory base URL
## For more information about the Artifactory base URL, please refer to
## https://www.jfrog.com/confluence/display/RTF/Configuring+Artifactory#ConfiguringArtifactory-GeneralSettings
## Uncomment the line below to set the Artifactory base URL
#       baseUrl : "https://mycomp.arti.co"

## Configure proxies for artifactory
## For more information on configuring a proxy in Artifactory, please refer to
## https://www.jfrog.com/confluence/display/RTF/Managing+Proxies
## Uncomment the lines below to setup a proxy
#       proxies :
#               - key : "proxy1"
#               host : "https://proxy.mycomp.io"
#               port : 443
#               userName : "admin"
#               password : "password"
#               platformDefault : true
#               services: "jfxr, jfrt" ## (Optional field. Comma separated string of services, options are: jfrt, jfmc, jfxr, jfds)
#               - key : "proxy2"
#               ...
##################################################################################
# Onboarding Configurations #
##################################################################################
OnboardingConfiguration:
## Uncomment the package types for which you want to create default repositories
       repoTypes :
#               - bower
#               - cocoapods
#               - conan
#               - debian
#               - docker
#               - gems
#               - gradle
#               - ivy
#               - maven
#               - npm
#               - nuget
#               - opkg
#               - composer
#               - pypi
#               - sbt
#               - vagrant
#               - rpm
#               - gitlfs

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. Maintain indentation levels when editing the YAML configuration file.

When Artifactory is bootstrapped for the first time, it stores a copy of its initial configuration in the following file, whether bootstrapped using the Onboarding Wizard or using a YAML configuration file.

$JFROG_HOME/artifactory/var/etc/artifactory/artifactory.config.<timestamp>.yml

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.

Updated 2 days ago