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 2007/10/26 15:04:49 UTC

svn commit: r588631 - in /lenya/docu/src/documentation/content/xdocs: ./ docs/2_0_x/tutorials/ docs/2_0_x/tutorials/proxy/

Author: andreas
Date: Fri Oct 26 06:04:48 2007
New Revision: 588631

URL: http://svn.apache.org/viewvc?rev=588631&view=rev
Log:
Consolidated proxy docs

Added:
    lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/
    lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/mod_proxy_ajp.xml
      - copied, changed from r588627, lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/mod_proxy_ajp.xml
    lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxy.xml
      - copied, changed from r588629, lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy.xml
    lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxying.xml
Removed:
    lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/mod_proxy_ajp.xml
    lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy.xml
Modified:
    lenya/docu/src/documentation/content/xdocs/site.xml

Copied: lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/mod_proxy_ajp.xml (from r588627, lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/mod_proxy_ajp.xml)
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/mod_proxy_ajp.xml?p2=lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/mod_proxy_ajp.xml&p1=lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/mod_proxy_ajp.xml&r1=588627&r2=588631&rev=588631&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/mod_proxy_ajp.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/mod_proxy_ajp.xml Fri Oct 26 06:04:48 2007
@@ -22,42 +22,7 @@
     <title>Running Lenya Behind Apache with mod_proxy_ajp</title>
   </header>
   <body>
-    
-    <section>
-      <title>Introduction</title>
 
-      <p>
-        This tutorial aims at getting you started with a proxy environment.
-        We're using Apache HTTPD 2.2 with the <em>mod_proxy_ajp</em> module, which is
-        included in the Apache distribution. You'll find a lot of documentation on the 
-        eb how to set up the web server on your machine.
-      </p>
-      <p>
-        Our goal is to run two virtual servers on your local machine:
-      </p>
-      <ul>
-        <li><em>cms.example.com</em> - the authoring environment of your publication</li>
-        <li><em>www.example.com</em> - the actual live site</li>
-      </ul>
-      <p>
-        Your administrators, editors etc. will use the URL <em>http://cms.example.com</em>
-        to connect to the authoring environment. We'll require an SSL connection for the
-        login usecase. Once you have established an SSL connection, your connection will
-        stay encrypted.
-      </p>
-    </section>
-    
-    <section>
-      <title>Declaring the Hosts</title>
-      <p>
-        To tell your system that the <em>example.com</em> domains run on your local machine,
-        open your <code>hosts</code> file, usually located at <code>/etc/hosts</code>,
-        and add the following lines:
-      </p>
-      <source xml:space="preserve"><![CDATA[127.0.0.1       cms.example.com
-127.0.0.1       www.example.com]]></source>
-    </section>
-    
     <section>
       <title>Configuring the AJP Connector in Tomcat</title>
       <p>
@@ -174,26 +139,6 @@
     ErrorLog /home/john/src/www/logs/www.example.com-error_log
     CustomLog /home/john/src/www/logs/www.example.com-access_log common
 </VirtualHost>]]></source>
-
-      <note>
-        You'll certainly run into cookie problems when using a non-empty context path
-        instead of running Lenya in the root context.
-        This causes errors like "The session doesn't contain the identity.".
-        You'll have to add some code to manipulate the cookies. If you need this functionality,
-        please send a mail to the developers list or file an enhancement bug.
-      </note>
-      <p>
-        The Apache web server can now be restarted using
-      </p>
-      <source xml:space="preserve">$ sudo apachectl restart</source>
-    </section>
-    
-    <section>
-      <title>Configuring Lenya for Proxying</title>
-      <p>
-        Now follow the steps described in the final sections of the
-        <a href="site:mod_proxy_14">mod_proxy tutorial</a>.
-      </p>
     </section>
     
   </body>

Copied: lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxy.xml (from r588629, lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy.xml)
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxy.xml?p2=lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxy.xml&p1=lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy.xml&r1=588629&r2=588631&rev=588631&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxy.xml Fri Oct 26 06:04:48 2007
@@ -24,44 +24,9 @@
   <body>
     
     <section>
-      <title>Introduction</title>
-
-      <p>
-        This tutorial aims at getting you started with a proxy environment.
-        We're using Apache HTTPD 2.2 with the <em>mod_proxy</em> module. You'll find
-        a lot of documentation on the web how to set up the web server on your
-        machine.
-      </p>
-      <p>
-        Our goal is to run two virtual servers on your local machine:
-      </p>
-      <ul>
-        <li><em>cms.example.com</em> - the authoring environment of your publication</li>
-        <li><em>www.example.com</em> - the actual live site</li>
-      </ul>
-      <p>
-        Your administrators, editors etc. will use the URL <em>http://cms.example.com</em>
-        to connect to the authoring environment. We'll require an SSL connection for the
-        login usecase. Once you have established an SSL connection, your connection will
-        stay encrypted.
-      </p>
-    </section>
-    
-    <section>
-      <title>Declaring the Hosts</title>
-      <p>
-        To tell your system that the <em>example.com</em> domains run on your local machine,
-        open your <code>hosts</code> file, usually located at <code>/etc/hosts</code>,
-        and add the following lines:
-      </p>
-      <source xml:space="preserve"><![CDATA[127.0.0.1       cms.example.com
-127.0.0.1       www.example.com]]></source>
-    </section>
-    
-    <section>
       <title>Configuring the Apache Web Server</title>
       <p>
-        Now we'll declare the virtual hosts for the Apache web server. This is done in
+        First we'll declare the virtual hosts for the Apache web server. This is done in
         a file called <code>httpd-vhosts.conf</code>. On Mac OS X, it is located in the directory
         <code>/opt/local/apache2/conf/extra</code>. If you're using Jetty on port 8888, the
         contents of the file should look like this:
@@ -152,15 +117,6 @@
       <source xml:space="preserve"><![CDATA[    RewriteRule ^/(.*) http://cms.example.com:8080/lenya14/default/authoring/$1 [P,L]
     ProxyPassReverse / http://cms.example.com:8080/lenya14/default/authoring/]]></source>
       <note>
-        You'll certainly run into cookie problems when using a non-empty context path
-        (like <em>lenya14</em> in the example above) instead of running Lenya in the root context.
-        This causes errors like "The session doesn't contain the identity.".
-        To avoid these problems, edit <code>$TOMCAT_HOME/conf/server.xml</code> and set the
-        <em>emptySessionPath</em> attribute of the Tomcat connector configuration to <em>true</em>.
-        You find more information in the <a href="http://tomcat.apache.org/tomcat-6.0-doc/config/ajp.html">Apache
-        Tomcat configuration reference</a>.
-      </note>
-      <note>
         With this setup, your browser might show error messages like "You have requested an
         encrypted page that contains some unencrypted information" when accessing a page
         with the <code>https</code> protocol. This is because Apache always connects to Lenya
@@ -168,52 +124,7 @@
         links to include images etc. on this page. This problem won't occur if you use the
         <a href="site:mod_proxy_ajp">mod_proxy_ajp</a> approach.
       </note>
-      <p>
-        The Apache web server can now be restarted using
-      </p>
-      <source xml:space="preserve">$ sudo apachectl restart</source>
-    </section>
-    
-    <section>
-      <title>Configuring the Publication for Proxying</title>
-      <p>
-        When you use a proxy, Lenya has to convert all internal links accordingly.
-        Therefore you have to tell the publication about the proxy configuration.
-        Open the file <code>pubs/default/config/publication.xml</code> and uncomment
-        and modify the <code><![CDATA[<proxy/>]]></code> elements:
-      </p>
-      <source xml:space="preserve"><![CDATA[<proxies>
-  <proxy ssl="false" area="authoring" url="http://cms.example.com"/>
-  <proxy ssl="false" area="live" url="http://www.example.com"/>
-  <proxy ssl="true" area="authoring" url="https://cms.example.com"/>
-  <proxy ssl="true" area="live" url="https://www.example.com"/>
-</proxies>]]></source>
     </section>
-    
-    <section>
-      <title>Configuring the Global Proxies</title>
-      <p>
-        The application-wide (publication independent) proxies are configured in
-        <code>WEB-INF/cocoon.xconf</code>. Look for the declaration of the <code>GlobalProxies</code>
-        service and update this entry:
-      </p>
-      <source xml:space="preserve"><![CDATA[<component logger="lenya.proxy"
-    role="org.apache.lenya.cms.linking.GlobalProxies"
-    class="org.apache.lenya.cms.linking.impl.GlobalProxiesImpl">
-  <proxy ssl="false" url="http://cms.host.com"/>
-  <proxy ssl="true" url="https://cms.host.com"/>
-</component>]]></source>
-    </section>
-    
-    <section>
-      <title>Testing the Settings</title>
-      <p>
-        After re-deploying the publication and restarting your servlet container,
-        you should be able to access the
-        authoring environment of the default publication at the URL
-        <a href="http://cms.example.com/">http://cms.example.com/</a>.
-      </p>
-    </section>
-    
+        
   </body>
 </document>

Added: lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxying.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxying.xml?rev=588631&view=auto
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxying.xml (added)
+++ lenya/docu/src/documentation/content/xdocs/docs/2_0_x/tutorials/proxy/proxying.xml Fri Oct 26 06:04:48 2007
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 1999-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.
+-->
+<!-- $Id: metadata.xml 55543 2004-10-26 00:14:59Z gregor $ -->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" 
+  "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+  <header>
+    <title>Running Lenya Behind Apache with mod_proxy</title>
+  </header>
+  <body>
+    
+    <section>
+      <title>Introduction</title>
+
+      <p>
+        This tutorial aims at getting you started with a proxy environment.
+        We're using Apache HTTPD 2.2 with the <em>mod_proxy</em> module. You'll find
+        a lot of documentation on the web how to set up the web server on your
+        machine.
+      </p>
+      <p>
+        Our goal is to run two virtual servers on your local machine:
+      </p>
+      <ul>
+        <li><em>cms.example.com</em> - the authoring environment of your publication</li>
+        <li><em>www.example.com</em> - the actual live site</li>
+      </ul>
+      <p>
+        Your administrators, editors etc. will use the URL <em>http://cms.example.com</em>
+        to connect to the authoring environment. We'll require an SSL connection for the
+        login usecase. Once you have established an SSL connection, your connection will
+        stay encrypted.
+      </p>
+    </section>
+    
+    <section>
+      <title>Declaring the Hosts</title>
+      <p>
+        To tell your system that the <em>example.com</em> domains run on your local machine,
+        open your <code>hosts</code> file, usually located at <code>/etc/hosts</code>,
+        and add the following lines:
+      </p>
+      <source xml:space="preserve"><![CDATA[127.0.0.1       cms.example.com
+127.0.0.1       www.example.com]]></source>
+    </section>
+    
+    <section>
+      <title>Configuring the Apache Web Server</title>
+      <p>
+        There are multiple options to connect the Apache web server, which acts as the
+        reverse proxy, to the Tomcat servlet container. The two most common ways are
+      </p>
+      <ul>
+        <li><a href="site:mod_proxy_14">mod_proxy</a></li>
+        <li><a href="site:mod_proxy_ajp">mod_proxy_ajp</a></li>
+        <li>mod_jk</li>
+      </ul>
+      <p>
+        mod_proxy is the classic, proven approach. The AJP protocol
+        is newer, easier to set up and provides seamless SSL integration. For more information
+        on which connector to choose, refer to the
+        <a href="http://tomcat.apache.org/faq/connectors.html">Tomcat connectors FAQ</a>.
+      </p>
+      <p>
+        After configuring the Apache web server, you can restart it using
+      </p>
+      <source xml:space="preserve">$ sudo apachectl restart</source>
+    </section>
+    
+    <section>
+      <title>Configuring Tomcat's Cookie Path</title>
+      <note>
+        You'll certainly run into cookie problems when using a non-empty context path
+        (like <em>lenya14</em> in the example above) instead of running Lenya in the root context.
+        This causes errors like "The session doesn't contain the identity.".
+        To avoid these problems, edit <code>$TOMCAT_HOME/conf/server.xml</code> and set the
+        <em>emptySessionPath</em> attribute of the Tomcat connector configuration to <em>true</em>.
+        You find more information in the <a href="http://tomcat.apache.org/tomcat-6.0-doc/config/ajp.html">Apache
+        Tomcat configuration reference</a>.
+      </note>
+    </section>
+    
+    <section>
+      <title>Configuring the Publication for Proxying</title>
+      <p>
+        When you use a proxy, Lenya has to convert all internal links accordingly.
+        Therefore you have to tell the publication about the proxy configuration.
+        Open the file <code>pubs/default/config/publication.xml</code> and uncomment
+        and modify the <code><![CDATA[<proxy/>]]></code> elements:
+      </p>
+      <source xml:space="preserve"><![CDATA[<proxies>
+  <proxy ssl="false" area="authoring" url="http://cms.example.com"/>
+  <proxy ssl="false" area="live" url="http://www.example.com"/>
+  <proxy ssl="true" area="authoring" url="https://cms.example.com"/>
+  <proxy ssl="true" area="live" url="https://www.example.com"/>
+</proxies>]]></source>
+    </section>
+    
+    <section>
+      <title>Configuring the Global Proxies</title>
+      <p>
+        The application-wide (publication independent) proxies are configured in
+        <code>WEB-INF/cocoon.xconf</code>. Look for the declaration of the <code>GlobalProxies</code>
+        service and update this entry:
+      </p>
+      <source xml:space="preserve"><![CDATA[<component logger="lenya.proxy"
+    role="org.apache.lenya.cms.linking.GlobalProxies"
+    class="org.apache.lenya.cms.linking.impl.GlobalProxiesImpl">
+  <proxy ssl="false" url="http://cms.host.com"/>
+  <proxy ssl="true" url="https://cms.host.com"/>
+</component>]]></source>
+    </section>
+    
+    <section>
+      <title>Testing the Settings</title>
+      <p>
+        After re-deploying the publication and restarting your servlet container,
+        you should be able to access the
+        authoring environment of the default publication at the URL
+        <a href="http://cms.example.com/">http://cms.example.com/</a>.
+      </p>
+    </section>
+    
+  </body>
+</document>
\ No newline at end of file

Modified: lenya/docu/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/site.xml?rev=588631&r1=588630&r2=588631&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/site.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/site.xml Fri Oct 26 06:04:48 2007
@@ -151,7 +151,8 @@
         <usecaseTutorialPart2 href="part2.html" label="The Usecase"/>
       </usecaseTutorial>
       <setupide href="setupide/index.html" label="Setting up Eclipse"/>
-      <proxy label="Proxying">
+      <proxy label="Proxying" href="proxy/">
+        <proxying href="proxying.html" label="Proxying"/>
         <mod_proxy_14 href="proxy.html" label="mod_proxy"/>
         <mod_proxy_ajp href="mod_proxy_ajp.html" label="mod_proxy_ajp"/>
       </proxy>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org