Archiva Documentation - Deleting an Artifact

Reply-To: dev@archiva.apache.org Delivered-To: mailing list commits@archiva.apache.org Received: (qmail 33109 invoked by uid 99); 27 May 2013 10:41:48 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 27 May 2013 10:41:48 +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; Mon, 27 May 2013 10:41:37 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 977B42388C93; Mon, 27 May 2013 10:39:41 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1486565 [47/48] - in /archiva/site-content/docs/1.4-M4: ./ adminguide/ adminguide/webservices/ css/ customising/ images/ images/logos/ images/profiles/ images/tour/ img/ js/ rest-docs-archiva-rest-api/ rest-docs-archiva-rest-api/css/ rest-... Date: Mon, 27 May 2013 10:39:24 -0000 To: commits@archiva.apache.org From: olamy@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20130527103941.977B42388C93@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: archiva/site-content/docs/1.4-M4/userguide/delete-artifact.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M4/userguide/delete-artifact.html?rev=1486565&view=auto ============================================================================== --- archiva/site-content/docs/1.4-M4/userguide/delete-artifact.html (added) +++ archiva/site-content/docs/1.4-M4/userguide/delete-artifact.html Mon May 27 10:39:16 2013 @@ -0,0 +1,362 @@ + + + + + + + + + + + Archiva Documentation - Deleting an Artifact + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + +

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 + + +

+ +

+ + +

+ +

Deleting an Artifact

The Delete Artifact feature allows groupId or artifacts to be deleted from the managed repositories.

  User must have a Repository Manager role to a repository to be able to delete artifacts from it.

To delete artifacts, you must simply browse to what you want to delete

Delete groupId

Use trash icon near the groupId you want to delete

Delete artifact

Browse to detail view of artifact, go to Artifacts tab then delete the artifact with trash icon

+ +

+ + + + \ No newline at end of file Added: archiva/site-content/docs/1.4-M4/userguide/deploy.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M4/userguide/deploy.html?rev=1486565&view=auto ============================================================================== --- archiva/site-content/docs/1.4-M4/userguide/deploy.html (added) +++ archiva/site-content/docs/1.4-M4/userguide/deploy.html Mon May 27 10:39:16 2013 @@ -0,0 +1,438 @@ + + + + + + + + + + Archiva Documentation - Deploying to 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 + + +

+ +

+ + +

+ +

Deploying to Repository

There are different ways on how you can deploy artifacts in an Archiva repository.

Maven Configuring Maven to deploy to an Archiva repository
Web UI Deploying via the Web UI Form

Starting with Archiva 1.2.3, it is possible to block re-deployment of released artifacts to a specific repository. This can be configured through the repository configuration page by ticking the Block Re-deployment of Released Artifacts checkbox.

WARNING The deployed artifact may not appear immediately in the search results. The execution of the index-content repository consumer and other scanning consumers are queued for execution to prevent concurrent updates to the index.

Configuring Maven to deploy to an Archiva repository

Create a user in Archiva to use for deployment (or use guest if you wish to deploy without a username and password)
The deployment user needs the Role 'Repository Manager' for each repository that you want to deploy to

Define the server for deployment inside your 'settings.xml', use the newly created user for authentication

<settings>
+  <!-- omitted xml -->
+  <servers>
+    <server>
+      <id>archiva.internal</id>
+      <username>{archiva-deployment-user}</username>
+      <password>{archiva-deployment-pwd}</password>
+    </server>
+    <server>
+      <id>archiva.snapshots</id>
+      <username>{archiva-deployment-user}</username>
+      <password>{archiva-deployment-pwd}</password>
+    </server>
+    <!-- omitted xml -->
+  </servers>
+  <!-- omitted xml -->
+</settings>

Deploying to Archiva using HTTP

Configure the distributionManagement part of your pom.xml (customising the URLs as needed). The id of the repository in distributionManagement must match the id of the server element in settings.xml.

<project>
+  <!-- omitted xml -->
+  <distributionManagement>
+    <repository>
+      <id>archiva.internal</id>
+      <name>Internal Release Repository</name>
+      <url>http://reposerver.mycompany.com:8080/archiva/repository/internal/</url>
+    </repository>
+    <snapshotRepository>
+      <id>archiva.snapshots</id>
+      <name>Internal Snapshot Repository</name>
+      <url>http://reposerver.mycompany.com:8080/archiva/repository/snapshots/</url>
+    </snapshotRepository>
+  </distributionManagement>
+  <!-- omitted xml -->
+</project>

Deploying to Archiva using WebDAV

In some cases, you may want to use WebDAV to deploy instead of HTTP. If you find this is necessary, follow the same process as for HTTP, with these additional steps:

Add dav: to the front of the deployment URLs:

<project>
+  <!-- omitted xml -->
+  <distributionManagement>
+    <repository>
+      <id>archiva.internal</id>
+      <name>Internal Release Repository</name>
+      <url>dav:http://reposerver.mycompany.com:8080/archiva/repository/internal/</url>
+    </repository>
+    <snapshotRepository>
+      <id>archiva.snapshots</id>
+      <name>Internal Snapshot Repository</name>
+      <url>dav:http://reposerver.mycompany.com:8080/archiva/repository/snapshots/</url>
+    </snapshotRepository>
+  </distributionManagement>
+  <!-- omitted xml -->
+</project>

Add a build extension to your pom.xml (not required in Maven 2.0.9 and above)

<project>
+  <!-- omitted xml -->
+  <build>
+    <extensions>
+      <extension>
+        <groupId>org.apache.maven.wagon</groupId>
+        <artifactId>wagon-webdav-jackrabbit</artifactId>
+        <version>2.2</version>
+      </extension>
+    </extensions>
+  </build>
+  <!-- omitted xml -->
+</project>

Deploying using other protocols

You can also deploy to the Archiva server using traditional means such as SCP, FTP, etc. For more information on these deployment techniques, refer to the Maven documentation.

Once the files are deployed into the location of the Archiva managed repository, they should appear in the Browse page. The artifacts should also be searcheable as long as the index-content repository consumer is enabled.

Deploying Third-Party Artifacts to Archiva using Maven

You can use mvn deploy:deploy-file to deploy single artifacts to Archiva. Once you have the settings file in place as described above, you can deploy the artifact using this type of command:

mvn deplo
 y:deploy-file -Dfile=filename.jar -DpomFile=filename.pom
+    -DrepositoryId=archiva.internal
+    -Durl=http://repo.mycompany.com:8080/repository/internal/

For more information, consult the documentation for the deploy:deploy-file goal

If you wish to use WebDAV to deploy the file, add dav: to the start of the URL as in the previous instructions.

However, on versions of Maven prior to 2.0.9, you will also need to create a file called pom.xml in the directory from which you intend to execute "mvn deploy:deploy-file":

<project>
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.example</groupId>
+  <artifactId>webdav-deploy</artifactId>
+  <packaging>pom</packaging>
+  <version>1</version>
+  <name>Webdav Deployment POM</name>
+
+  <build>
+    <extensions>
+      <extension>
+        <groupId>org.apache.maven.wagon</groupId>
+        <artifactId>wagon-webdav-jackrabbit</artifactId>
+        <version>2.2</version>
+      </extension>
+    </extensions>
+  </build>
+</project>

This pom will not be deployed with the artifact, it simply serves to make the WebDAV protocol available to the build process.

Alternately, you can save this file somewhere else, and use "mvn ... -f /path/to/filename" to force the use of an alternate POM file.

Deploying via the Web UI Form

The easiest way to deploy in the repository is via the Web UI form, which can be accessed in the Upload Artifact section. Just follow these steps:

In Archiva, click the Upload Artifact option in the left menu. You should see a form similar to the one at the end of this section.
Fill in the following required fields:
- Group Id - the groupId of the artifact to be deployed.
- Artifact Id - the artifactId of the artifact to be deployed.
- Version - the version of the artifact to be deployed.
- Packaging - the packaging of the artifact to be deployed. (ex. jar, war, ear, etc.)
- Drag and drop files to be deployed.
Select the repository you want to deploy to. Please note that if you do not have write permission to the repository, you will not be allowed to deploy on it.
Now, if you want Archiva to generate a pom for the artifact, check the Generate Maven 2 POM field. (Right now, only Maven 2 poms can be generated.) Alternately, supply a POM file to be deployed alongside the artifact.
Click Saves files and a message will be displayed notifying you if the upload/deployment was successful or not.

These are the files that will be in your repository after deployment:

artifact
POM file (if you supplied one or checked Generate Maven 2 POM)
maven-metadata.xml (this will be created if none exists in the artifact level yet, otherwise it will ju st be updated)
maven-metadata.xml.sha1 and maven-metadata.xml.md5 (these will be generated for newly created maven-metadata.xml files, otherwise they will just be updated)

+ +

+ + + + \ No newline at end of file Added: archiva/site-content/docs/1.4-M4/userguide/find-artifact.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M4/userguide/find-artifact.html?rev=1486565&view=auto ============================================================================== --- archiva/site-content/docs/1.4-M4/userguide/find-artifact.html (added) +++ archiva/site-content/docs/1.4-M4/userguide/find-artifact.html Mon May 27 10:39:16 2013 @@ -0,0 +1,362 @@ + + + + + + + + + Archiva Documentation - Identifying an Artifact + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + +

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 + + +

+ +

+ + +

+ +

Identifying an Artifact

Ar chiva indexes all of the artifacts that it discovers during the repository scanning process, storing information about their contents. This includes the checksum of the artifact, which can help to uniquely identify it within the repository.

Archiva includes a feature that allows you to check for the existence of a given artifact in the repository by checksum. This is useful in identifying a JAR or other artifact located from an external source that does not contain any Maven or version information.

To use this functionality, click the "Find Artifact" link in the left navigation.

When the screen first loads, a Java applet that will allow you to create a local checksum of a given artifact is loaded. Since it is reading the content of the artifact from the filesystem, it will present a security dialog similar to the following:

By trusting the applet, you can checksum files of a ny size locally and just upload the small checksum to the server. If you opt not to trust the applet, you must enter the checksum into the web form by hand.

Once you have loaded the page, you have the choice of browsing for a local file to identify, or entering the checksum directly.

To find an artifact, perform the following steps:

Click Find Artifact in the left navigation menu.
On the opened page, you will see a file-upload field. Upload any JAR file (or other artifact) from your local file system. You must enter an exact filename. In general, you would use the Browse button for entering the filename.
Click Search.
The whole file is not uploaded, but the checksum is. It will search the remote repository for an exact match of the file you specified and display the result of the search.

Once you submit the form, Arch iva will look to match the checksum:

If more than one artifact matches, a list of results is returned.
If a unique match is found, the individual artifact information page is returned.
If no match is found, a "no results" page is returned.

+ +

+ + + + \ No newline at end of file Added: archiva/site-content/docs/1.4-M4/userguide/index.html URL: http://svn.apache.org/viewvc/archiva/site-content/docs/1.4-M4/userguide/index.html?rev=1486565&view=auto ============================================================================== --- archiva/site-content/docs/1.4-M4/userguide/index.html (added) +++ archiva/site-content/docs/1.4-M4/userguide/index.html Mon May 27 10:39:16 2013 @@ -0,0 +1,362 @@ + + + + + + + + + Archiva Documentation - Users Guide + + + + + + + + + + + + + + + + +

+ + +

+ +

+ + +

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 + + +

+ +

+ + +

+ +

Users Guide

Welcome to the Archiva use r's guide. Getting to know and use Archiva is very simple - please select one of the following documents to learn how to use Archiva quickly.

+ +

+ + + + \ No newline at end of file