Author: oching
Date: Tue May 20 20:44:05 2008
New Revision: 658548
URL: http://svn.apache.org/viewvc?rev=658548&view=rev
Log:
[MRM-801]
-added documentation for virtual repos
Added:
archiva/trunk/archiva-docs/src/site/apt/userguide/virtual-repositories.apt
Modified:
archiva/trunk/archiva-docs/src/site/apt/release-notes.apt
archiva/trunk/archiva-docs/src/site/apt/userguide/index.apt
archiva/trunk/archiva-docs/src/site/site.xml
Modified: archiva/trunk/archiva-docs/src/site/apt/release-notes.apt
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/apt/release-notes.apt?rev=658548&r1=658547&r2=658548&view=diff
==============================================================================
--- archiva/trunk/archiva-docs/src/site/apt/release-notes.apt (original)
+++ archiva/trunk/archiva-docs/src/site/apt/release-notes.apt Tue May 20
20:44:05 2008
@@ -28,7 +28,7 @@
** RSS
RSS is now available for getting a feed of new artifacts being added to a
given repository. Two types of feeds are generated by Archiva:
- new artifacts in a repository and new versions of a specific artifact.
Details are available in {{{userguide/rss.html>}}Rss Feeds}.
+ new artifacts in a repository and new versions of a specific artifact.
Details are available in {{{userguide/rss.html>}Rss Feeds}}.
~~TODO: screenshot, more detail
Modified: archiva/trunk/archiva-docs/src/site/apt/userguide/index.apt
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/apt/userguide/index.apt?rev=658548&r1=658547&r2=658548&view=diff
==============================================================================
--- archiva/trunk/archiva-docs/src/site/apt/userguide/index.apt (original)
+++ archiva/trunk/archiva-docs/src/site/apt/userguide/index.apt Tue May 20
20:44:05 2008
@@ -17,6 +17,10 @@
* {{{deploy.html} Deploying artifacts to the repository}}
+ * {{{virtual-repositories.html} Configuring Virtual Repositories}}
+
+ * {{{rss.html}RSS Feeds in Archiva}}
+
[]
Added:
archiva/trunk/archiva-docs/src/site/apt/userguide/virtual-repositories.apt
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/apt/userguide/virtual-repositories.apt?rev=658548&view=auto
==============================================================================
--- archiva/trunk/archiva-docs/src/site/apt/userguide/virtual-repositories.apt
(added)
+++ archiva/trunk/archiva-docs/src/site/apt/userguide/virtual-repositories.apt
Tue May 20 20:44:05 2008
@@ -0,0 +1,117 @@
+ ------
+ Virtual Repositories
+ ------
+
+Virtual Repositories
+
+ This is a new feature for Archiva 1.1. The main advantage of virtual
repositories (or repository groups) is that you
+ only need to specify one URL instead of multiple repository URLs if you are
using more than 1 proxy repository.
+
+ For example, you have the following configuration in your <<<settings.xml>>>:
+
++-------------------------------------------------------------------------+
+<settings>
+ ...
+ <profiles>
+ <profile>
+ <id>Repository Proxy</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <repositories>
+ <repository>
+ <id>internal.releases</id>
+
<url>http://localhost:8080/archiva/repository/internal.releases/</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>false</enabled>
+ </snapshots>
+ </repository>
+ <repository>
+ <id>third.party.repo</id>
+ <url>http://localhost:8080/archiva/repository/third.party.repo/</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>false</enabled>
+ </snapshots>
+ </repository>
+ <repository>
+ <id>snapshots</id>
+ <url>http://localhost:8080/archiva/repository/snapshots/</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ </profile>
+ ...
+ </profiles>
+ ...
+</settings>
++-------------------------------------------------------------------------+
+
+ If you have a virtual repository configured in Archiva, you only need to
configure this in your <<<settings.xml>>>:
+
++-------------------------------------------------------------------------+
+<settings>
+ ...
+ <profiles>
+ <profile>
+ <id>Repository Proxy</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <repositories>
+ <repository>
+ <id>internal.releases</id>
+
<url>http://localhost:8080/archiva/repository/[repository_group_id]/</url>
+ </repository>
+ </repositories>
+ </profile>
+ ...
+ </profiles>
+ ...
+</settings>
++-------------------------------------------------------------------------+
+
+ And you'll still be able to get all the artifacts that you need. See
Configuring Virtual Repositories section for the
+ steps on how to setup a virtual repo in Archiva.
+
+* How It Works
+
+ When Archiva receives a request with a virtual repo (or repo group) URL,
Archiva would look for the requested artifact
+ from the repositories under that group. It would only check the repositories
the user has permission to access (meaning
+ only those repositories which the user has an Obeserver role for). The first
resource found for the requested artifact
+ would be returned.
+
+* Configuring Virtual Repositories
+
+ Below are the steps for setting up the virtual repositories:
+
+ [[1]] In the webapp, go to the <<<Repository Groups>>> page. To create a
virtual repository or repository group,
+ fill in the <<<Identifier>>> field and click Add Group.
+
+ [[2]] To add a repository under this group, choose from the drop-down menu
on the lower right hand side of the
+ repository group box and click Add Repository.
+
+ [[3]] Now add the virtual repository URL
<<<http://[host]:[port]/archiva/repository/[repository_group_id]/>>>
+ into your settings.xml the same way you configure regular repositories -- as
a <mirror> or as an additional <repository>.
+
+ [[4]] If the repositories under the group are secured, you must set your
Archiva login credentials in your settings.xml as
+ well. Please take note that the <server> id should match the repository
group identifier.
+
+* Webdav Browse
+
+ Webdav Browse for a virtual repository is a read-only view. It displays the
merged contents of all the repositories
+ under that repository group. Just type the url of the virtual repository in
your browser in order to view its contents.
+ User will be asked to authenticate if the 'guest' account is not enabled for
the repositories. Only those repositories
+ which the user has permission to access will be shown.
+
+
Modified: archiva/trunk/archiva-docs/src/site/site.xml
URL:
http://svn.apache.org/viewvc/archiva/trunk/archiva-docs/src/site/site.xml?rev=658548&r1=658547&r2=658548&view=diff
==============================================================================
--- archiva/trunk/archiva-docs/src/site/site.xml (original)
+++ archiva/trunk/archiva-docs/src/site/site.xml Tue May 20 20:44:05 2008
@@ -39,6 +39,7 @@
<item name="Identifying an Artifact"
href="/userguide/find-artifact.html" />
<item name="Using as a repository"
href="/userguide/using-repository.html" />
<item name="Deploying to repository" href="/userguide/deploy.html" />
+ <item name="Configuring Virtual Repositories"
href="/userguide/virtual-repositories.html" />
<item name="Rss Feeds in Archiva" href="/userguide/rss.html"/>
</menu>
