From fd122e79e9ae4d62accd3e224d832c3848449042 Mon Sep 17 00:00:00 2001 From: "Maria Odea B. Ching" Date: Wed, 21 May 2008 03:44:05 +0000 Subject: [PATCH] [MRM-801] -added documentation for virtual repos git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@658548 13f79535-47bb-0310-9956-ffa450edef68 --- archiva-docs/src/site/apt/release-notes.apt | 2 +- archiva-docs/src/site/apt/userguide/index.apt | 4 + .../apt/userguide/virtual-repositories.apt | 117 ++++++++++++++++++ archiva-docs/src/site/site.xml | 1 + 4 files changed, 123 insertions(+), 1 deletion(-) create mode 100644 archiva-docs/src/site/apt/userguide/virtual-repositories.apt diff --git a/archiva-docs/src/site/apt/release-notes.apt b/archiva-docs/src/site/apt/release-notes.apt index 551366f90..28f8a810b 100644 --- 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 a41234d72..d79e6eb3d 100644 --- 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 index 000000000..d465e9d08 --- /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 <<>>: + ++-------------------------------------------------------------------------+ + + ... + + + Repository Proxy + + true + + + + internal.releases + http://localhost:8080/archiva/repository/internal.releases/ + + true + + + false + + + + third.party.repo + http://localhost:8080/archiva/repository/third.party.repo/ + + true + + + false + + + + snapshots + http://localhost:8080/archiva/repository/snapshots/ + + false + + + true + + + + + ... + + ... + ++-------------------------------------------------------------------------+ + + If you have a virtual repository configured in Archiva, you only need to configure this in your <<>>: + ++-------------------------------------------------------------------------+ + + ... + + + Repository Proxy + + true + + + + internal.releases + http://localhost:8080/archiva/repository/[repository_group_id]/ + + + + ... + + ... + ++-------------------------------------------------------------------------+ + + 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 <<>> page. To create a virtual repository or repository group, + fill in the <<>> 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 <<>> + into your settings.xml the same way you configure regular repositories -- as a or as an additional . + + [[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 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 3b78c62be..eea7b8576 100644 --- a/archiva-docs/src/site/site.xml +++ b/archiva-docs/src/site/site.xml @@ -39,6 +39,7 @@ + -- 2.39.5