From 9370e30c0d35c8cf7137c2397902d9ca9467ecf5 Mon Sep 17 00:00:00 2001 From: Brett Porter Date: Wed, 21 Nov 2007 10:40:22 +0000 Subject: [PATCH] start the quick start guide git-svn-id: https://svn.apache.org/repos/asf/maven/archiva/trunk@597023 13f79535-47bb-0310-9956-ffa450edef68 --- .../src/site/apt/adminguide/webapp.apt | 75 ++++++++++- .../src/site/apt/guides/getting-started.apt | 120 ------------------ archiva-docs/src/site/apt/quick-start.apt | 58 ++++++++- archiva-docs/src/site/site.xml | 1 - 4 files changed, 126 insertions(+), 128 deletions(-) delete mode 100644 archiva-docs/src/site/apt/guides/getting-started.apt diff --git a/archiva-docs/src/site/apt/adminguide/webapp.apt b/archiva-docs/src/site/apt/adminguide/webapp.apt index 8dc32a6a5..8de31a048 100644 --- a/archiva-docs/src/site/apt/adminguide/webapp.apt +++ b/archiva-docs/src/site/apt/adminguide/webapp.apt @@ -4,8 +4,77 @@ Installing Apache Archiva as a Web Application - :STUB: This is a documentation stub. - -~~TODO: show example using Tomcat 6. ~~TODO: link to wiki location for other application servers +To deploy Archiva on 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 apps/archiva/lib into the new directory + + * Create a conf/Catalina/localhost/archiva.xml file with the following data: + ++-------------------------------------------------------------------------+ + + + + + + + + + ++-------------------------------------------------------------------------+ + + * <>: Tomcat 5.5.20 and 5.5.23 are missing MailSessionFactory and a + few other classes. JNDI mail sessions will work. Use Tomcat 5.5.17 + instead, or see {{{http://issues.apache.org/bugzilla/show_bug.cgi?id=40668} + Bug 40668}} for a workaround. + + * Copy $HOME/.m2/org/apache/derby/derby/10.1.3.1/derby-10.1.3.1.jar (or from the remote repository) 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): + ++-------------------------------------------------------------------------+ + + jsp + *.jspf + ++-------------------------------------------------------------------------+ + + 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. + +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 ++-------------------------------------------------------------------------+ + +~~TODO: what next? revise above too diff --git a/archiva-docs/src/site/apt/guides/getting-started.apt b/archiva-docs/src/site/apt/guides/getting-started.apt deleted file mode 100644 index f8d6c42b6..000000000 --- a/archiva-docs/src/site/apt/guides/getting-started.apt +++ /dev/null @@ -1,120 +0,0 @@ - ----- - Getting Started with Archiva - ----- - Henri Yandell - ----- - 1 October 2006 - ----- - -~~ Licensed to the Apache Software Foundation (ASF) under one -~~ or more contributor license agreements. See the NOTICE file -~~ distributed with this work for additional information -~~ regarding copyright ownership. The ASF licenses this file -~~ to you 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 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. - -To deploy Archiva on 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 apps/archiva/lib into the new directory - - * Create a conf/Catalina/localhost/archiva.xml file with the following data: - -+-------------------------------------------------------------------------+ - - - - - - - - - -+-------------------------------------------------------------------------+ - - * <>: Tomcat 5.5.20 and 5.5.23 are missing MailSessionFactory and a - few other classes. JNDI mail sessions will work. Use Tomcat 5.5.17 - instead, or see {{{http://issues.apache.org/bugzilla/show_bug.cgi?id=40668} - Bug 40668}} for a workaround. - - * Copy $HOME/.m2/org/apache/derby/derby/10.1.3.1/derby-10.1.3.1.jar (or from the remote repository) 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): - -+-------------------------------------------------------------------------+ - - jsp - *.jspf - -+-------------------------------------------------------------------------+ - - 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. - -Setting up your Archiva instance - - * Goto {{http://localhost:8080/archiva/}} - - * 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. - -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/archiva-docs/src/site/apt/quick-start.apt b/archiva-docs/src/site/apt/quick-start.apt index c50b40b29..37b37d5fa 100644 --- a/archiva-docs/src/site/apt/quick-start.apt +++ b/archiva-docs/src/site/apt/quick-start.apt @@ -1,8 +1,58 @@ - ------ + ----- Quick Start - ------ + ----- + Henri Yandell + ----- + 1 October 2006 + ----- -Quick Start +~~ Licensed to the Apache Software Foundation (ASF) under one +~~ or more contributor license agreements. See the NOTICE file +~~ distributed with this work for additional information +~~ regarding copyright ownership. The ASF licenses this file +~~ to you 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. - :STUB: This is a documentation stub. +~~ NOTE: For help with the syntax of this file, see: +~~ http://maven.apache.org/guides/mini/guide-apt-format.html + +Installing Archiva + + The quickest way to install Archiva is to use the standalone distribution. This includes a bundled Jetty server, started using the Plexus Application Server. + For more information on advanced configuration of this instance, refer to the {{{adminguide/standalone.html} Administration Guide}}. + + To get started right away, you can run the following after unpacking: + +---- +./bin/linux-x86-32/run.sh console +---- + + You will need to choose a different start command based on your platform, or use the generic <<<./bin/plexus.sh>>> script. The <<>> argument + starts the server with the logs going to standard output, and waits for Ctrl+C to stop the server. + + <> A Derby exception "Schema 'SA' does not exist" occurs, but is not of concern. + + Archiva is now running on <<>> + +Setting up your Archiva instance + + You can now browse the web administration of Archiva. There will be a few basic setup tasks to get started. + + * 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. diff --git a/archiva-docs/src/site/site.xml b/archiva-docs/src/site/site.xml index aad0f544e..66a13ec32 100644 --- a/archiva-docs/src/site/site.xml +++ b/archiva-docs/src/site/site.xml @@ -71,7 +71,6 @@ - -- 2.39.5