You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2008/01/07 18:34:02 UTC
svn commit: r609711 -
/lenya/docu/src/documentation/content/xdocs/docs/2_0_x/installation/source_version.xml
Author: andreas
Date: Mon Jan 7 09:33:51 2008
New Revision: 609711
URL: http://svn.apache.org/viewvc?rev=609711&view=rev
Log:
[minor change] formatting
Modified:
lenya/docu/src/documentation/content/xdocs/docs/2_0_x/installation/source_version.xml
Modified: lenya/docu/src/documentation/content/xdocs/docs/2_0_x/installation/source_version.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/2_0_x/installation/source_version.xml?rev=609711&r1=609710&r2=609711&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/2_0_x/installation/source_version.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/2_0_x/installation/source_version.xml Mon Jan 7 09:33:51 2008
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 1999-2004 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
-
+
+ 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.
@@ -23,38 +23,38 @@
<header>
<title>Apache Lenya 2.0 Installation Instructions</title>
</header>
-
+
<body>
- <section id="introduction">
- <title>Introduction</title>
-
- <p>
- This document explains how to install Lenya 2.0 from source.
- There are different ways to install and run Lenya:
- <br/>
- Choose between
- </p>
- <ol>
- <li>Running Lenya standalone using the built-in Jetty servlet container</li>
- <li>Using Tomcat and have the build process taking care of deploying Lenya in Tomcat</li>
- </ol>
-
- <p>
- Please note that you can use other servlet
- containers as well, but Jetty and Tomcat are the tested ones.
- </p>
-
- <p>
- In all cases, you will need to meet the following prerequisites,
- that describe the setup that is tested and recommended.
- </p>
-
- </section>
+ <section id="introduction">
+ <title>Introduction</title>
+
+ <p>
+ This document explains how to install Lenya 2.0 from source.
+ There are different ways to install and run Lenya:
+ <br/>
+ Choose between
+ </p>
+ <ol>
+ <li>Running Lenya standalone using the built-in Jetty servlet container</li>
+ <li>Using Tomcat and have the build process taking care of deploying Lenya in Tomcat</li>
+ </ol>
+
+ <p>
+ Please note that you can use other servlet
+ containers as well, but Jetty and Tomcat are the tested ones.
+ </p>
+
+ <p>
+ In all cases, you will need to meet the following prerequisites,
+ that describe the setup that is tested and recommended.
+ </p>
+
+ </section>
<section id="prerequisites">
<title>Prerequisites</title>
-
+
<ul>
-
+
<li>
<p>
<strong>Java 2 Platform, Standard Edition</strong>
@@ -66,36 +66,38 @@
</li>
<li>
- <p>
- <strong>Recommended: Create a directory</strong> to better organise the various source files
- <br/>
- In this document, we will assume the name <code>src/</code> for that directory.
- This directory will contain the Lenya distribution as well as Cocoon.
- </p>
-
- <p>
- After expanding the downloaded archives or after a <a href="site:subversion">svn checkout</a>,
- the directory structure should look like this:
- </p>
-
- <source>
- your_home/ (or c:\ on Windows, NOT My Documents)
- `-- src/
- |-- lenya-2.0.x/ $LENYA_HOME
- `-- externals/
- `-- cocoon_2_1_x/ $COCOON_HOME
- `-- build/
- `-- webapp/ $COCOON_WEBAPP
- </source>
-
- <p>
- The directories inside cocoon_2_1_x/ will be created when you build Cocoon, cocoon will be built when you build lenya.
- The variables will later be used in the local.build.properties file that configures the Lenya build process.
- </p>
-
- </li>
-
- <li>
+ <p>
+ <strong>Recommended: Create a directory</strong> to better organise the various source files
+ <br/>
+ In this document, we will assume the name <code>src/</code> for that directory.
+ This directory will contain the Lenya distribution as well as Cocoon.
+ </p>
+
+ <p>
+ After expanding the downloaded archives or after a <a href="site:subversion">svn checkout</a>,
+ the directory structure should look like this:
+ </p>
+
+ <source>
+your_home/ (or C:\ on Windows, not the "My Documents" folder)
+ src/
+ lenya-2.0.x/ $LENYA_HOME
+ externals/
+ cocoon_2_1_x/ $COCOON_HOME
+ build/
+ webapp/ $COCOON_WEBAPP
+ </source>
+
+ <p>
+ The directories inside <code>cocoon_2_1_x/</code> will be created when you build Cocoon,
+ Cocoon will be built when you build Lenya.
+ The variables will later be used in the <code>local.build.properties</code> file
+ that configures the Lenya build process.
+ </p>
+
+ </li>
+
+ <li>
<p>
<strong>Get Apache Lenya</strong>
<br/>
@@ -109,18 +111,18 @@
</section>
-
-
+
+
<section>
<title>1: Standalone Installation (using the built-in Jetty)</title>
-
+
<ol>
-
+
<li>
<p>
<strong>Configure Lenya</strong>
</p>
-
+
<p>
You need to edit your build properties and write
<code>local.build.properties</code>. To do this, execute <code>configure.sh</code>
@@ -132,13 +134,13 @@
If you want to use Cocoon from another location, you can change
the <code>$COCOON_HOME</code> point to your Cocoon source directory.
</note>
- </li>
-
+ </li>
+
<li>
<p>
<strong>Build Lenya</strong>
</p>
-
+
<p>
Execute <code>build.sh</code> (Unix) or <code>build.bat</code> (Windows) in
your Lenya source directory, depending on your platform.
@@ -146,17 +148,17 @@
<note>Cocoon will be built when you build Lenya. You can manually build or clean
Cocoon in <code>$COCOON_HOME</code> with <code>./build.sh</code> or <code>./build.sh clean</code>.
</note>
-
+
<p>
<strong>MS Windows</strong>
</p>
-
+
<source>$LENYA_HOME > build.bat</source>
-
+
<p>
<strong>Unix</strong>
</p>
-
+
<source>$LENYA_HOME > ./build.sh</source>
<p>
If your build fails, because it cant delete the file <code>cocoon.xconf.ant_patch</code>,
@@ -167,54 +169,54 @@
<code>verbose="true" failonerror="false"</code> to the <code><delete></code> tag.
</p>
</li>
-
+
<li>
<p>
<strong>Start Lenya</strong>
</p>
-
+
<p>
Execute <code>lenya.sh</code> (Unix) or <code>lenya.bat</code> (Windows)
in your Lenya source directory, depending on
your platform. Make sure that you have the environment
variable <code>JAVA_HOME</code> defined to point to the
location of the Java SDK you installed (see <a
- href="#prerequisites">Prerequisites</a>).
+ href="#prerequisites">Prerequisites</a>).
</p>
-
+
<p>
<strong>MS Windows</strong>
</p>
-
+
<source>$LENYA_HOME > lenya.bat</source>
-
+
<p>
<strong>Unix</strong>
</p>
-
+
<source>$LENYA_HOME > ./lenya.sh</source>
</li>
-
+
<li>
<p>
<strong>Test the installation</strong>
</p>
-
+
<p>
<a href="http://localhost:8888">http://localhost:8888/</a>
</p>
</li>
</ol>
</section>
-
+
<section>
<title>2: Installation with Apache Tomcat</title>
<warning label="Warning: Tomcat and spaces">The installation path may not contain spaces, otherwise you may get a
<code>java.net.URISyntaxException</code> error.</warning>
-
+
<ol>
-
- <li>
+
+ <li>
<p>
<strong>Get Apache Tomcat</strong> for JDK 1.4
<br/>
@@ -222,39 +224,39 @@
following instructions, and we highly recommend it. Tomcat 4.0.0+, 4.1.24+,
5.0.18+ and 5.5.0+ should work too.
</p>
- <p>
+ <p>
Get it from <a href="site:tomcat5">http://jakarta.apache.org/site/binindex.cgi#tomcat-5.0</a>.
</p>
-
+
</li>
<li>
<p>
<strong>Install Apache Tomcat</strong>
</p>
-
+
<p>
See <a
- href="site:tomcat5.setup">Tomcat 5.0 Setup</a>
+ href="site:tomcat5.setup">Tomcat 5.0 Setup</a>
</p>
-
+
<p>
<strong>MS Windows:</strong>
-
+
<br/>
-
+
Basically you only need to set the <code>JAVA_HOME</code>
environment variable and run the Tomcat
installer. Decide to run Tomcat as a Windows
NT/2000/XP-Service.
</p>
</li>
-
+
<li>
<p>
<strong>Configure Lenya</strong>
</p>
-
+
<p>
To install Lenya with Tomcat, you need to edit your build
properties. To do this, copy
@@ -263,11 +265,11 @@
</p>
<note>You can use the <code>configure.sh</code> or <code>configure.bat</code> to configure your
<code>local.build.properties</code>.</note>
-
+
<p>
Edit <code>local.build.properties</code>. For the described
configuration the following settings will work (<strong>MS
- Windows:</strong> Don't use backslashes "<code>\</code>" for
+ Windows:</strong> Don't use backslashes "<code>\</code>" for
directory separation.) It is important that
<code>tomcat.home.dir</code> is an absolute path. Replace
<code>$TOMCAT_HOME</code> by your Tomcat installation
@@ -276,107 +278,107 @@
the <code>cocoon.webapp.dir</code>, <code>web.app.server</code> and
<code>cocoon.src.dir</code> properties.
</p>
-
+
<ul>
<li><code>web.app.server=Tomcat</code></li>
<li><code>cocoon.src.dir=$COCOON_HOME</code></li>
<li><code>tomcat.home.dir=$TOMCAT_HOME</code></li>
</ul>
</li>
-
+
<li>
<p>
<strong>Build Lenya</strong>
</p>
-
+
<p>
Execute <code>build</code> in your Lenya source directory.
</p>
</li>
-
- <li>
- <p>
- <strong>Checked versions of endorsed libraries</strong>
- </p>
-
- <p>
- Lenya and Tomcat will inter-operate correctly only if the proper
- versions of the Xalan and Xerces libraries are used consistently
- throughout the deployment. Unfortunately this can be difficult
- to get to work correctly since both of these libraries are
- shipped with Java 2 SDK, Tomcat, Cocoon and Lenya.
- </p>
-
- <p>
- The following libraries must be placed in the endorsed library
- directory for your deployment.
- </p>
-
- <ul>
- <li><code>jakarta-bcel-20040329.jar</code></li>
- <li><code>jakarta-regexp-1.5.jar</code></li>
- <li><code>xalan-2.7.0.jar</code></li>
- <li><code>xercesImpl-2.9.0.jar</code></li>
- <li><code>xml-apis-1.3.04.jar</code></li>
- </ul>
-
- <p>
- They are placed by the build process in the directory specified
- by <code>tomcat.endorsed.dir</code> in
- <code>build.properties</code>. You should validate that these
- files are indeed in the proper location for your deployment.
- You must then validate that no other instances of these
- libraries exist in any of the following directories:
- </p>
-
- <ul>
- <li>
- The Java 2 SDK endorsed standards directories. This is
- usually <code>${JAVA_HOME}/lib/endorsed/</code>.
- </li>
-
- <li>
- Any other location in your Tomcat deployment. Specifically,
- check <code>shared/lib/</code>, <code>common/lib/</code> and
- <code>server/lib/</code>.
- </li>
-
- <li>
- Any other location in your Lenya deployment. Specifically,
- check <code>webapps/lenya/WEB-INF/lib/</code>.
- </li>
- </ul>
-
- <p>
- A common symptom of incorrect library version are blank pages
- after starting Lenya. Try carefully checking the location and
- version numbers of each of the libraries.
- </p>
-
- <p>
- References:
- </p>
-
- <ul>
- <li>
- <a href="site:tomcat5.classloader">
- Tomcat Class Loader HOWTO (http://jakarta.apache.org/tomcat/tomcat-5.0-doc/class-loader-howto.html)
- </a>
- </li>
-
- <li>
- <a href="site:java.endorsedmechanism">
- Java 2 Endorsed Standards Override Mechanism
- (http://java.sun.com/j2se/1.4.2/docs/guide/standards/index.html)
- </a>
- </li>
- </ul>
- </li>
- <li>
- <p>
+
+ <li>
+ <p>
+ <strong>Checked versions of endorsed libraries</strong>
+ </p>
+
+ <p>
+ Lenya and Tomcat will inter-operate correctly only if the proper
+ versions of the Xalan and Xerces libraries are used consistently
+ throughout the deployment. Unfortunately this can be difficult
+ to get to work correctly since both of these libraries are
+ shipped with Java 2 SDK, Tomcat, Cocoon and Lenya.
+ </p>
+
+ <p>
+ The following libraries must be placed in the endorsed library
+ directory for your deployment.
+ </p>
+
+ <ul>
+ <li><code>jakarta-bcel-20040329.jar</code></li>
+ <li><code>jakarta-regexp-1.5.jar</code></li>
+ <li><code>xalan-2.7.0.jar</code></li>
+ <li><code>xercesImpl-2.9.0.jar</code></li>
+ <li><code>xml-apis-1.3.04.jar</code></li>
+ </ul>
+
+ <p>
+ They are placed by the build process in the directory specified
+ by <code>tomcat.endorsed.dir</code> in
+ <code>build.properties</code>. You should validate that these
+ files are indeed in the proper location for your deployment.
+ You must then validate that no other instances of these
+ libraries exist in any of the following directories:
+ </p>
+
+ <ul>
+ <li>
+ The Java 2 SDK endorsed standards directories. This is
+ usually <code>${JAVA_HOME}/lib/endorsed/</code>.
+ </li>
+
+ <li>
+ Any other location in your Tomcat deployment. Specifically,
+ check <code>shared/lib/</code>, <code>common/lib/</code> and
+ <code>server/lib/</code>.
+ </li>
+
+ <li>
+ Any other location in your Lenya deployment. Specifically,
+ check <code>webapps/lenya/WEB-INF/lib/</code>.
+ </li>
+ </ul>
+
+ <p>
+ A common symptom of incorrect library version are blank pages
+ after starting Lenya. Try carefully checking the location and
+ version numbers of each of the libraries.
+ </p>
+
+ <p>
+ References:
+ </p>
+
+ <ul>
+ <li>
+ <a href="site:tomcat5.classloader">
+ Tomcat Class Loader HOWTO (http://jakarta.apache.org/tomcat/tomcat-5.0-doc/class-loader-howto.html)
+ </a>
+ </li>
+
+ <li>
+ <a href="site:java.endorsedmechanism">
+ Java 2 Endorsed Standards Override Mechanism
+ (http://java.sun.com/j2se/1.4.2/docs/guide/standards/index.html)
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <p>
<strong>Clear Tomcat work directory</strong>
</p>
-
+
<p>
Tomcat's work cache may not be consistent with your newly installed
Lenya. This can lead to any number of errors and exceptions. To
@@ -384,38 +386,34 @@
<code>build.bat</code> or <code>build.sh</code> in your Lenya source
directory, depending on your platform.
</p>
-
+
<p>
<strong>MS Windows</strong>
</p>
-
- <source>
- $LENYA_HOME > build.bat clean
- </source>
-
+
+ <source>$LENYA_HOME > build.bat clean</source>
+
<p>
<strong>Unix</strong>
</p>
-
- <source>
- $LENYA_HOME > ./build.sh clean
- </source>
+
+ <source>$LENYA_HOME > ./build.sh clean</source>
</li>
<li>
<p>
<strong>Restart Tomcat</strong>
</p>
-
+
<p>
Restart Tomcat to load the Lenya webapp.
</p>
</li>
-
+
<li>
<p>
<strong>Test the installation</strong>
</p>
-
+
<p>
<a href="http://localhost:8080/lenya">http://localhost:8080/lenya/</a>
</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org