Cloud customer?
 Upgrade in MyJFrog >

Search





Working with an older version? JFrog Artifactory 6.x | JFrog Xray 2.x | JFrog Mission Control 3.x | JFrog Distribution 1.x |


Skip to end of metadata
Go to start of metadata

Overview

The YAML configuration file offers an alternative way to specify your initial settings allowing you to skip the onboarding wizard. 

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 Artifactory for the first time.

The following basic settings can be configured: 

  • License
  • Base URL 
  • Proxy server
  • Initial default repositories
Page contents

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:

 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. 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.


Copyright © 2021 JFrog Ltd.