diff options
Diffstat (limited to 'src/site')
-rw-r--r-- | src/site/apt/guides/developing/index.apt | 87 | ||||
-rw-r--r-- | src/site/apt/guides/getting-started/index.apt | 130 | ||||
-rw-r--r-- | src/site/apt/guides/getting-started/maven-configuration.apt | 171 | ||||
-rw-r--r-- | src/site/apt/index.apt | 45 | ||||
-rw-r--r-- | src/site/apt/repository-sync.apt | 26 | ||||
-rw-r--r-- | src/site/resources/images/archiva-logo-banner.jpg | bin | 19782 -> 0 bytes | |||
-rw-r--r-- | src/site/site.xml | 47 |
7 files changed, 0 insertions, 506 deletions
diff --git a/src/site/apt/guides/developing/index.apt b/src/site/apt/guides/developing/index.apt deleted file mode 100644 index 1db0f029a..000000000 --- a/src/site/apt/guides/developing/index.apt +++ /dev/null @@ -1,87 +0,0 @@ - ----- - Developing Archiva - ----- - Henri Yandell - ----- - 20 October 2006 - ----- - -~~ Copyright 2006 The Apache Software Foundation. -~~ -~~ Licensed under the Apache License, Version 2.0 (the "License"); -~~ you may not use this file except in compliance with the License. -~~ You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/guides/mini/guide-apt-format.html - -Goal - - The idea here is to explain how to develop Archiva; or at least to provide some - insight into what is what within the maven/archiva/ directory. - -Subprojects - - The following subprojects exist within Archiva: - - * archiva-applet - The progress bar on the checksum checking page. - - * archiva-configuration - A facade on top of the Plexus configuration XML. - - * archiva-converter - converts an m1 repository to an m2 one - currently not hooked up - - * archiva-core - central code, business objects, modello etc. - - * archiva-discoverer - monitors the managed repositories and kicks off the indexing. - - * archiva-indexer - the lucene indexing. - - * archiva-plexus-application - archiva can run on plexus as well as as a war. This creates a plexus app. - - * archiva-plexus-runtime - archiva can run on plexus as well as as a war. This runs lots of apps. - - * archiva-proxy - proxies repositories? - - * archiva-reports-standard - a couple of reports are implemented. Not very pluginable yet. - - * archiva-repository-layer - a query layer for the reports - - * archiva-security - webapp security - - * archiva-utils - some handy archiva specific utils - - * archiva-webapp - creates a war file - - * design - contains a mock-up currently - - * maven-meeper - rsync scripts to sync repositories. Also converts m1 repositories to m2 repositories. - -Concepts - - There are various terms in Archiva that are worth explaining and defining. - - * "Managed" - A managed repository is a repository which Archiva is sitting on top of that may be browsed. - - * "Indexed" - The ability to search a managed repository. - - * "Proxied" - A remote repository which an existing managed repository can be used as a facade for. - - * "Synchronized" - A remote repository which is physically copied down to be managed under Archiva. - - * "Identifier" - A short ID for your repository that will be used in URLs. - -Material that needs pulling into this site - - * {{{http://docs.codehaus.org/display/MAVEN/Repository+Manager} Repository Manager design wiki}} - - * {{{http://docs.codehaus.org/display/MAVEN/Maven+repository+tools} Repository tools wiki}} - - * {{{http://docs.codehaus.org/display/MAVEN/Repository+Security} Repository security wiki}} diff --git a/src/site/apt/guides/getting-started/index.apt b/src/site/apt/guides/getting-started/index.apt deleted file mode 100644 index 0b362515e..000000000 --- a/src/site/apt/guides/getting-started/index.apt +++ /dev/null @@ -1,130 +0,0 @@ - ----- - Getting Started with Archiva - ----- - Henri Yandell - ----- - 1 October 2006 - ----- - -~~ Copyright 2006 The Apache Software Foundation. -~~ -~~ Licensed under the Apache License, Version 2.0 (the "License"); -~~ you may not use this file except in compliance with the License. -~~ You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/guides/mini/guide-apt-format.html - -To checkout the latest code - - Using Subversion, either checkout from {{http://svn.apache.org/repos/asf/maven/archiva/trunk/}} or to get all of Maven 2, checkout from {{http://svn.apache.org/repos/asf/maven/trunks/}}. - -To build - - Run 'mvn install'. If this is the first time, and if you've not pulled this down for some other reason then it will save time to do the following first: - - * Download the 1.0 connector zip from: {{http://java.sun.com/j2ee/connector/download.html}} - - * Unpack the zip to get the jar - - * Run: mvn install:install-file -DgroupId=javax.resource -DartifactId=connector -Dversion=1.0 -Dpackaging=jar -Dfile=connector.jar - - -To test-deploy Archiva on the embedded Jetty - - * cd archiva-webapp - - * mvn jetty:run - - -To deploy Archiva to Tomcat 5.5 - - * Create a directory in tomcat called archiva, at the same level as bin, conf, logs and the others. - - * Copy the war file from archiva/archiva-webapp/target into the new directory - - * Create a conf/Catalina/localhost/archiva.xml file with the following data: - -+-------------------------------------------------------------------------+ - <?xml version="1.0" encoding="UTF-8"?> - <Context path="/archiva" - docBase="${catalina.home}/archiva/archiva-webapp-1.0-SNAPSHOT.war"> - - <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource" - username="sa" - password="" - driverClassName="org.apache.derby.jdbc.EmbeddedDriver" - url="jdbc:derby:database/archiva;create=true" - /> - </Context> -+-------------------------------------------------------------------------+ - - * Copy archiva/archiva-webapp/target/archiva-webapp-1.0-SNAPSHOT/WEB-INF/lib/derby-10.1.3.1.jar into the tomcat common/lib - - * To deal with a current bug, you'll also need to add the following to your ${catalina.home}/conf/web.xml in the relevant section (search for jspx): - -+-------------------------------------------------------------------------+ - <servlet-mapping> - <servlet-name>jsp</servlet-name> - <url-pattern>*.jspf</url-pattern> - </servlet-mapping> -+-------------------------------------------------------------------------+ - - When you first start Archiva, you will see an Exception that schema SA does not exist - however it doesn't appear to cause a problem. If you use a username other than 'sa', such as 'archiva', then you seem to get the same error but Tomcat fails to start the context and you have to shutdown and restart again. - - -To deploy Archiva on Plexus - - Plexus is a container developed as a part of Maven. It provides a very simple way to get started with Archiva: - - * Unpack the archiva-plexus-runtime/target/archiva-bin.tar.gz archive into a directory of your choice. - - * Start with: ./bin/plexus.sh start or a platform specific version. - - * A Derby exception "Schema 'SA' does not exist" occurs, but is not of concern. - - -Setting up your Archiva instance - - * Goto {{http://localhost:9091/}} if on the embedded Jetty, {{http://localhost:8080/archiva/}} if on Tomcat or {{http://localhost:8080/archiva/}} if on Plexus. - - * On the first page - setup your administration user. The password requires a numerical character and must not be longer than 8 chars. You'll then need to log in. User 'admin' as the username and the password you've entered. - - * On the second page - setup your first repository. It can be both an m1 and an m2 repository. - - * On the third page - setup your indexing. Mostly this means choosing a directory to put the index in. It'll re-index every hour. - - A useful repository to setup when exploring is your local Maven repository. - -+-------------------------------------------------------------------------+ - Identifier: LOCAL - Name: Maven2 Local Repository - Location: $HOME/.m2/repository -+-------------------------------------------------------------------------+ - - -Updating Archiva within a Tomcat - - While exploring Archiva, or perhaps while developing with it, you will want to delete the - current state. Presuming you followed the instructions above, you will need to remove the - following files from the ${catalina.home} directory. Ensure your Tomcat has first been - shutdown. - -+-------------------------------------------------------------------------+ - # Remove the database - rm -r bin/database/ bin/derby.log - # Remove the archiva configuration - rm $HOME/.m2/archiva.xml - # Remove the temporary Tomcat files - rm webapps/archiva/ work/Catalina/localhost/archiva/ logs/* - # Remove the war file (if you're deploying a new one) - rm archiva/*.war -+-------------------------------------------------------------------------+ diff --git a/src/site/apt/guides/getting-started/maven-configuration.apt b/src/site/apt/guides/getting-started/maven-configuration.apt deleted file mode 100644 index 7d498c0c9..000000000 --- a/src/site/apt/guides/getting-started/maven-configuration.apt +++ /dev/null @@ -1,171 +0,0 @@ - ----- - Client Configuration - ----- - ----- - 17 November 2006 - ----- - -~~ Copyright 2006 The Apache Software Foundation. -~~ -~~ Licensed under the Apache License, Version 2.0 (the "License"); -~~ you may not use this file except in compliance with the License. -~~ You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/guides/mini/guide-apt-format.html - -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 {{{http://maven.apache.org/settings.html}Settings Reference}}). - - 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. - - <URL-TO-ARCHIVA> => where to find Archiva eg. http://localhost:8080/archiva - - <REPOSITORY-ID> => Identifer for the proxied repository inside Archiva - - <URL-NAME> => Another identifier, this time for normal repositories [one of the these will go away] - - -* Configuring a Repository - - [[1]] create a new profile to setup your repositories - -+-------------------------------------------------------------------------+ - <settings> - ... - <profiles> - <profile> - <id>Repository Proxy</id> - <activation> - <activeByDefault>true</activeByDefault> - </activation> - <!-- ******************************************************* --> - <!-- repositories for jar artifacts --> - <!-- ******************************************************* --> - <repositories> - <repository> - ... - </repository> - ... - </repositories> - <!-- ******************************************************* --> - <!-- repositories for maven plugins --> - <!-- ******************************************************* --> - <pluginRepositories> - <pluginRepository> - ... - </pluginRepository> - ... - </pluginRepositories> - </profile> - ... - </profiles> - ... - </settings> -+-------------------------------------------------------------------------+ - - [[2]] 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>URL-TO-ARCHIVA/repository/URL-NAME</url> - <releases> - <enabled>true</enabled> - </releases> - <snapshots> - <enabled>false</enabled> - </snapshots> - </repository> -+-------------------------------------------------------------------------+ - - You can also copy this for a proxied repository, but make sure to change /repository/ to /proxy/ and to change from the "URL Name" to the "Repository Identifier". This should look much like this: - -+-------------------------------------------------------------------------+ - <repository> - <id>maven-release</id> - <url>URL-TO-ARCHIVA/proxy/REPOSITORY-ID</url> - <releases> - <enabled>true</enabled> - </releases> - <snapshots> - <enabled>false</enabled> - </snapshots> - </repository> -+-------------------------------------------------------------------------+ - - -* Configuring Maven-2 to deploy to an Archiva repository - - [[1]] Create a user in Archiva to use for deployment - - [[2]] The deployment user needs the Role 'Repository Manager' for each repository that you want to deploy to - - [[3]] Define the server for deployment inside your 'settings.xml', use the newly created user for authentication - -+-------------------------------------------------------------------------+ - <settings> - ... - <servers> - <server> - <id>deployment.webdav</id> - <username>{archiva-deployment-user}</username> - <password>{archiva-deployment-pwd}</password> - </server> - ... - </servers> - ... - </settings> -+-------------------------------------------------------------------------+ - - [[4]] Configure the distributionManagement part of your pom.xml - -+-------------------------------------------------------------------------+ - <project> - ... - <distributionManagement> - <repository> - <id>deployment.webdav</id> - <name>Internal Release Repository</name> - <url>dav:URL-TO-ARCHIVA/repository/REPOSITORY-ID/</url> - </repository> - <snapshotRepository> - <id>deployment.webdav</id> - <name>Internal Snapshot Repository</name> - <url>dav:URL-TO-ARCHIVA/repository/REPOSITORY-ID/</url> - </snapshotRepository> - </distributionManagement> - ... - </project> -+-------------------------------------------------------------------------+ - - [[5]] Add a build extension to your pom.xml to use webdav - -+-------------------------------------------------------------------------+ - <project> - ... - <build> - <extensions> - <extension> - <groupId>org.apache.maven.wagon</groupId> - <artifactId>wagon-webdav</artifactId> - <version>1.0-beta-1</version> - </extension> - </extensions> - </build> - ... - </project> -+-------------------------------------------------------------------------+ - - [[6]] Finally the user that is running archiva (tomcat-user, plexus-user,..) must have write access to the deployment repository. diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt deleted file mode 100644 index 79f1d8348..000000000 --- a/src/site/apt/index.apt +++ /dev/null @@ -1,45 +0,0 @@ - ----- - Maven Archiva - ----- - Brett Porter - ----- - 25 May 2006 - ----- - -~~ Copyright 2006 The Apache Software Foundation. -~~ -~~ Licensed under the Apache License, Version 2.0 (the "License"); -~~ you may not use this file except in compliance with the License. -~~ You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/guides/mini/guide-apt-format.html - -Welcome to Maven Archiva - - Archiva (the Maven repository manager) is currently under development. It provides several pieces of functionality for your remote repository: - - * Browsing on POM information by group and artifact ID - - * Search over various information in the POM and filename - - * Locate JAR by checksum - - * Repository management through reporting and maintenance - - We welcome developers to the Maven community who are interested in contributing. If you'd like to discuss archiva, subscribe and post to - {{{mail-lists.html} the development mailing list}}, <<<archiva-dev@maven.apache.org>>>. - - If you'd like to obtain the code, you can get it from Subversion. See {{{source-repository.html} SCM details}} for more information. - - Bugs, issues and new ideas should be reported in the issue tracker - see {{{issue-tracking.html} this page}}. - - See the {{{http://docs.codehaus.org/display/MAVENUSER/Archiva} the Archiva wiki}} for more information, or log onto the IRC channel #archiva:irc.codehaus.org. diff --git a/src/site/apt/repository-sync.apt b/src/site/apt/repository-sync.apt deleted file mode 100644 index 73e709abc..000000000 --- a/src/site/apt/repository-sync.apt +++ /dev/null @@ -1,26 +0,0 @@ - ------ - Repository Synchronization - ------ - Maven Team - ------ - 12 October 2006 - ------ - -~~ Copyright 2006 The Apache Software Foundation. -~~ -~~ Licensed under the Apache License, Version 2.0 (the "License"); -~~ you may not use this file except in compliance with the License. -~~ You may obtain a copy of the License at -~~ -~~ http://www.apache.org/licenses/LICENSE-2.0 -~~ -~~ Unless required by applicable law or agreed to in writing, software -~~ distributed under the License is distributed on an "AS IS" BASIS, -~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -~~ See the License for the specific language governing permissions and -~~ limitations under the License. - -~~ NOTE: For help with the syntax of this file, see: -~~ http://maven.apache.org/guides/mini/guide-apt-format.html - -Repository Synchronization diff --git a/src/site/resources/images/archiva-logo-banner.jpg b/src/site/resources/images/archiva-logo-banner.jpg Binary files differdeleted file mode 100644 index 61aff60a2..000000000 --- a/src/site/resources/images/archiva-logo-banner.jpg +++ /dev/null diff --git a/src/site/site.xml b/src/site/site.xml deleted file mode 100644 index 6bc1f7448..000000000 --- a/src/site/site.xml +++ /dev/null @@ -1,47 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<!-- - ~ Copyright 2005-2006 The Apache Software Foundation. - ~ - ~ Licensed under the Apache License, Version 2.0 (the "License"); - ~ you may not use this file except in compliance with the License. - ~ You may obtain a copy of the License at - ~ - ~ http://www.apache.org/licenses/LICENSE-2.0 - ~ - ~ Unless required by applicable law or agreed to in writing, software - ~ distributed under the License is distributed on an "AS IS" BASIS, - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - ~ See the License for the specific language governing permissions and - ~ limitations under the License. - --> - -<project> - <body> - <links> - <item name="Maven" href="http://maven.apache.org/"/> - </links> - - <menu name="Documentation"> - <item name="Welcome" href="/index.html"/> - <item name="Getting Started" href="/guides/getting-started/index.html"/> - <item name="FAQ" href="http://docs.codehaus.org/display/MAVENUSER/Archiva+FAQ"/> - <item name="Maven Configuration" href="/guides/getting-started/maven-configuration.html"/> - <item name="Developing" href="/guides/developing/index.html"/> - </menu> - - <menu ref="reports" inherit="bottom"/> - </body> - <skin> - <groupId>org.apache.maven.skins</groupId> - <artifactId>maven-stylus-skin</artifactId> - </skin> - <publishDate format="dd MMM yyyy"/> - <bannerLeft> - <name>Maven</name> - <src>http://maven.apache.org/images/apache-maven-project-2.png</src> - <href>http://maven.apache.org/</href> - </bannerLeft> - <bannerRight> - <src>images/archiva-logo-banner.jpg</src> - </bannerRight> -</project> |