Global Configuration Descriptor

Skip to end of metadata
Go to start of metadata
Table of Contents

artifactory.config.xml

The global Artifactory configuration file is located in $ARTIFACTORY_HOME/etc/artifactory.config.xml.
The artifactory.config.xml file is loaded by Artifactory on startup.
The initial configuration that is bundled with Artifactory contains a sensible defaults configuration, that can be changed via the Administration UI.

Once Artifactory loads the artifactory.config.xml file, it renames the original file to artifactory.config.bootstrap.xml, and from now on, configuration is stored internally in Artifatcory's storage. This is done on purpose, to make sure Artifactory configuration and data are coherently stored in one place. It also makes it easier to back up and move Artifactory when using direct database backups.

On every startup Artifactory also writes the current configuration it loaded with to the $ARTIFACTORY_HOME/etc/artifactory.config.startup.xml file as a backup.

Direct Use of the Global Configuration Descriptor

The raw global configuration descriptor itself can be retrieved and manipulated through Artifactory's UI, or by using Artifactory's REST API.

Directly editing the global configuration descriptor is an advanced feature that can wipe all your configuration! Please make sure you know what you are doing and keep a backup of the configuration.

Getting or Saving the Global Configuration Descriptor through the UI

Go to Admin:Advanced:Config Descriptor and copy the security configuration from the text area.

Getting and Saving the Global Configuration Descriptor through REST API

To retrieve configuration send a GET request to http://<host>:<port>/artifactory/api/system/configuration, e.g.:

To set configuration send a POST request to http://<host>:<port>/artifactory/api/system/configuration with the configuration data, e.g.:

Note that you need to provide admin privileges with the request.

Bootstrapping Artifactory's Configuration

It is possible to bootstrap Artifactory with predefined global configuration by creating a $ARTIFACTORY_HOME/etc/artifactory.config.import.xml file containing the Artifactory configuration descriptor.

Once Artifactory sees this file at startup, it will use the information in the file to override its global configuration.
This can be useful if you wish to copy configuration between different Artifactory instances.

Labels: