[MRM-801]

-added documentation for virtual repos

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

diff --git a/archiva-docs/src/site/apt/release-notes.apt b/archiva-docs/src/site/apt/release-notes.apt
index 551366f9073526ba77c9f33644bab89bdd9bc013..28f8a810bf9616d4a600318b19a7cc3a5c56eb5e 100644 (file)
--- a/archiva-docs/src/site/apt/release-notes.apt
+++ b/archiva-docs/src/site/apt/release-notes.apt
@@ -28,7 +28,7 @@ Release Notes for Archiva 1.1 (DRAFT)
 ** 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
 

diff --git a/archiva-docs/src/site/apt/userguide/index.apt b/archiva-docs/src/site/apt/userguide/index.apt
index a41234d72f3fb5dae473085602902fd197c5d49f..d79e6eb3d665410168e84a4eae1315134dcbae11 100644 (file)
--- a/archiva-docs/src/site/apt/userguide/index.apt
+++ b/archiva-docs/src/site/apt/userguide/index.apt
@@ -17,6 +17,10 @@ Users Guide
 
     * {{{deploy.html} Deploying artifacts to the repository}}
 
+    * {{{virtual-repositories.html} Configuring Virtual Repositories}}
+
+    * {{{rss.html}RSS Feeds in Archiva}}
+
     []
 
 

diff --git a/archiva-docs/src/site/apt/userguide/virtual-repositories.apt b/archiva-docs/src/site/apt/userguide/virtual-repositories.apt
new file mode 100644 (file)
index 0000000..d465e9d
--- /dev/null
+++ b/archiva-docs/src/site/apt/userguide/virtual-repositories.apt
@@ -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.
+
+

diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml
index 3b78c62be502f3d2d9a10f01af4a647c69e4d0eb..eea7b8576d9b2a78b6c9b5a3cf8e68bdb234f202 100644 (file)
--- a/archiva-docs/src/site/site.xml
+++ b/archiva-docs/src/site/site.xml
@@ -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>