[MRM-288] line up configuration so that it always works, regardless of the existence of files. Add tests, and document the behaviour.

git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@515991 13f79535-47bb-0310-9956-ffa450edef68

3 files changed, 64 insertions, 2 deletions

diff --git a/archiva-site/src/site/apt/guides/configuration.apt b/archiva-site/src/site/apt/guides/configuration.apt
new file mode 100644
index 000000000..c307dff93
--- /dev/null
+++ b/archiva-site/src/site/apt/guides/configuration.apt
@@ -0,0 +1,63 @@
+ ------
+ Archiva Configuration
+ ------
+ The Maven Team
+ ------
+ 8 March 2007
+ ------
+
+~~ 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.
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Archiva Configuration
+
+* Web Configuration
+
+  Archiva can be fully configured from the web interface (with the exception of the {{{security-configuration.html} security properties, presently}}).
+
+  ...
+
+~~TODO: more details needed, but I wanted to get this started
+
+* File system configuration
+
+  While Archiva can be fully configred by the web interface, the configuration will be saved to the file system and can be edited from there if needed.
+
+  Archiva's configuration is loaded from the following files, in order of most precedent:
+
+    * <<<~/.m2/archiva.xml>>>
+
+    * <<<$ARCHIVA_BASE/conf/archiva.xml>>>
+
+    * <<<$ARCHIVA_HOME/conf/archiva.xml>>>
+
+  When Archiva saves it's configuration, all configuration is stored to a single file. The file chosen is by the following rules:
+
+    * If <<<~/.m2/archiva.xml>>> exists, it is saved there
+
+    * Otherwise, it is saved to <<<$ARCHIVA_BASE/conf/archiva.xml>>>, regardless of whether it previously existed.
+
+  The configuration will never be saved in <<<$ARCHIVA_HOME>>>.
+
+  Note that the configuration can be edited, but only when Archiva is not running as it will not reload a changed configuration file, and will save over it
+  if something is changed in the web interface.
+
+~~TODO: format?
+
diff --git a/archiva-site/src/site/apt/guides/security-configuration.apt b/archiva-site/src/site/apt/guides/security-configuration.apt
index 8c5876103..6c94918b6 100644
--- a/archiva-site/src/site/apt/guides/security-configuration.apt
+++ b/archiva-site/src/site/apt/guides/security-configuration.apt
@@ -39,8 +39,6 @@ Archiva Security Configuration
  
  * <<<$ARCHIVA_HOME/conf/security.properties>>>
  
- * <<<$ARCHIVA_HOME/apps/archiva/conf/security.properties>>>
- 
  []
  
  (In the above list, <<<~>>> is the home directory of the user who is running
diff --git a/archiva-site/src/site/site.xml b/archiva-site/src/site/site.xml
index b2d1b5567..9c71480ce 100644
--- a/archiva-site/src/site/site.xml
+++ b/archiva-site/src/site/site.xml
@@ -30,6 +30,7 @@
       <item name="FAQ" href="http://docs.codehaus.org/display/MAVENUSER/Archiva+FAQ"/>
       <item name="Maven Configuration" href="/guides/getting-started/maven-configuration.html"/>
       <item name="Security Configuration" href="/guides/security-configuration.html"/>
+      <item name="Other Configuration" href="/guides/configuration.html"/>
       <item name="Developing" href="/guides/developing/index.html"/>
     </menu>