From: Brett Porter Date: Fri, 23 Nov 2007 08:40:15 +0000 (+0000) Subject: instructions for standalone installation X-Git-Tag: archiva-1.0~8 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=561d4d22f406bf2f5f7135a33d0cecdbe17362d0;p=archiva.git instructions for standalone installation git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@597594 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 7160a95c1..18868fb17 100644 --- a/archiva-docs/src/site/apt/adminguide/standalone.apt +++ b/archiva-docs/src/site/apt/adminguide/standalone.apt @@ -4,11 +4,39 @@ Installing Standalone Distribution of Apache Archiva - :STUB: This is a documentation stub. + Installing the standalone distribution of Archiva is quite simple - for an example, see the {{{quick-start.html} Quick Start}} guide. -~~TODO: link to quick start as it covers the most basic scenario -~~TODO: ensure to refer to advanced configuration options, such as PLEXUS_BASE -~~TODO: upgrading + However, the best way to use this installation technique is to separate the configuration from the installation to make it easy to + upgrade to newer versions in the future. + +* Running Archiva + + Archiva can be run using one of two techniques: + + * Using the OS specific scripts in <<>> (select the one for your environment). The argument can be <<>> to run interactively, or <<>> to run in the background + (in this case, run the script with <<>> to later stop the server). + + * Using the generic <<>> script which will run Archiva interactively + + [] + +* Separating the base from the installation + + The standalone instance of Archiva uses the Plexus application server, which is capable of separating it's configuration from installation, + in much the same way Tomcat does, for example, with it's <<>> and <<>> environment variables. + + This is achieved by the following steps: + + [[1]] Creating the base location. For example, you might install Archiva in <<>> and the data in <<>> + + [[2]] Move the <<>> and <<>> directories from the Archiva installation to the new location. If you've previously run Archiva, you may need to edit + <<>> to change the location of the repositories + + [[3]] Set the environment variable <<>> to the data location (in bash, be sure to export the variable). + + [[4]] Start Archiva standalone as described above from the installation location + +* Configuring Archiva Archiva's configuration is loaded from the following files, in order of most precedent: @@ -80,5 +108,14 @@ Installing Standalone Distribution of Apache Archiva {Upgrading Archiva} - ... + Upgrading Archiva is straightforward if the directions for separating the base from the installation above are followed. Simply retain the data directories (the repositories and database), + and the configuration files (in the conf directory, or the other locations specified above) and use a new extracted installation of Archiva. + + Note that the <<>> database must always be retained as it contains the permissions and user information across versions. However, should it be necessary, the <<>> database can + be removed at any time and re-created by scanning the repositories again. + + The repository data is portable across versions, and multiple versions can be configured to look at the same repositories (though not run simultaneously). When scanned, an index is also created + in the root directory - while this shold remain portable across versions, it can also be removed and regenerated by scanning the given repository again from the web interface. + +