Settings
This is a reference for the user-specific configuration for Maven.
Includes things that should not be distributed with the pom.xml
file, such as developer identity, along with local settings, like proxy information.
The default location for the settings file is ~/.m2/settings.xml
.
<settings xmlns="http://maven.apache.org/SETTINGS/2.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/2.0.0 http://maven.apache.org/xsd/settings-2.0.0.xsd"> <localRepository/> <interactiveMode/> <usePluginRegistry/> <offline/> <proxies> <proxy> <active/> <protocol/> <username/> <password/> <port/> <host/> <nonProxyHosts/> <id/> </proxy> </proxies> <servers> <server> <username/> <password/> <privateKey/> <passphrase/> <filePermissions/> <directoryPermissions/> <configuration/> <id/> </server> </servers> <mirrors> <mirror> <mirrorOf/> <name/> <url/> <layout/> <mirrorOfLayouts/> <blocked/> <id/> </mirror> </mirrors> <repositories> <repository> <releases> <enabled/> <updatePolicy/> <checksumPolicy/> </releases> <snapshots> <enabled/> <updatePolicy/> <checksumPolicy/> </snapshots> <name/> <url/> <layout/> <id/> </repository> </repositories> <pluginRepositories> <pluginRepository> <releases> <enabled/> <updatePolicy/> <checksumPolicy/> </releases> <snapshots> <enabled/> <updatePolicy/> <checksumPolicy/> </snapshots> <name/> <url/> <layout/> <id/> </pluginRepository> </pluginRepositories> <profiles> <profile> <activation> <activeByDefault/> <jdk/> <os> <name/> <family/> <arch/> <version/> </os> <property> <name/> <value/> </property> <file> <missing/> <exists/> </file> <packaging/> </activation> <properties> <key>value</key> </properties> <repositories> <repository> <releases> <enabled/> <updatePolicy/> <checksumPolicy/> </releases> <snapshots> <enabled/> <updatePolicy/> <checksumPolicy/> </snapshots> <name/> <url/> <layout/> <id/> </repository> </repositories> <pluginRepositories> <pluginRepository> <releases> <enabled/> <updatePolicy/> <checksumPolicy/> </releases> <snapshots> <enabled/> <updatePolicy/> <checksumPolicy/> </snapshots> <name/> <url/> <layout/> <id/> </pluginRepository> </pluginRepositories> <id/> </profile> </profiles> <activeProfiles/> <pluginGroups/> </settings>
settings
Root element of the user configuration file.
Element | Type | Description |
---|---|---|
localRepository
|
String
|
The local repository.
Default value is: ${user.home}/.m2/repository |
interactiveMode
|
boolean
|
Whether Maven should attempt to interact with the user for input.
Default value: |
usePluginRegistry
|
boolean
|
Whether Maven should use the plugin-registry.xml file to manage plugin versions.
Default value: |
offline
|
boolean
|
Indicate whether maven should operate in offline mode full-time.
Default value: |
proxies/proxy*
|
List<Proxy>
|
(Many) Configuration for different proxy profiles. Multiple proxy profiles might come in handy for anyone working from a notebook or other mobile platform, to enable easy switching of entire proxy configurations by simply specifying the profile id, again either from the command line or from the defaults section below. |
servers/server*
|
List<Server>
|
(Many) Configuration of server-specific settings, mainly authentication method. This allows configuration of authentication on a per-server basis. |
mirrors/mirror*
|
List<Mirror>
|
(Many) Configuration of download mirrors for repositories. |
repositories/repository*
|
List<Repository>
|
(Many) The lists of the remote repositories. |
pluginRepositories/pluginRepository*
|
List<Repository>
|
(Many) The lists of the remote repositories for discovering plugins. |
profiles/profile*
|
List<Profile>
|
(Many) Configuration of build profiles for adjusting the build according to environmental parameters. |
activeProfiles/activeProfile*
|
List<String>
|
(Many) List of manually-activated build profiles, specified in the order in which they should be applied. |
pluginGroups/pluginGroup*
|
List<String>
|
(Many) List of groupIds to search for a plugin when that plugin groupId is not explicitly provided. |
proxy
The element contains information required to a proxy settings.
Element | Type | Description |
---|---|---|
active
|
String
|
Whether this proxy configuration is the active one. Note: While the type of this field is String for technical reasons, the semantic type is actually boolean .
Default value: |
protocol
|
String
|
The proxy protocol.
Default value: |
username
|
String
|
The proxy user. |
password
|
String
|
The proxy password. |
port
|
String
|
The proxy port. Note: While the type of this field is String for technical reasons, the semantic type is actually int .
Default value: |
host
|
String
|
The proxy host. |
nonProxyHosts
|
String
|
The list of non-proxied hosts (delimited by | ). |
id
|
String
|
Item identifier.
Default value: |
server
The element contains information required to a server settings.
Element | Type | Description |
---|---|---|
username
|
String
|
The username used to authenticate. |
password
|
String
|
The password used in conjunction with the username to authenticate. |
privateKey
|
String
|
The private key location used to authenticate. |
passphrase
|
String
|
The passphrase used in conjunction with the privateKey to authenticate. |
filePermissions
|
String
|
The permissions for files when they are created. |
directoryPermissions
|
String
|
The permissions for directories when they are created. |
configuration
|
DOM
|
Extra configuration for the transport layer. |
id
|
String
|
Item identifier.
Default value: |
mirror
A download mirror for a given repository.
Element | Type | Description |
---|---|---|
mirrorOf
|
String
|
A repository id or (since Maven 2.0.9) an expression matching one or many repository ids to mirror, e.g., central or *,!repo1 . * (since Maven 2.0.5), external:* (since Maven 2.0.9) and external:http:* (since Maven 3.8.0) have a special meaning: see Mirror Settings guide. |
name
|
String
|
The optional name that describes the mirror. |
url
|
String
|
The URL of the mirror repository. |
layout
|
String
|
The layout of the mirror repository.
Since: Maven 3. Default value: |
mirrorOfLayouts
|
String
|
The layouts of repositories being mirrored. This value can be used to restrict the usage of the mirror to repositories with a matching layout (apart from a matching id).
Since: Maven 3. Default value: |
blocked
|
boolean
|
Whether this mirror should be blocked from any download request but fail the download process, explaining why.
Default value is: false
Since: Maven 3.8.0 Default value: |
id
|
String
|
Item identifier.
Default value: |
repository
Repository contains the information needed for establishing connections with remote repository
Element | Type | Description |
---|---|---|
releases
|
RepositoryPolicy
|
How to handle downloading of releases from this repository |
snapshots
|
RepositoryPolicy
|
How to handle downloading of snapshots from this repository |
name
|
String
|
Human readable name of the repository. |
url
|
String
|
The url of the repository. |
layout
|
String
|
The type of layout this repository uses for locating and storing artifacts - can be "legacy" or "default".
Default value: |
id
|
String
|
Item identifier.
Default value: |
releases
Download policy
Element | Type | Description |
---|---|---|
enabled
|
boolean
|
Whether to use this repository for downloading this type of artifact.
Default value: |
updatePolicy
|
String
|
The frequency for downloading updates - can be "always", "daily" (default), "interval:XXX" (in minutes) or "never" (only if it doesn't exist locally). |
checksumPolicy
|
String
|
What to do when verification of an artifact checksum fails. Valid values are "fail" (default for Maven 4 and above), "warn" (default for Maven 2 and 3) or "ignore". |
snapshots
Download policy
Element | Type | Description |
---|---|---|
enabled
|
boolean
|
Whether to use this repository for downloading this type of artifact.
Default value: |
updatePolicy
|
String
|
The frequency for downloading updates - can be "always", "daily" (default), "interval:XXX" (in minutes) or "never" (only if it doesn't exist locally). |
checksumPolicy
|
String
|
What to do when verification of an artifact checksum fails. Valid values are "fail" (default for Maven 4 and above), "warn" (default for Maven 2 and 3) or "ignore". |
pluginRepository
Repository contains the information needed for establishing connections with remote repository
Element | Type | Description |
---|---|---|
releases
|
RepositoryPolicy
|
How to handle downloading of releases from this repository |
snapshots
|
RepositoryPolicy
|
How to handle downloading of snapshots from this repository |
name
|
String
|
Human readable name of the repository. |
url
|
String
|
The url of the repository. |
layout
|
String
|
The type of layout this repository uses for locating and storing artifacts - can be "legacy" or "default".
Default value: |
id
|
String
|
Item identifier.
Default value: |
profile
Modifications to the build process which is keyed on some sort of environmental parameter.
Element | Type | Description |
---|---|---|
activation
|
Activation
|
The conditional logic which will automatically trigger the inclusion of this profile. |
properties/key=value*
|
Properties
|
(Many) Extended configuration specific to this profile goes here. Contents take the form of
property.value
|
repositories/repository*
|
List<Repository>
|
(Many) The lists of the remote repositories. |
pluginRepositories/pluginRepository*
|
List<Repository>
|
(Many) The lists of the remote repositories for discovering plugins. |
id
|
String
|
Item identifier.
Default value: |
activation
The conditions within the build runtime environment which will trigger the automatic inclusion of the parent build profile.
Element | Type | Description |
---|---|---|
activeByDefault
|
boolean
|
Flag specifying whether this profile is active as a default.
Default value: |
jdk
|
String
|
Specifies that this profile will be activated when a matching JDK is detected. |
os
|
ActivationOS
|
Specifies that this profile will be activated when matching OS attributes are detected. |
property
|
ActivationProperty
|
Specifies that this profile will be activated when this property is specified. |
file
|
ActivationFile
|
Specifies that this profile will be activated based on existence of a file. |
packaging
|
String
|
Specifies that this profile will be activated based on the project's packaging. |
os
This is an activator which will detect an operating system's attributes in order to activate its profile.
Element | Type | Description |
---|---|---|
name
|
String
|
The name of the OS to be used to activate a profile. |
family
|
String
|
The general family of the OS to be used to activate a profile (e.g. 'windows') |
arch
|
String
|
The architecture of the OS to be used to activate a profile. |
version
|
String
|
The version of the OS to be used to activate a profile. |
property
This is the property specification used to activate a profile. If the value field is empty, then the existence of the named property will activate the profile, otherwise it does a case-sensitive match against the property value as well.
Element | Type | Description |
---|---|---|
name
|
String
|
The name of the property to be used to activate a profile. |
value
|
String
|
The value of the property to be used to activate a profile. |
file
This is the file specification used to activate a profile. The missing value will be the location of a file that needs to exist, and if it doesn't the profile must run. On the other hand exists will test for the existence of the file and if it is there will run the profile.
Element | Type | Description |
---|---|---|
missing
|
String
|
The name of the file that should be missing to activate a profile. Please note, that missing and exists fields cannot be used together. Only one of them should be used at any one time. |
exists
|
String
|
The name of the file that should exist to activate a profile. Please note, that missing and exists fields cannot be used together. Only one of them should be used at any one time. |