Archiva Documentation

Reply-To: dev@archiva.apache.org Delivered-To: mailing list commits@archiva.apache.org Received: (qmail 75909 invoked by uid 99); 5 Sep 2013 04:31:25 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Sep 2013 04:31:25 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 05 Sep 2013 04:31:15 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 44A3A2388CCE; Thu, 5 Sep 2013 04:29:20 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1520206 [48/48] - in /archiva/site-content/docs/2.0.0-SNAPSHOT: ./ adminguide/ adminguide/webservices/ css/ customising/ images/ images/logos/ images/profiles/ images/tour/ img/ js/ rest-docs-archiva-rest-api/ rest-docs-archiva-rest-api/cs... Date: Thu, 05 Sep 2013 04:29:02 -0000 To: commits@archiva.apache.org From: olamy@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20130905042920.44A3A2388CCE@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/rss.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/rss.html?rev=1520206&view=auto ============================================================================== --- archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/rss.html (added) +++ archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/rss.html Thu Sep 5 04:28:53 2013 @@ -0,0 +1,378 @@ + + + + + + + + + + + Archiva Documentation - RSS Feeds + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + +

Introduction
+ + + + Quick Start +
+ + + + Feature Tour +
+ + + + Release Notes +
+ + + + Downloads +
Users Guide
+ + + + Browsing +
+ + + + Searching +
+ + + + Deleting an Artifact +
+ + + + Using as a repository +
+ + + + Deploying to repository +
+ + + + Configuring Virtual Repositories +
+ + Rss Feeds in Archiva +
Administrators Guide
+ + + + Installing Archiva +
+ + + + Databases +
+ + + + Repositories Content Storage +
+ + + + Security +
+ + + + Archiva Configuration +
+ + + + REST Apis +
+ + + + Configuration Files +
+ + + + System Status +
+ + + + Log Files +
+ + + + Reports +
Customising Archiva
+ + + + Writing a Consumer Plugin +
More Information
+ + + + Archiva Wiki +
ASF
+ + + + How Apache Works +
+ + + + Foundation +
+ + + + Sponsoring Apache +
+ + + + Thanks +
Project Documentation
+ + + + Project Information +

+ + + + + +

+ +

+ + + +

+ + Follow archiva + + +

+ +

+ + +

+ +

RSS Feeds

There are two types of rss feeds in Archiva: new artifacts in repo feed and new versions of artifact feed.

New Artifacts In Repository

For versions 1.1 and 1.1.1, the default url for this feed is http://[hostname]:[port]/archiva/rss/rss_feeds?repoId=[repositoryId]. But since version 1.1.2, this has been changed to http://[hostname]:[port]/archiva/feeds/[repositoryId]

There are two ways to subscribe to this feed:

1. By copying the default url specified above and adding this to your feed reader. Just make sure to replace the hostname, port and repositoryId. The repositoryId is the id of the Archiva repo which you want to monitor.

2. Via the feed icon in the Repositories page. Right click on the feed icon of the repository configuration and copy the link. Then add this link to your feed reader.

New Versions of an Artifact

The default url for this feed for versions 1.1 and 1.1.1 is http://[hostname]:[port]/archiva/rss/rss_feeds?groupId=[groupId]&artifactId=[artifactId] but was changed to http://[hostname]:[port]/archiva/feeds/[groupId]/[artifactId] since version 1.1.2 for consistency purposes.

You could subscribe to the feed the same way as specified in the New Artifacts In Repository section except that in #1, you need to specify the groupId and artifactId instead of the repositoryId. And in #2, you need to go to the Browse section. The rss feed icon is located in the artifactId level.

Authentication

The authentication method used for the rss feeds is Http Basic Authentication. If your reader supports this, you would be prompted for a username and password when you subscribe to the feed. Supply your Archiva account credentials for this. Take note that only users with an Observer role for the specific repository would be able to subscribe to this feed.

If the 'guest' account is enabled for the repository, you would no longer be asked for the username and password when you subscribe to the feed.

+ +

+ + + + \ No newline at end of file Added: archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/searching.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/searching.html?rev=1520206&view=auto ============================================================================== --- archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/searching.html (added) +++ archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/searching.html Thu Sep 5 04:28:53 2013 @@ -0,0 +1,407 @@ + + + + + + + + + + + Archiva Documentation - Searching + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + +

Introduction
+ + + + Quick Start +
+ + + + Feature Tour +
+ + + + Release Notes +
+ + + + Downloads +
Users Guide
+ + + + Browsing +
+ + Searching +
+ + + + Deleting an Artifact +
+ + + + Using as a repository +
+ + + + Deploying to repository +
+ + + + Configuring Virtual Repositories +
+ + + + Rss Feeds in Archiva +
Administrators Guide
+ + + + Installing Archiva +
+ + + + Databases +
+ + + + Repositories Content Storage +
+ + + + Security +
+ + + + Archiva Configuration +
+ + + + REST Apis +
+ + + + Configuration Files +
+ + + + System Status +
+ + + + Log Files +
+ + + + Reports +
Customising Archiva
+ + + + Writing a Consumer Plugin +
More Information
+ + + + Archiva Wiki +
ASF
+ + + + How Apache Works +
+ + + + Foundation +
+ + + + Sponsoring Apache +
+ + + + Thanks +
Project Documentation
+ + + + Project Information +

+ + + + + +

+ +

+ + + +

+ + Follow archiva + + +

+ +

+ + +

+ +

Searching

The Search functionality of Archiva allows a user to search for specific artifact references in the repository.

Indexing

Before artifacts can be searched in Archiva, they need to be indexed first. Aritfacts are indexed during these instances:

when a repository is scanned
when an artifact is deployed or uploaded in the repository
when an artifact is proxied or downloaded from a remote repository
when remote index is available and downloaded

During repository scanning, the index-content consumer (see Consumers) creates an indexing task and queues it in an indexing task queue. This indexing task is in turn executed by a task executor and that's where the actual indexing happens. A similar indexing task is also created and queued as artifacts are deployed in the Archiva repository or proxied from a remote repository. The reason behind this is to avoid multiple or simultaneous update of the index (a repository scan might be executing while artifacts are being deployed in the repository). Note: This behavior applies for versions starting 1.2.1.

What Can Be Searched?

The repository files that are indexed during repository scan can be configured in the Repository Scanning page, in the Repository Scanning - File Types section (indexable-content). By default, the indexable-content file types are:

**/*.txt
+**/*.TXT
+**/*.block
+**/*.config
+**/*.pom
+**/*.xml
+**/*.xsd
+**/*.dtd
+**/*.tld

Quick Search

The contents of all the files in the repository that matches the above configuration will be indexed during repository scan. So when you type a word in the search box, Archiva will search the index for that query string and return all the search hits in the form of a paginated list of artifacts. For example you typed in 'ant', the search result would contain the list of artifacts that use or reference 'ant'.

For query strings containing whitespaces, Archiva searches for the query string including the whitespaces. So if you typed in 'commons logging', the search result would contain the list of artifacts that reference 'commons logging' which is still separated by whitespace. In this case, 'commons-logging' (hyphen separated) is not included in the search results.

Archiva can also search the index for java classes, packages, and methods and return a list of artifacts containing the query string. In the previous versions, we need to append the keyword 'bytecode:' before the query string in the search box (like 'bytecode:myMethod'). But since version 1.2, we no longer need to type the keyword. Just type the java class or package name in the search box.. and voila!

You can use various criterias to search artifacts:

Simple Query string

Advanced Paramters

OSGI Parameters

Search results

You can apply various filters on the search results.

Below is a sample screenshot of the search results:

When the user clicks a specific artifact in the search results list, Archiva will direct the user in the Artifact Info page (the same page from the Repository Browse). Otherwise if it is not a pom file (ex. metadata.xml), the file will appear as a file to be downloaded from the browser.

Security

The Search functionality respects the repository permissions. If the user is not logged in to Archiva and does a search, only those repositories with guest permissions will be searched for the query string. And if the user is logged in to Archiva and does a search, only those repositories in which that user has permission to access will be searched for the query string.

+ +

+ + + + \ No newline at end of file Added: archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/using-repository.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/using-repository.html?rev=1520206&view=auto ============================================================================== --- archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/using-repository.html (added) +++ archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/using-repository.html Thu Sep 5 04:28:53 2013 @@ -0,0 +1,456 @@ + + + + + + + + + Archiva Documentation - Using as a Repository + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + +

Introduction
+ + + + Quick Start +
+ + + + Feature Tour +
+ + + + Release Notes +
+ + + + Downloads +
Users Guide
+ + + + Browsing +
+ + + + Searching +
+ + + + Deleting an Artifact +
+ + Using as a repository +
+ + + + Deploying to repository +
+ + + + Configuring Virtual Repositories +
+ + + + Rss Feeds in Archiva +
Administrators Guide
+ + + + Installing Archiva +
+ + + + Databases +
+ + + + Repositories Content Storage +
+ + + + Security +
+ + + + Archiva Configuration +
+ + + + REST Apis +
+ + + + Configuration Files +
+ + + + System Status +
+ + + + Log Files +
+ + + + Reports +
Customising Archiva
+ + + + Writing a Consumer Plugin +
More Information
+ + + + Archiva Wiki +
ASF
+ + + + How Apache Works +
+ + + + Foundation +
+ + + + Sponsoring Apache +
+ + + + Thanks +
Project Documentation
+ + + + Project Information +

+ + + + + +

+ +

+ + + +

+ + Follow archiva + + +

+ +

+ + +

+ +

Configuring Maven 2 to use an Archiva repository

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 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>
+  <!-- omitted xml -->
+  <mirrors>
+    <mirror>
+      <id>archiva.default</id>
+      <url>http://repo.mycompany.com:8080/archiva/repository/internal/</url>
+      <mirrorOf>external:*</mirrorOf>
+    </mirror>
+  </mirrors>
+  <!-- omitted xml -->
+</settings>

Note: There are other controls you can use on what is mirrored. See Maven's Guide to Mirror Settings for more information.

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:

    <!-- omitted xml -->
+    <mirror>
+      <id>archiva.apache.snapshots</id>
+      <url>http://repo.mycompany.com:8080/archiva/repository/snapshots/</url>
+      <mirrorOf>apache.snapshots</mirrorOf>
+    </mirror>
+    <!-- omitted xml -->

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.

Create a new profile to setup your repositories +

<settings>
+  <!-- omitted xml -->
+  <profiles>
+    <profile>
+      <id>Repository Proxy</id>
+      <activation>
+        <activeByDefault>true</activeByDefault>
+      </activation>
+      <!-- ******************************************************* -->
+      <!-- repositories for jar artifacts -->
+      <!-- ******************************************************* -->
+      <repositories>
+        <repository>
+          <!-- omitted xml -->
+        </repository>
+        <!-- omitted xml -->   
+      </repositories>
+      <!-- ******************************************************* -->
+      <!-- repositories for maven plugins -->
+      <!-- ******************************************************* -->
+      <pluginRepositories>
+        <pluginRepository>
+          <!-- omitted xml -->
+        </pluginRepository>
+        <!-- omitted xml -->   
+      </pluginRepositories>
+    </profile>
+    <!-- omitted xml -->
+  </profiles>
+  <!-- omitted xml -->
+</settings>

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>

Add the necessary security configuration +

This is only necessary if the guest account does not have read access to the given repository.

<settings>
+  <!-- omitted xml -->
+  <servers>
+    <server>
+      <id>repository-1</id>
+      <username>{archiva-user}</username>
+      <password>{archiva-pwd}</password>
+    </server>
+    <!-- omitted xml -->
+  </servers>
+  <!-- omitted xml -->
+</settings>

+ +

+ + + + \ No newline at end of file Added: archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/virtual-repositories.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/virtual-repositories.html?rev=1520206&view=auto ============================================================================== --- archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/virtual-repositories.html (added) +++ archiva/site-content/docs/2.0.0-SNAPSHOT/userguide/virtual-repositories.html Thu Sep 5 04:28:53 2013 @@ -0,0 +1,450 @@ + + + + + + + + + Archiva Documentation - Virtual Repositories + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + +

+ + + + + +

+ +

+ + + +

+ + Follow archiva + + +

+ +

+ + +

+ +

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>
+  <!-- omitted xml -->
+  <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>
+    <!-- omitted xml -->
+  </profiles>
+  <!-- omitted xml -->
+</settings>

If you have a virtual repository configured in Archiva, you only need to configure this in your settings.xml:

<settings>
+  <!-- omitted xml -->
+  <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>
+    <!-- omitted xml -->
+  </profiles>
+  <!-- omitted xml -->
+</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.

Prior to version 1.4-M2, Virtual repositories can return a Maven index in the path /.indexer path

Configuring Virtual Repositories

Below are the steps for setting up the virtual repositories:

In the webapp, go to the Repository Groups page. To create a virtual repository or repository group, go to add tab
To add a repository drag and drop available repositories.
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.
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.

Merged index

With version 1.4-M2, you can download a merged index for a virtual repository. This merged index is generated "on the fly" with merging repositories index for which the current user has karma. This merged index is available in the path .indexer .

To not generate this merged index on each request, there is a ttl (time to live) value for build merged index. It can be configured in the repository group configuration. This ttl has a default value of 30 minutes.

+ +

+ + + + \ No newline at end of file