From: Brett Porter Date: Fri, 23 Nov 2007 03:49:56 +0000 (+0000) Subject: move the old configuration documentation X-Git-Tag: archiva-1.0~19 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=59f1163fbddee1440e6a85538c085eb122b24faa;p=archiva.git move the old configuration documentation git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@597534 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/archiva-docs/src/site/apt/adminguide/standalone.apt b/archiva-docs/src/site/apt/adminguide/standalone.apt index 84f47c30e..34226c781 100644 --- a/archiva-docs/src/site/apt/adminguide/standalone.apt +++ b/archiva-docs/src/site/apt/adminguide/standalone.apt @@ -10,6 +10,26 @@ Installing Standalone Distribution of Apache Archiva ~~TODO: ensure to refer to advanced configuration options, such as PLEXUS_BASE ~~TODO: upgrading + 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. + + {Upgrading Archiva} ... diff --git a/archiva-docs/src/site/apt/adminguide/webapp.apt b/archiva-docs/src/site/apt/adminguide/webapp.apt index 932388243..7b0bbf81d 100644 --- a/archiva-docs/src/site/apt/adminguide/webapp.apt +++ b/archiva-docs/src/site/apt/adminguide/webapp.apt @@ -77,5 +77,5 @@ Upgrading Archiva Configuring and Running Archiva - Once Archiva is running, it is configured in the same way as the standalone instance. See the {{{../quick-start.html#Configuring%20and%20Running%20Archiva} quick start}} guide for more information. + Once Archiva is running, it is configured in the same way as the standalone instance. See the {{{../quick-start.html#Setting%20up%20your%20Archiva%20instance} quick start}} guide for more information. diff --git a/archiva-docs/src/site/apt/guides/configuration.apt b/archiva-docs/src/site/apt/guides/configuration.apt deleted file mode 100644 index c307dff93..000000000 --- a/archiva-docs/src/site/apt/guides/configuration.apt +++ /dev/null @@ -1,63 +0,0 @@ - ------ - 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-docs/src/site/apt/quick-start.apt b/archiva-docs/src/site/apt/quick-start.apt index 37b37d5fa..5db05f1e2 100644 --- a/archiva-docs/src/site/apt/quick-start.apt +++ b/archiva-docs/src/site/apt/quick-start.apt @@ -44,15 +44,12 @@ Installing Archiva Archiva is now running on <<>> -Setting up your Archiva instance +{Setting up your Archiva instance} You can now browse the web administration of Archiva. There will be a few basic setup tasks to get started. - * On the first page - setup your administration user. The password requires a numerical character and must not be - longer than 8 chars. You'll then need to log in. User 'admin' as the username and the password you've entered. + The first step is to setup your administration user. The password requires a numerical character and must not be + longer than 8 chars. You'll then need to log in. User 'admin' as the username and the password you've entered. - * On the second page - setup your first repository. It can be both an m1 and an m2 repository. - - * On the third page - setup your indexing. Mostly this means choosing a directory to put the index in. It'll - re-index every hour. +~~TODO... diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml index 361a07d2c..95f56392f 100644 --- a/archiva-docs/src/site/site.xml +++ b/archiva-docs/src/site/site.xml @@ -75,7 +75,6 @@ -