Author: brett Date: Wed Nov 21 02:40:22 2007 New Revision: 597023 URL: http://svn.apache.org/viewvc?rev=597023&view=rev Log: start the quick start guide
Added: maven/archiva/trunk/archiva-docs/src/site/apt/quick-start.apt - copied, changed from r596980, maven/archiva/trunk/archiva-docs/src/site/apt/guides/getting-started.apt Removed: maven/archiva/trunk/archiva-docs/src/site/apt/guides/getting-started.apt Modified: maven/archiva/trunk/archiva-docs/src/site/apt/adminguide/webapp.apt maven/archiva/trunk/archiva-docs/src/site/site.xml Modified: maven/archiva/trunk/archiva-docs/src/site/apt/adminguide/webapp.apt URL: http://svn.apache.org/viewvc/maven/archiva/trunk/archiva-docs/src/site/apt/adminguide/webapp.apt?rev=597023&r1=597022&r2=597023&view=diff ============================================================================== --- maven/archiva/trunk/archiva-docs/src/site/apt/adminguide/webapp.apt (original) +++ maven/archiva/trunk/archiva-docs/src/site/apt/adminguide/webapp.apt Wed Nov 21 02:40:22 2007 @@ -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: + ++-------------------------------------------------------------------------+ + <?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" /> + + <Resource name="jdbc/archiva" auth="Container" type="javax.sql.DataSource" + username="sa" + password="" + driverClassName="org.apache.derby.jdbc.EmbeddedDriver" + url="jdbc:derby:database/archiva;create=true" /> + + <Resource name="mail/Session" auth="Container" + type="javax.mail.Session" + mail.smtp.host="localhost"/> + </Context> ++-------------------------------------------------------------------------+ + + * <<Note>>: Tomcat 5.5.20 and 5.5.23 are missing MailSessionFactory and a + few other classes. JNDI mail sessions will <not> 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): + ++-------------------------------------------------------------------------+ + <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. + +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 Copied: maven/archiva/trunk/archiva-docs/src/site/apt/quick-start.apt (from r596980, maven/archiva/trunk/archiva-docs/src/site/apt/guides/getting-started.apt) URL: http://svn.apache.org/viewvc/maven/archiva/trunk/archiva-docs/src/site/apt/quick-start.apt?p2=maven/archiva/trunk/archiva-docs/src/site/apt/quick-start.apt&p1=maven/archiva/trunk/archiva-docs/src/site/apt/guides/getting-started.apt&r1=596980&r2=597023&rev=597023&view=diff ============================================================================== --- maven/archiva/trunk/archiva-docs/src/site/apt/guides/getting-started.apt (original) +++ maven/archiva/trunk/archiva-docs/src/site/apt/quick-start.apt Wed Nov 21 02:40:22 2007 @@ -1,5 +1,5 @@ ----- - Getting Started with Archiva + Quick Start ----- Henri Yandell ----- @@ -26,72 +26,27 @@ ~~ 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 +Installing Archiva - Plexus is a container developed as a part of Maven. It provides a very simple way to get started with 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}}. - * Unpack the archiva-plexus-runtime/target/archiva-bin.tar.gz archive into a directory of your choice. + To get started right away, you can run the following after unpacking: - * Start with: ./bin/plexus.sh start or a platform specific version. +---- +./bin/linux-x86-32/run.sh console +---- - * A Derby exception "Schema 'SA' does not exist" occurs, but is not of concern. + You will need to choose a different start command based on your platform, or use the generic <<<./bin/plexus.sh>>> script. The <<<console>>> argument + starts the server with the logs going to standard output, and waits for Ctrl+C to stop the server. -To deploy Archiva on Tomcat 5.5 + <<Note:>> A Derby exception "Schema 'SA' does not exist" occurs, but is not of concern. - * 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: - -+-------------------------------------------------------------------------+ - <?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" /> - - <Resource name="jdbc/archiva" auth="Container" type="javax.sql.DataSource" - username="sa" - password="" - driverClassName="org.apache.derby.jdbc.EmbeddedDriver" - url="jdbc:derby:database/archiva;create=true" /> - - <Resource name="mail/Session" auth="Container" - type="javax.mail.Session" - mail.smtp.host="localhost"/> - </Context> -+-------------------------------------------------------------------------+ - - * <<Note>>: Tomcat 5.5.20 and 5.5.23 are missing MailSessionFactory and a - few other classes. JNDI mail sessions will <not> 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): - -+-------------------------------------------------------------------------+ - <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. + Archiva is now running on <<<http://localhost:8080/archiva/>>> Setting up your Archiva instance - * Goto {{http://localhost:8080/archiva/}} + 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. @@ -101,20 +56,3 @@ * 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 -+-------------------------------------------------------------------------+ Modified: maven/archiva/trunk/archiva-docs/src/site/site.xml URL: http://svn.apache.org/viewvc/maven/archiva/trunk/archiva-docs/src/site/site.xml?rev=597023&r1=597022&r2=597023&view=diff ============================================================================== --- maven/archiva/trunk/archiva-docs/src/site/site.xml (original) +++ maven/archiva/trunk/archiva-docs/src/site/site.xml Wed Nov 21 02:40:22 2007 @@ -71,7 +71,6 @@ <!-- to be removed later, once content has been shifted to permanent home --> <menu name="Old Menu (deprecated)"> - <item name="Getting Started" href="/guides/getting-started.html"/> <item name="FAQ" href="http://docs.codehaus.org/display/MAVENUSER/Archiva+FAQ"/> <item name="Maven Configuration" href="/guides/maven-configuration.html"/> <item name="Security Configuration" href="/guides/security-configuration.html"/>