7:33 p.m.
Author: chris.laprun(a)jboss.com
Date: 2007-10-11 20:33:50 -0400 (Thu, 11 Oct 2007)
New Revision: 8611
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
docs/trunk/referenceGuide/en/modules/configuration.xml
docs/trunk/referenceGuide/en/modules/installation.xml
Log:
- Minor content improvements.
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2007-10-12
00:33:46 UTC (rev 8610)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/configuration.xml 2007-10-12
00:33:50 UTC (rev 8611)
@@ -28,31 +28,25 @@
port manually. Since port forwarding is not always possible, below are the
instructions to change the port
number manually.
</para>
- <para>To change it, you need to edit the file
-
<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml</literal>
- and change the port value of the HTTP Connector. You can also change the value
of the SSL
- port, by default it is set to 8443. Remember to uncomment the following when you
have
- configured it:
- <programlisting>
- <![CDATA[
- <!-- SSL/TLS Connector configuration using the admin devl guide keystore
- <Connector port="8443" address="${jboss.bind.address}"
- maxThreads="100" strategy="ms"
maxHttpHeaderSize="8192"
- emptySessionPath="true"
- scheme="https" secure="true" clientAuth="false"
- keystoreFile="${jboss.server.home.dir}/conf/chap8.keystore"
- keystorePass="rmi+ssl" sslProtocol = "TLS" />
- -->
- ]]>
- </programlisting>
+ <para>To change it, you need to edit the file
<literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/server.xml</literal>
+
(<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml</literal>
on JBoss AS 4.0.x)
+ and change the port value of the HTTP Connector.
</para>
<para>
- Please refer to <xref linkend="wsrp-ports"/> to update the WSRP
after having changed the port.
+ You can also change the value of the SSL port, by default it is set to 8443. To
activate support for HTTPS,
+ please refer to the appropriate
+ <ulink
url="http://docs.jboss.org/jbossas/jboss4guide/r4/html/ch9.chapt.htm...
of the
+ JBoss AS guide. You might also want to refer to
+ <ulink
url="http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html">... SSL
configuration how-to</ulink>
+ for more details.
</para>
+ <para>
+ Please refer to <xref linkend="wsrp-ports"/> to update the WSRP
service after having changed the port.
+ </para>
<para>Now you can restart JBoss and use the new port that you defined. On
systems like Linux,
you need privileges to be able to run a server on a port lower than 1000,
starting JBoss on
- the port 80 as a regular user will not work, for testing you can log as root but
is not
- recommended if the server is public as it could be a security breach in your
system.
+ the port 80 as a regular user will not work. For testing purposes, you can start
JBoss AS as root but this
+ setup is not recommended if the server is public as it could lead to security
breaches of your system.
</para>
</sect1>
<sect1 id="configuration-contextroot">
@@ -65,9 +59,16 @@
.
</para>
<note>
- By default, Tomcat holds on to the root context '/'. You may need to
either remove the
-
<emphasis>$JBOSS_HOME\server\default\deploy\jbossweb-tomcat55.sar\ROOT.war</emphasis>
- or add a jboss-web.xml (declaring another context-root other than
'/')under its WEB-INFO directory for the below changes to take effect on restart.
+ By default, Tomcat holds on to the root context '/'. You may need to
either remove
+
<literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/ROOT.war</literal>
+
(<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/ROOT.war</literal>
on JBoss AS 4.0.x)
+ or add a <literal>jboss-web.xml</literal> file (declaring another
context-root other than '/') under
+ <literal>ROOT.war/WEB-INF</literal> directory for the below changes
to take effect on restart.
+ <programlisting><![CDATA[
+<?xml version="1.0"?>
+<jboss-web>
+ <context-root>/tomcat-root</context-root>
+</jboss-web>]]></programlisting>
</note>
<para>You can accomplish this, with either a deployed jboss-portal.sar or
before you build from source:
<itemizedlist>
@@ -134,79 +135,40 @@
<note>Under most common circumstances, the auto-detect feature should work
fine.</note>
</para>
<sect2>
- <title>DB Dialect settings for the portal core</title>
- <para>Modify
-
<emphasis>jboss-portal.sar/conf/hibernate/[module]/hibernate.cfg.xml</emphasis>
- . A list of supported dialects
- for Hibernate3, can be found
- <ulink
-
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
- >here
- </ulink>
- .
+ <title>DB Dialect settings for Portal</title>
+ <para>You will need to modify all the
<literal>hibernate.cfg.xml</literal> files in all the Portal modules you
+ intend to use by uncommenting the following line in these files and using the
appropriate dialect (see
+ <ulink
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
+ </ulink> for a list of supported dialects in Hibernate 3):
<programlisting><![CDATA[
-<?xml version='1.0' encoding='utf-8'?>
-<!DOCTYPE hibernate-configuration PUBLIC
-"-//Hibernate/Hibernate Configuration DTD//EN"
-"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
-<hibernate-configuration>
-<session-factory>
-<property name="connection.datasource">java:PortalDS</property>
-<property name="show_sql">false</property>
-<property
name="cache.provider_class">org.hibernate.cache.EhCacheProvider</property>
-<property name="cache.use_query_cache">true</property>
-
<!-- Force the dialect instead of using autodetection -->
<!--
<property
name="dialect">org.hibernate.dialect.PostgreSQLDialect</property>
--->
-
-<!-- Mapping files -->
-<mapping resource="conf/hibernate/user/domain.hbm.xml"/>
-</session-factory>
-</hibernate-configuration>
- ]]></programlisting>
+-->]]></programlisting>
</para>
+ <para>These files are found in
<literal>jboss-portal.sar/[module]/conf/hibernate/[directory]/hibernate.cfg.xml</literal>
+ where <literal>[module]</literal> is a module name and
<literal>[directory]</literal> is a directory that
+ may or may not be present.
+ </para>
</sect2>
<sect2>
<title>DB Dialect settings for the CMS component</title>
- <para>Modify
-
<emphasis>jboss-portal.sar/portal-cms.sar/conf/hibernate/cms/hibernate.cfg.xml</emphasis>
- . A list of supported dialects
- for Hibernate3, can be found
- <ulink
-
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
- >here
- </ulink>
- .
+ <para>Modify
<literal>jboss-portal.sar/portal-cms.sar/conf/hibernate/cms/hibernate.cfg.xml</literal>
by
+ uncommenting the following line in these files and using the appropriate
dialect (see
+ <ulink
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
+ </ulink> for a list of supported dialects in Hibernate 3):
<programlisting><![CDATA[
-<?xml version='1.0' encoding='utf-8'?>
-<!DOCTYPE hibernate-configuration PUBLIC
- "-//Hibernate/Hibernate Configuration DTD//EN"
- "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
-<hibernate-configuration>
- <session-factory>
- <property
name="connection.datasource">java:@portal.datasource.name@</property>
- <property name="show_sql">@portal.sql.show(a)</property>
- <property
name="cache.use_second_level_cache">false</property>
- <property name="cache.use_query_cache">true</property>
-
- <!-- Force the dialect instead of using autodetection -->
- <!--
- <property
name="dialect">org.hibernate.dialect.PostgreSQLDialect</property>
- -->
-
- <!-- Mapping files -->
- <mapping resource="conf/hibernate/cms/domain.hbm.xml"/>
- </session-factory>
-</hibernate-configuration>]]></programlisting>
+<!-- Force the dialect instead of using autodetection -->
+<!--
+<property
name="dialect">org.hibernate.dialect.PostgreSQLDialect</property>
+-->]]></programlisting>
</para>
</sect2>
</sect1>
<sect1 id="emailConfiguration">
<title>Setting up the email service</title>
<para>To be able to use the email service (for example to verify user emails
when someone subscribes or for CMS
- workflow notifications) it has to be configured correctly. To configure it, go to
+ workflow notifications) it has to be configured correctly. To configure it, go to
<literal>jboss-portal.sar/portal-core.sar/META-INF/jboss-service.xml</literal>.
In this file, the mail module is configured like this:
<programlisting><![CDATA[<mbean
@@ -226,9 +188,9 @@
<attribute name="SMTPTimeout">10000</attribute>
<attribute
name="JNDIName">java:portal/MailModule</attribute>
</mbean>]]></programlisting>
- Here you can specify a different SMTP server than localhost, then precise the
Smtp username and Smtp passwords to
- use to send the mails.</para>
- <para>If i wanted to use GMail smtp server, i would write:
+ Here you can specify a different SMTP server than localhost, then precise the
SMTP username and SMTP password to
+ use to send emails.</para>
+ <para>For example, to use GMail's SMTP server:
<programlisting><![CDATA[<mbean
code="org.jboss.portal.core.impl.mail.MailModuleImpl"
name="portal:service=Module,type=Mail"
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2007-10-12
00:33:46 UTC (rev 8610)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/installation.xml 2007-10-12
00:33:50 UTC (rev 8611)
@@ -17,11 +17,11 @@
<para>If you need to install JBoss Portal on JBoss AS 4.0.x, please refer
to the dedicated
<ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=Portal26_AS40">...
page</ulink>.</para>
</note>
-
+
</para>
<sect1 id="install_bundle">
<title>Installing from Bundled Download</title>
- <para>This is the easiest and fastest way to get JBoss Portal installed and
running. The reason, is that the
+ <para>This is the easiest and fastest way to get JBoss Portal installed and
running. The reason is that the
download bundle contains JBoss Application Server, and JBoss Portal uses the
embedded Hypersonic
Database.
</para>
@@ -104,11 +104,7 @@
subscription contract with Red Hat, can have access to the EAP
version from the <ulink
url="http://network.jboss.com/">support portal</ulink>.
For the other versions you can get them
- <ulink
-
url="http://labs.jboss.com/portal/jbossas/download/index.html"
- >here
- </ulink>
- .
+ <ulink
url="http://labs.jboss.com/portal/jbossas/download/index.html"&...
.
<warning>Make sure to download the JBoss AS Zip version.
<emphasis role="bold">DO NOT ATTEMPT to deploy JBoss
Portal on the installer version of JBoss
AS!
@@ -155,7 +151,8 @@
contains pre-configured datasource descriptors, you can use for most
popular RDBMS under the
<emphasis>setup</emphasis>
directory. For more details about the datasource descriptor or if your
database server is not part
- of the pre-built descriptors, please refer to: <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
dedicated wiki page.</ulink>
+ of the pre-built descriptors, please refer to
+ <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
dedicated wiki page.</ulink>
<mediaobject>
<imageobject>
<imagedata align="center" valign="middle"
fileref="images/setup/dsfiles.png"/>
@@ -568,4 +565,4 @@
</imageobject>
</mediaobject>
</para>
-</chapter>
+</chapter>
Modified: docs/trunk/referenceGuide/en/modules/configuration.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/configuration.xml 2007-10-12 00:33:46 UTC (rev
8610)
+++ docs/trunk/referenceGuide/en/modules/configuration.xml 2007-10-12 00:33:50 UTC (rev
8611)
@@ -28,31 +28,25 @@
port manually. Since port forwarding is not always possible, below are the
instructions to change the port
number manually.
</para>
- <para>To change it, you need to edit the file
-
<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml</literal>
- and change the port value of the HTTP Connector. You can also change the value
of the SSL
- port, by default it is set to 8443. Remember to uncomment the following when you
have
- configured it:
- <programlisting>
- <![CDATA[
- <!-- SSL/TLS Connector configuration using the admin devl guide keystore
- <Connector port="8443" address="${jboss.bind.address}"
- maxThreads="100" strategy="ms"
maxHttpHeaderSize="8192"
- emptySessionPath="true"
- scheme="https" secure="true" clientAuth="false"
- keystoreFile="${jboss.server.home.dir}/conf/chap8.keystore"
- keystorePass="rmi+ssl" sslProtocol = "TLS" />
- -->
- ]]>
- </programlisting>
+ <para>To change it, you need to edit the file
<literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/server.xml</literal>
+
(<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml</literal>
on JBoss AS 4.0.x)
+ and change the port value of the HTTP Connector.
</para>
<para>
- Please refer to <xref linkend="wsrp-ports"/> to update the WSRP
after having changed the port.
+ You can also change the value of the SSL port, by default it is set to 8443. To
activate support for HTTPS,
+ please refer to the appropriate
+ <ulink
url="http://docs.jboss.org/jbossas/jboss4guide/r4/html/ch9.chapt.htm...
of the
+ JBoss AS guide. You might also want to refer to
+ <ulink
url="http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html">... SSL
configuration how-to</ulink>
+ for more details.
</para>
+ <para>
+ Please refer to <xref linkend="wsrp-ports"/> to update the WSRP
service after having changed the port.
+ </para>
<para>Now you can restart JBoss and use the new port that you defined. On
systems like Linux,
you need privileges to be able to run a server on a port lower than 1000,
starting JBoss on
- the port 80 as a regular user will not work, for testing you can log as root but
is not
- recommended if the server is public as it could be a security breach in your
system.
+ the port 80 as a regular user will not work. For testing purposes, you can start
JBoss AS as root but this
+ setup is not recommended if the server is public as it could lead to security
breaches of your system.
</para>
</sect1>
<sect1 id="configuration-contextroot">
@@ -65,9 +59,16 @@
.
</para>
<note>
- By default, Tomcat holds on to the root context '/'. You may need to
either remove the
-
<emphasis>$JBOSS_HOME\server\default\deploy\jbossweb-tomcat55.sar\ROOT.war</emphasis>
- or add a jboss-web.xml (declaring another context-root other than
'/')under its WEB-INFO directory for the below changes to take effect on restart.
+ By default, Tomcat holds on to the root context '/'. You may need to
either remove
+
<literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/ROOT.war</literal>
+
(<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/ROOT.war</literal>
on JBoss AS 4.0.x)
+ or add a <literal>jboss-web.xml</literal> file (declaring another
context-root other than '/') under
+ <literal>ROOT.war/WEB-INF</literal> directory for the below changes
to take effect on restart.
+ <programlisting><![CDATA[
+<?xml version="1.0"?>
+<jboss-web>
+ <context-root>/tomcat-root</context-root>
+</jboss-web>]]></programlisting>
</note>
<para>You can accomplish this, with either a deployed jboss-portal.sar or
before you build from source:
<itemizedlist>
@@ -134,72 +135,33 @@
<note>Under most common circumstances, the auto-detect feature should work
fine.</note>
</para>
<sect2>
- <title>DB Dialect settings for the portal core</title>
- <para>Modify
-
<emphasis>jboss-portal.sar/conf/hibernate/[module]/hibernate.cfg.xml</emphasis>
- . A list of supported dialects
- for Hibernate3, can be found
- <ulink
-
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
- >here
- </ulink>
- .
+ <title>DB Dialect settings for Portal</title>
+ <para>You will need to modify all the
<literal>hibernate.cfg.xml</literal> files in all the Portal modules you
+ intend to use by uncommenting the following line in these files and using the
appropriate dialect (see
+ <ulink
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
+ </ulink> for a list of supported dialects in Hibernate 3):
<programlisting><![CDATA[
-<?xml version='1.0' encoding='utf-8'?>
-<!DOCTYPE hibernate-configuration PUBLIC
-"-//Hibernate/Hibernate Configuration DTD//EN"
-"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
-<hibernate-configuration>
-<session-factory>
-<property name="connection.datasource">java:PortalDS</property>
-<property name="show_sql">false</property>
-<property
name="cache.provider_class">org.hibernate.cache.EhCacheProvider</property>
-<property name="cache.use_query_cache">true</property>
-
<!-- Force the dialect instead of using autodetection -->
<!--
<property
name="dialect">org.hibernate.dialect.PostgreSQLDialect</property>
--->
-
-<!-- Mapping files -->
-<mapping resource="conf/hibernate/user/domain.hbm.xml"/>
-</session-factory>
-</hibernate-configuration>
- ]]></programlisting>
+-->]]></programlisting>
</para>
+ <para>These files are found in
<literal>jboss-portal.sar/[module]/conf/hibernate/[directory]/hibernate.cfg.xml</literal>
+ where <literal>[module]</literal> is a module name and
<literal>[directory]</literal> is a directory that
+ may or may not be present.
+ </para>
</sect2>
<sect2>
<title>DB Dialect settings for the CMS component</title>
- <para>Modify
-
<emphasis>jboss-portal.sar/portal-cms.sar/conf/hibernate/cms/hibernate.cfg.xml</emphasis>
- . A list of supported dialects
- for Hibernate3, can be found
- <ulink
-
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
- >here
- </ulink>
- .
+ <para>Modify
<literal>jboss-portal.sar/portal-cms.sar/conf/hibernate/cms/hibernate.cfg.xml</literal>
by
+ uncommenting the following line in these files and using the appropriate
dialect (see
+ <ulink
url="http://www.hibernate.org/hib_docs/v3/reference/en/html/session-...
+ </ulink> for a list of supported dialects in Hibernate 3):
<programlisting><![CDATA[
-<?xml version='1.0' encoding='utf-8'?>
-<!DOCTYPE hibernate-configuration PUBLIC
- "-//Hibernate/Hibernate Configuration DTD//EN"
- "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
-<hibernate-configuration>
- <session-factory>
- <property
name="connection.datasource">java:@portal.datasource.name@</property>
- <property name="show_sql">@portal.sql.show(a)</property>
- <property
name="cache.use_second_level_cache">false</property>
- <property name="cache.use_query_cache">true</property>
-
- <!-- Force the dialect instead of using autodetection -->
- <!--
- <property
name="dialect">org.hibernate.dialect.PostgreSQLDialect</property>
- -->
-
- <!-- Mapping files -->
- <mapping resource="conf/hibernate/cms/domain.hbm.xml"/>
- </session-factory>
-</hibernate-configuration>]]></programlisting>
+<!-- Force the dialect instead of using autodetection -->
+<!--
+<property
name="dialect">org.hibernate.dialect.PostgreSQLDialect</property>
+-->]]></programlisting>
</para>
</sect2>
</sect1>
@@ -226,9 +188,9 @@
<attribute name="SMTPTimeout">10000</attribute>
<attribute
name="JNDIName">java:portal/MailModule</attribute>
</mbean>]]></programlisting>
- Here you can specify a different SMTP server than localhost, then precise the
Smtp username and Smtp passwords to
- use to send the mails.</para>
- <para>If i wanted to use GMail smtp server, i would write:
+ Here you can specify a different SMTP server than localhost, then precise the
SMTP username and SMTP password to
+ use to send emails.</para>
+ <para>For example, to use GMail's SMTP server:
<programlisting><![CDATA[<mbean
code="org.jboss.portal.core.impl.mail.MailModuleImpl"
name="portal:service=Module,type=Mail"
Modified: docs/trunk/referenceGuide/en/modules/installation.xml
===================================================================
--- docs/trunk/referenceGuide/en/modules/installation.xml 2007-10-12 00:33:46 UTC (rev
8610)
+++ docs/trunk/referenceGuide/en/modules/installation.xml 2007-10-12 00:33:50 UTC (rev
8611)
@@ -21,7 +21,7 @@
</para>
<sect1 id="install_bundle">
<title>Installing from Bundled Download</title>
- <para>This is the easiest and fastest way to get JBoss Portal installed and
running. The reason, is that the
+ <para>This is the easiest and fastest way to get JBoss Portal installed and
running. The reason is that the
download bundle contains JBoss Application Server, and JBoss Portal uses the
embedded Hypersonic
Database.
</para>
@@ -104,11 +104,7 @@
subscription contract with Red Hat, can have access to the EAP
version from the <ulink
url="http://network.jboss.com/">support portal</ulink>.
For the other versions you can get them
- <ulink
-
url="http://labs.jboss.com/portal/jbossas/download/index.html"
- >here
- </ulink>
- .
+ <ulink
url="http://labs.jboss.com/portal/jbossas/download/index.html"&...
.
<warning>Make sure to download the JBoss AS Zip version.
<emphasis role="bold">DO NOT ATTEMPT to deploy JBoss
Portal on the installer version of JBoss
AS!
@@ -155,7 +151,8 @@
contains pre-configured datasource descriptors, you can use for most
popular RDBMS under the
<emphasis>setup</emphasis>
directory. For more details about the datasource descriptor or if your
database server is not part
- of the pre-built descriptors, please refer to: <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
dedicated wiki page.</ulink>
+ of the pre-built descriptors, please refer to
+ <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=CreateAJDBCDataSource&...
dedicated wiki page.</ulink>
<mediaobject>
<imageobject>
<imagedata align="center" valign="middle"
fileref="images/setup/dsfiles.png"/>