------
 Configuration Files of Apache Archiva
 ------
 ------
 2012-11-24
 ------

~~ Licensed to the Apache Software Foundation (ASF) under one                      
~~ or more contributor license agreements.  See the NOTICE file                    
~~ distributed with this work for additional information                           
~~ regarding copyright ownership.  The ASF licenses this file                      
~~ to you under the Apache License, Version 2.0 (the                               
~~ "License"); you may not use this file except in compliance                      
~~ with the License.  You may obtain a copy of the License at                      
~~                                                                                 
~~   http://www.apache.org/licenses/LICENSE-2.0                                    
~~                                                                                 
~~ Unless required by applicable law or agreed to in writing,                      
~~ software distributed under the License is distributed on an                     
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY                          
~~ KIND, either express or implied.  See the License for the                       
~~ specific language governing permissions and limitations                         
~~ under the License.                                                              

Configuration Files of Apache Archiva

  While Archiva is primarily configured via the graphical administration interface, it stores all configuration in XML configuration
  files that can be hand edited and used for backup and migration.

  The following files compose the configuration for Archiva:

    * <<<archiva.xml>>> - this is the primary Archiva configuration file

    * <<<security.properties>>> - This file, if it exists, is only read once to populate the
         Redback Runtime Configuration properties (see {{{./redback-runtime-configuration.html#Runtime_Properties}Redback Runtime Configuration}},
         stored in <<<archiva.xml>>>. The file will be ignored after this.

  This section will focus on the <<<archiva.xml>>> file.

* The Archiva configuration file

  The Archiva configuration file is stored in one of two locations:

    * The application server configuration directory (see {{{./standalone.html} installing Archiva standalone}} for more information)

    * The user home directory (<<<~/.m2/archiva.xml>>>). 

    []

  When modified in the GUI, the file is written back to the location it was initially read from, with the home directory taking priority if both exist. When using a
  standalone installation, it is highly recommended that a configuration file is only maintained in one of the locations.

  For a complete reference of the configuration file see: {{{http://archiva.apache.org/ref/${project.version}/archiva-base/archiva-configuration/configuration.html}Reference}}

  The following shows a basic configuration file:

+----+
<configuration>
  <version>2</version>
  <managedRepositories>
    <managedRepository>
      <location>${appserver.base}/repositories/internal</location>
      <retentionPeriod>30</retentionPeriod>
      <id>internal</id>
      <name>Archiva Managed Internal Repository</name>
    </managedRepository>
  </managedRepositories>
  <remoteRepositories>
    <remoteRepository>
      <url>http://repo1.maven.org/maven2</url>
      <id>central</id>
      <name>Central Repository</name>
    </remoteRepository>
  </remoteRepositories>
  <proxyConnectors>
    <proxyConnector>
      <sourceRepoId>internal</sourceRepoId>
      <targetRepoId>central</targetRepoId>
      <policies>
        <releases>always</releases>
        <checksum>fix</checksum>
        <snapshots>never</snapshots>
        <cache-failures>no</cache-failures>
      </policies>
    </proxyConnector>
  </proxyConnectors>
</configuration>
+----+

  ~~TODO: need a full reference