Author: brett
Date: Thu Nov 22 20:44:41 2007
New Revision: 597542
URL: http://svn.apache.org/viewvc?rev=597542&view=rev
Log:
move the rest of the maven configuration docs
Removed:
maven/archiva/trunk/archiva-docs/src/site/apt/guides/
Modified:
maven/archiva/trunk/archiva-docs/src/site/apt/userguide/using-repository.apt
Modified:
maven/archiva/trunk/archiva-docs/src/site/apt/userguide/using-repository.apt
URL:
http://svn.apache.org/viewvc/maven/archiva/trunk/archiva-docs/src/site/apt/userguide/using-repository.apt?rev=597542&r1=597541&r2=597542&view=diff
==============================================================================
---
maven/archiva/trunk/archiva-docs/src/site/apt/userguide/using-repository.apt
(original)
+++
maven/archiva/trunk/archiva-docs/src/site/apt/userguide/using-repository.apt
Thu Nov 22 20:44:41 2007
@@ -2,7 +2,123 @@
Using as a Repository
------
-Using as a Repository
+Configuring Maven 2 to use an Archiva repository
- :STUB: This is a documentation stub.
+ To get your local Maven 2 installation to use an Archiva proxy you need to
add the repositories you require to your 'settings.xml'. This file is usually
found in ${user.dir}/.m2/settings.xml (see the
{{{http://maven.apache.org/settings.html}Settings Reference}}).
+
+ How you configure the settings depends on how you would like to utilise the
repository. You can add the Archiva repository as an additional repository to
others already declared by the project, or lock down the
+ environment to only use the Archiva repositories (possibly proxying content
from a remote repository).
+
+* Locking down to only use Archiva
+
+ If you would like Archiva to serve as the only repository used by your Maven
installation, you can use the Maven mirror settings to force this behaviour.
+
+ First, you need to select the default repository to use when none is
configured by adding the following to the <<<settings.xml>>> file:
+
++-------------------------------------------------------------------------+
+<settings>
+ ...
+ <mirrors>
+ <mirror>
+ <id>archiva.default</id>
+ <url>http://repo.mycompany.com:8080/archiva/repository/internal/</url>
+ <mirrorOf>*</mirrorOf>
+ </mirror>
+ </mirrors>
+ ...
+</settings>
++-------------------------------------------------------------------------+
+
+ With this in place, all repository requests will be sent to the internal
repository (which by default is configured to proxy the central repository).
+
+ If you have separate Archiva repositories that you wish to use, you can add
an extra mirror declaration as needed:
+
++-------------------------------------------------------------------------+
+ ...
+ <mirror>
+ <id>archiva.apache.snapshots</id>
+ <url>http://repo.mycompany.com:8080/archiva/repository/snapshots/</url>
+ <mirrorOf>apache.snapshots</mirrorOf>
+ </mirror>
+ ...
++-------------------------------------------------------------------------+
+
+ <<WARNING:>> Maven, as of version 2.0.8, does not properly report the
correct URL in errors when a mirror is used - so although the Archiva instance
is being consulted any error messages will still reflect
+ the original URL described in the POM.
+
+* Using Archiva as an additional repository
+
+ You will need to add one entry for each repository that is setup in Archiva.
If your repository contains plugins; remember to also include a
\<pluginRepository\> setting.
+
+ [[1]] create a new profile to setup your repositories
+
++-------------------------------------------------------------------------+
+<settings>
+ ...
+ <profiles>
+ <profile>
+ <id>Repository Proxy</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <!-- ******************************************************* -->
+ <!-- repositories for jar artifacts -->
+ <!-- ******************************************************* -->
+ <repositories>
+ <repository>
+ ...
+ </repository>
+ ...
+ </repositories>
+ <!-- ******************************************************* -->
+ <!-- repositories for maven plugins -->
+ <!-- ******************************************************* -->
+ <pluginRepositories>
+ <pluginRepository>
+ ...
+ </pluginRepository>
+ ...
+ </pluginRepositories>
+ </profile>
+ ...
+ </profiles>
+ ...
+</settings>
++-------------------------------------------------------------------------+
+
+ [[2]] add your repository configuration to the profile
+
+ You can copy the repository configuration from the POM Snippet on the
Archiva Administration Page for a normal repository. It should look much like:
+
++-------------------------------------------------------------------------+
+<repository>
+ <id>repository-1</id>
+ <url>http://repo.mycompany.com:8080/archiva/repository/internal/</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>false</enabled>
+ </snapshots>
+</repository>
++-------------------------------------------------------------------------+
+
+ [[3]] Add the necessary security configuration
+
+ This is only necessary if the guest account does not have read access to the
given repository.
+
++-------------------------------------------------------------------------+
+<settings>
+ ...
+ <servers>
+ <server>
+ <id>repository-1</id>
+ <username>{archiva-user}</username>
+ <password>{archiva-pwd}</password>
+ </server>
+ ...
+ </servers>
+ ...
+</settings>
++-------------------------------------------------------------------------+
