| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia |
| | Rendered using Apache Maven Fluido Skin 1.3.1 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="author" content="Olivier Lamy" /> |
| <meta name="Date-Creation-yyyymmdd" content="20121220" /> |
| <meta name="Date-Revision-yyyymmdd" content="20140326" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Archiva Documentation - Installing Apache Archiva as a Web Application</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.1.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="../js/apache-maven-fluido-1.3.1.min.js"></script> |
| |
| |
| <!-- Google Analytics --> |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140879-5']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <a href="../../../" id="bannerLeft"> |
| <img src="../../../images/archiva.png" alt="Apache Archiva"/> |
| </a> |
| </div> |
| <div class="pull-right"> <a href="http://www.apache.org/" id="bannerRight"> |
| <img src="http://www.apache.org/images/asf_logo_wide.png" alt="Apache Software Foundation"/> |
| </a> |
| </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="http://www.apache.org/" class="externalLink" title="Apache"> |
| Apache</a> |
| <span class="divider">/</span> |
| </li> |
| <li class=""> |
| <a href="../" title="Apache Archiva"> |
| Apache Archiva</a> |
| <span class="divider">/</span> |
| </li> |
| <li class=""> |
| <a href="../../../index.html" title="Apache Archiva"> |
| Apache Archiva</a> |
| <span class="divider">/</span> |
| </li> |
| <li class="active ">Installing Apache Archiva as a Web Application</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-03-26</li> |
| <li id="projectVersion" class="pull-right"> |
| Version: 2.0.1 |
| </li> |
| |
| </ul> |
| </div> |
| |
| |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| |
| |
| <ul class="nav nav-list"> |
| <li class="nav-header">Introduction</li> |
| |
| <li> |
| |
| <a href="../quick-start.html" title="Quick Start"> |
| <i class="none"></i> |
| Quick Start</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tour/index.html" title="Feature Tour"> |
| <i class="none"></i> |
| Feature Tour</a> |
| </li> |
| |
| <li> |
| |
| <a href="../release-notes.html" title="Release Notes"> |
| <i class="none"></i> |
| Release Notes</a> |
| </li> |
| |
| <li> |
| |
| <a href="../../../download.html" title="Downloads"> |
| <i class="none"></i> |
| Downloads</a> |
| </li> |
| <li class="nav-header">Users Guide</li> |
| |
| <li> |
| |
| <a href="../userguide/browsing.html" title="Browsing"> |
| <i class="none"></i> |
| Browsing</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/searching.html" title="Searching"> |
| <i class="none"></i> |
| Searching</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/delete-artifact.html" title="Deleting an Artifact"> |
| <i class="none"></i> |
| Deleting an Artifact</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/using-repository.html" title="Using as a repository"> |
| <i class="none"></i> |
| Using as a repository</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/deploy.html" title="Deploying to repository"> |
| <i class="none"></i> |
| Deploying to repository</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/virtual-repositories.html" title="Configuring Virtual Repositories"> |
| <i class="none"></i> |
| Configuring Virtual Repositories</a> |
| </li> |
| |
| <li> |
| |
| <a href="../userguide/rss.html" title="Rss Feeds in Archiva"> |
| <i class="none"></i> |
| Rss Feeds in Archiva</a> |
| </li> |
| <li class="nav-header">Administrators Guide</li> |
| |
| <li> |
| |
| <a href="../adminguide/installing.html" title="Installing Archiva"> |
| <i class="icon-chevron-down"></i> |
| Installing Archiva</a> |
| <ul class="nav nav-list"> |
| |
| <li> |
| |
| <a href="../adminguide/standalone.html" title="Installing Standalone"> |
| <i class="none"></i> |
| Installing Standalone</a> |
| </li> |
| |
| <li class="active"> |
| |
| <a href="#"><i class="none"></i>Installing as a WAR</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/upgrade.html" title="Upgrading to a New Version"> |
| <i class="none"></i> |
| Upgrading to a New Version</a> |
| </li> |
| </ul> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/databases.html" title="Databases"> |
| <i class="none"></i> |
| Databases</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/repositories-content-storage.html" title="Repositories Content Storage"> |
| <i class="none"></i> |
| Repositories Content Storage</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/security.html" title="Security"> |
| <i class="icon-chevron-right"></i> |
| Security</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/configuration.html" title="Archiva Configuration"> |
| <i class="icon-chevron-right"></i> |
| Archiva Configuration</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/webservices/rest.html" title="REST Apis"> |
| <i class="none"></i> |
| REST Apis</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/configuration-files.html" title="Configuration Files"> |
| <i class="none"></i> |
| Configuration Files</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/system-status.html" title="System Status"> |
| <i class="none"></i> |
| System Status</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/logging.html" title="Log Files"> |
| <i class="icon-chevron-right"></i> |
| Log Files</a> |
| </li> |
| |
| <li> |
| |
| <a href="../adminguide/reports.html" title="Reports"> |
| <i class="none"></i> |
| Reports</a> |
| </li> |
| <li class="nav-header">Customising Archiva</li> |
| |
| <li> |
| |
| <a href="../customising/writing-consumer.html" title="Writing a Consumer Plugin"> |
| <i class="none"></i> |
| Writing a Consumer Plugin</a> |
| </li> |
| <li class="nav-header">More Information</li> |
| |
| <li> |
| |
| <a href="http://cwiki.apache.org/confluence/display/ARCHIVA/Index" class="externalLink" title="Archiva Wiki"> |
| <i class="none"></i> |
| Archiva Wiki</a> |
| </li> |
| <li class="nav-header">ASF</li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"> |
| <i class="none"></i> |
| How Apache Works</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation"> |
| <i class="none"></i> |
| Foundation</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"> |
| <i class="none"></i> |
| Sponsoring Apache</a> |
| </li> |
| |
| <li> |
| |
| <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"> |
| <i class="none"></i> |
| Thanks</a> |
| </li> |
| <li class="nav-header">Project Documentation</li> |
| |
| <li> |
| |
| <a href="../project-info.html" title="Project Information"> |
| <i class="icon-chevron-right"></i> |
| Project Information</a> |
| </li> |
| </ul> |
| |
| |
| <form id="search-form" action="http://www.google.com/search" method="get" > |
| |
| <input value="http://archiva.apache.org/docs/2.0.1/" name="sitesearch" type="hidden"/> |
| <input class="search-query" name="q" id="query" type="text" /> |
| </form> |
| <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script> |
| |
| <hr /> |
| |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| |
| |
| |
| <div id="twitter"> |
| |
| <a href="https://twitter.com/archiva" class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow archiva</a> |
| <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> |
| |
| </div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="bodyColumn" class="span10" > |
| |
| <!-- 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. --><div class="section"> |
| <h2>Installing Apache Archiva as a Web Application<a name="Installing_Apache_Archiva_as_a_Web_Application"></a></h2><!-- TODO: link to wiki location for other application servers --> |
| <p>Archiva can be deployed as a web application into any Java EE application server. This document will show an example of doing so with Apache Tomcat 5.5, 6.0.x and 7.0.x</p> |
| <p><b>Note</b>: When you first start Archiva, you will see an Exception that schema SA does not exist - however it doesn't 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.</p></div> |
| <div class="section"> |
| <h2>To deploy Archiva on Apache Tomcat 5.5, 6.0 and 7.0.x<a name="To_deploy_Archiva_on_Apache_Tomcat_5.5_6.0_and_7.0.x"></a></h2> |
| <ul> |
| <li>Create a directory in tomcat called archiva, at the same level as bin, conf, logs and the others.</li> |
| <li>Copy the war file into the new directory</li> |
| <li>Create a <tt><tomcat home>/conf/Catalina/localhost/archiva.xml</tt> file with the following data (replace the database paths with a suitable location). When using Tomcat 6.0+, do not include the first line (XML encoding) in the <tt>archiva.xml</tt> configuration specified below to avoid parsing errors during startup: |
| <div class="source"> |
| <pre> <?xml version="1.0" encoding="UTF-8"?> |
| <Context path="/archiva" |
| docBase="${catalina.home}/archiva/apache-archiva-1.1.war"> |
| |
| <Resource name="jdbc/users" auth="Container" type="javax.sql.DataSource" |
| username="sa" |
| password="" |
| driverClassName="org.apache.derby.jdbc.EmbeddedDriver" |
| url="jdbc:derby:/path/to/database/users;create=true" /> |
| |
| <Resource name="mail/Session" auth="Container" |
| type="javax.mail.Session" |
| mail.smtp.host="localhost"/> |
| </Context></pre></div></li> |
| <li>Install <tt>derby-10.1.3.1.jar</tt> (or later), <tt>activation-1.1.jar</tt> and <tt>mail-1.4.jar</tt> into the Tomcat 5.5 <tt>common/lib</tt> or Tomcat 6.0 <tt>lib</tt> directory. This is required since the data sources are instantiated before the web application. |
| <p><b>Note</b>: Tomcat 5.5.20 and 5.5.23 are missing MailSessionFactory and a few other classes. JNDI mail sessions will <i>not</i> work. Use Tomcat 5.5.25 instead, or see <a class="externalLink" href="http://issues.apache.org/bugzilla/show_bug.cgi?id=40668"> Bug 40668</a> for a workaround.</p></li> |
| <li>The ${appserver.base} java property is used by the Archiva internal logging configuration to determine where to output its logs to. It is important to define this property either in the $CATALINA_OPTS system environment variable if Tomcat is being launched via the command line) or the service properties (if being launched as a service or daemon). The format typically expected is -Dappserver.base=<i>SOMEWHERE</i>. In this example, we'll put the logs in Tomcat's <tt>logs</tt> directory so we need to set appserver.base property to where Tomcat is installed: |
| <div class="source"> |
| <pre>export CATALINA_OPTS="-Dappserver.home=$CATALINA_HOME -Dappserver.base=$CATALINA_HOME" (for UNIX) |
| |
| OR |
| |
| set CATALINA_OPTS="-Dappserver.home=%CATALINA_HOME% -Dappserver.base=%CATALINA_HOME%" (for Windows)</pre></div></li> |
| <li>If setting the ${appserver.base} and ${appserver.home} using the previous step does not work, you can set it in the unpacked Archiva web application's <tt>WEB-INF/classes/application.properties</tt> as follows: |
| <div class="source"> |
| <pre># for Windows: |
| appserver.base=%CATALINA_HOME% |
| appserver.base=%CATALINA_BASE% |
| |
| # or, for UNIX: |
| appserver.base=$CATALINA_HOME |
| appserver.home=$CATALINA_BASE</pre></div></li> |
| <li>When running Tomcat as a <b>Windows</b> service, you need to edit <tt>regedit</tt> and then, in <tt>HKEY_LOCAL_MACHINE > SOFTWARE > Apache Software Foundation > Procrun 2.0 > TomcatX > Parameters > Java</tt>, modify the <tt>Options</tt> variable. Set the ${appserver.base} property by adding the following parameters at the end: |
| <div class="source"> |
| <pre>-Dappserver.base=%CATALINA_HOME% -Dappserver.home=%CATALINA_HOME%</pre></div></li></ul> |
| <p>For more information, see <a class="externalLink" href="http://cwiki.apache.org/confluence/display/ARCHIVA/Archiva+on+Tomcat"> Archiva on Tomcat</a> in the wiki.</p></div> |
| <div class="section"> |
| <h2>Archiva Configuration<a name="Archiva_Configuration"></a></h2> |
| <p>Archiva is configured using the <tt>~/.m2/archiva.xml</tt> configuration file by default when using a Java EE application server. </p><!-- TODO: how to configure the other file --></div> |
| <div class="section"> |
| <h2>Upgrading Archiva<a name="Upgrading_Archiva"></a></h2> |
| <p>To upgrade the Archiva web application, simply replace the web application with an alternative. Since the database and configuration files are stored externally to the application, no further maintainance is needed.</p> |
| <p>For general information about upgrading Archiva, see the relevant section in the <a href="./standalone.html#Upgrading20Archiva"> Installing standalone</a> guide.</p></div> |
| <div class="section"> |
| <h2>Configuring and Running Archiva<a name="Configuring_and_Running_Archiva"></a></h2> |
| <p>Once Archiva is running, it is configured in the same way as the standalone instance. See the <a href="../quick-start.html#Setting20up20your20Archiva20instance"> quick start</a> guide for more information.</p></div> |
| <div class="section"> |
| <h2>Troubleshooting<a name="Troubleshooting"></a></h2> |
| <div class="section"> |
| <h3>Error During Startup<a name="Error_During_Startup"></a></h3> |
| <p>There are cases when the Tomcat logs only shows the following error during startup:</p> |
| <div class="source"> |
| <pre>... |
| Aug 17, 2009 11:04:02 AM org.apache.catalina.core.StandardContext start |
| SEVERE: Error listenerStart |
| Aug 17, 2009 11:04:02 AM org.apache.catalina.core.StandardContext start |
| SEVERE: Context [/archiva] startup failed due to previous errors |
| Aug 17, 2009 11:04:04 AM org.apache.coyote.http11.Http11BaseProtocol start |
| ...</pre></div> |
| <p>One of the common causes for this <tt>listenerStart Error</tt> is a failure during Spring's initialization. One way to diagnose or confirm the exact cause of the error is by adding the following configuration to the unpacked Archiva webapp's <tt>WEB-INF/classes/log4j2.xml</tt>:</p> |
| <div class="source"> |
| <pre> <appenders> |
| |
| <Console name="console" target="SYSTEM_OUT"> |
| <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> |
| </Console> |
| |
| </appenders> |
| |
| <logger name="org.springframework.web" level="debug"> |
| <appender-ref ref="console"/> |
| </logger></pre></div> |
| <p>The above configuration directs Spring's output logs to the Tomcat console and be recorded in Tomcat's log files. </p></div> |
| <div class="section"> |
| <h3>Diagnosing Errors<a name="Diagnosing_Errors"></a></h3> |
| <p>One of the least decipherable errors you can get from Tomcat is a <tt>404</tt> when the deployment fails. In <tt><tomcat home>/logs/catalina.out</tt> you will only find that it fails, but not why. Also Archiva's logs will not tell you.</p> |
| <p>The log messages and stack traces in case of a <tt>404</tt> can be found in <tt><tomcat home>/logs/localhost.<date></tt>.</p></div></div> |
| </div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p >Copyright © 2006–2014 |
| <a href="http://www.apache.org/">The Apache Software Foundation</a>. |
| All rights reserved. |
| |
| </p> |
| </div> |
| |
| |
| <div class="row span12">Apache Archiva :: Documentation, Archiva :: Documentation, Apache, the Apache feather logo, and the Apache Archiva :: Documentation project logos are trademarks of The Apache Software Foundation.</div> |
| |
| <div class="row span12"> |
| <a href="http://archiva.apache.org/docs/2.0.1/privacy-policy.html">Privacy Policy</a> |
| </div> |
| |
| |
| |
| |
| |
| |
| <div id="ohloh" class="pull-right"> |
| <script type="text/javascript" src="http://www.ohloh.net/p/6670/widgets/project_basic_stats.js"></script> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
