paulsp 01/09/28 22:17:57
Modified: xdocs config_guide.xml
xdocs/stylesheets project.xml
Log:
Add configuration guide
Revision Changes Path
1.3 +353 -19 jakarta-jetspeed/xdocs/config_guide.xml
Index: config_guide.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/config_guide.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- config_guide.xml 2001/09/06 14:15:53 1.2
+++ config_guide.xml 2001/09/29 05:17:57 1.3
@@ -1,26 +1,42 @@
<?xml version="1.0"?>
+
+<!--
+ Some sections are commeted out because the are not in the current
+ implemented of Jetspeed. Lets not confuse/frustrate the user to much :)
+-->
+
<document>
<properties>
<title>Site Configuration Guide</title>
<subtitle>Initial site configuration guidelines</subtitle>
<authors>
- <person name="Paul Spencer" email="[EMAIL PROTECTED]"/>
+ <person name="Paul Spencer" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
+ <section name='Status of this document'>
+ <p>
+ This document is very much a "Work in Progress". Although some sections
are incomplete, I hope what is here is helpful.
+ Comments and suggestions are welcome and encouraged. They can be set to <a
href="mailto:[EMAIL PROTECTED]";>
+ [EMAIL PROTECTED]</a>
+ </p>
+ </section>
<section name='General Configuration steps'>
<p>
The following steps are purely guide. Some steps are not required.
</p>
<ul>
<li><a href="install.html#Installation">Install Jetspeed</a></li>
+<!--
<li><a href="psml_db.html">Configure and build PSML database</a></li>
<li><a href="#Configure User Database">Configure and build user
database</a></li>
+-->
<li><a href="#Define portlets in local-portlets">Define portlets in
local-portlets</a></li>
<li><a href="#Define skins in local-skins.xreg">Define skins in
local-skins.xreg</a></li>
<li><a href="#Define local controls and controllers in
local-managers.xreg">Define local controls and controllers in
local-managers.xreg</a></li>
<li><a href="#Define content feeds">Define content feeds</a></li>
+ <li><a href="#Configure the layout and navigaton bars">Configure the layout
and navigaton bars</a></li>
<li><a href="#Configure default home page">Configure default home
page</a></li>
<li><a href="#Define users">Define users</a></li>
<li><a href="#Configure the admin and turbine users">Configure the admin
and turbine users</a></li>
@@ -31,79 +47,397 @@
<li><a href="#Backup and Test">Backup and Test</a></li>
</ul>
</section>
+<!--
<section name="Configure User Database">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
<p>
The user configuration can be stored in a database instead of text files.
Storing
user information in the database has the advantage of performance.
</p>
</section>
+-->
<section name="Define portlets in local-portlets">
- <p><center><strong>This section is incomplete</strong></center></p>
<p>
- Any site specific portlets should be define in
<jetspeed_home>/WEB-INF/conf/local-portlets.xreg.
+ Any site specific portlets should be define in
<tt><jetspeed_home>/WEB-INF/conf/local-portlets.xreg</tt>.
because this file will not be overwritten by upgrades.
</p>
- <p>See the <a href="catalog">Portlet Catalog</a> for portlet configuration
documentation.
+ <p>
+ See the <a href="catalog">Portlet Catalog</a> for portlet configuration
documentation.
</p>
</section>
<section name="Define skins in local-skins.xreg">
- <p><center><strong>This section is incomplete</strong></center></p>
<p>
- Any site specific skins should be define in
<jetspeed_home>/WEB-INF/conf/local-skins.xreg.
+ Any site specific skins should be define in
<tt><jetspeed_home>/WEB-INF/conf/local-skins.xreg</tt>.
because this file will not be overwritten by upgrades.
</p>
</section>
<section name="Define local controls and controllers in local-managers.xreg">
- <p><center><strong>This section is incomplete</strong></center></p>
<p>
- Any site speific controls and controllers should be define in
<jetspeed_home>/WEB-INF/conf/local-managers.xreg.
+ Any site specific controls and controllers should be define in
<tt><jetspeed_home>/WEB-INF/conf/local-managers.xreg</tt>.
because this file will not be overwritten by upgrades.
</p>
</section>
<section name="Define content feeds">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
+ <p>
+ </p>
+ </section>
+ <section name="Configure the layout and navigaton bars">
+ <p><center>This section is incomplete</center></p>
<p>
+ The look of Jetspeed's portal is controlled by the layout and nagivation
templates. Below are some of the
+ file that define that look.
</p>
+ <subsection name="Velocity Layout Manager - 1.3a2 default">
+ <ul>
+
<li><tt><jetspeed_home>/WEB-INF/template/vm/layouts/html/<i>language/country/</i>default.vm</tt></li>
+
<li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>top.vm</tt></li>
+
<li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>left.vm</tt></li>
+
<li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>bottom.vm</tt></li>
+ </ul>
+ </subsection>
+
+ <subsection name="JSP Layout Manager - 1.3a1 default">
+ <ul>
+
<li><tt><jetspeed_home>/WEB-INF/template/jsp/layouts/html/<i>language/country/</i>default.jsp</tt></li>
+
<li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>top.jsp</tt></li>
+
<li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>left.jsp</tt></li>
+
<li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>bottom/jsp</tt></li>
+ </ul>
+ </subsection>
</section>
<section name="Configure default home page">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
<p>
+ The default home page is stored in the
<tt><jetspeed_home>/WEB-INF/psml/anon</tt> directory. Currently this
+ is not directly configurable with the customizer. A suggested procedure is
to create a <i>HomePageUser</i>,
+ do the desired configuration as that user, then copy the resulting files to
the default home page.
</p>
</section>
<section name="Define users">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
<p>
</p>
</section>
<section name="Configure the admin and turbine users">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
<p>
+ <center><font size="+2"><strong>Change the
passwords!</strong></font></center>
</p>
</section>
<section name="Define default portal for new users">
- <p><center><strong>This section is incomplete</strong></center></p>
<p>
+ A new users home page is coppied from the user <tt>TURBINE</tt>. Thus you
should customized the <tt>TURBINE</tt>'s
+ user home page to refect the desired default home page for new users.
</p>
</section>
<section name="Set portlet caching and other refresh rates">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
<p>
</p>
</section>
<section name="Set Jetspeed logging">
- <p><center><strong>This section is incomplete</strong></center></p>
<p>
- </p>
+ Jetspeed utilizes the logging services provided by Turbine. The logfile(s)
are
+ a valuable tool in trouble shooting problems and monitoring the general
health of
+ Jetspeed an it's portlets.
+ </p>
+ <p>
+ The logging level should be set according the the current needs. DEBUG
logging is
+ suggested during portlet testing, while INFO logging is appropriate for
every-day
+ activity in a stable environment.
+ </p>
+ <p>
+ Not all of Turbine's logging services are included. Additional
documentation can
+ be found at <a
href="http://jakarta.apache.org/turbine";>http://jakarta.apache.org/turbine</a>.
+ </p>
+ <table>
+ <tr>
+ <th>Facility</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>rotation</td>
+ <td>
+ Rotation of log files. This will limit the amount of disk space
+ consumed by the log file. Not supported by all loggers.
+ </td>
+ </tr>
+ <tr>
+ <td>schedule</td>
+ <td>
+ A facility for the scheduler service
+ To disable started/stopped messages set the level to ERROR
+ </td>
+ </tr>
+ <tr>
+ <td>security</td>
+ <td>
+ A facility for security audit. NOTE! As of 23 Jan 2001
+ Turbine does not have any standard security auditing
+ functionality. It's up to your application.
+ </td>
+ </tr>
+ <tr>
+ <td>system</td>
+ <td>A facility for system logging.</td>
+ </tr>
+ <tr>
+ <td>sql</td>
+ <td>
+ A facility for SQL query logging
+ To enable SQL query logging, set the level to DEBUG
+ </td>
+ </tr>
+ </table>
+ <subsection name="FileLogger">
+ <p>
+ This is a logging service provide with Turbine.
+ </p>
+ <p>
+ Additional information can be found at <a
href="http://jakarta.apache.org/turbine";>
+ http://jakarta.apache.org/turbine</a>
+ </p>
+ <table>
+ <tr>
+ <th>Facility</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>destination.file</td>
+ <td>Name of the log file relative to <jetspeed-home></td>
+ </tr>
+ <tr>
+ <td>className</td>
+ <td>org.apache.turbine.services.logging.FileLogger</td>
+ </tr>
+ <tr>
+ <td>level</td>
+ <td>
+ <table>
+ <tr>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>FATAL</td>
+ <td>Designates very severe error events that will presumably lead
the application to abort.</td>
+ </tr>
+ <tr>
+ <td>ERROR</td>
+ <td>Designates error events that might still allow the
application to continue running</td>
+ </tr>
+ <tr>
+ <td>WARN</td>
+ <td>Designates potentially harmful situations</td>
+ </tr>
+ <tr>
+ <td>INFO</td>
+ <td>Designates informational messages that highlight the progress
of the application at coarse-grained level.</td>
+ </tr>
+ <tr>
+ <td>DEBUG</td>
+ <td>Designates fine-grained informational events that are most
useful to debug an application</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td>destination.console</td>
+ <td>Optional, default = false <br/>
+ <table>
+ <tr>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>false</td>
+ <td>message will NOT be sent to the console</td>
+ </tr>
+ <tr>
+ <td>true</td>
+ <td>message will ALSO be sent to the console</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td></td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Log4JavaLoggger">
+ <p>
+ This is a more functional logging service that can interact with
operating specific
+ facilities like UNIX's syslog and Window's Event Logger
+ </p>
+ <p>
+ Additional information can be found at <a
href="http://jakarta.apache.org/log4j";>
+ http://jakarta.apache.org/log4j</a> and <a
href="http://jakarta.apache.org/turbine";>
+ http://jakarta.apache.org/turbine</a>
+ </p>
+ <p>
+ Configuration notes:
+ <ul>
+ <li>
+ All loggers define in <tt>services.LoggingService.facilities</tt>
must
+ be the same type when using the Log4J services.
+ </li>
+ <li>
+ When using log file rotation, the rotation facility must be the first
in the
+ <tt>services.LoggingService.facilities</tt> list.
+ </li>
+ </ul>
+ </p>
+ <table>
+ <tr>
+ <th>Facility</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>destination.file</td>
+ <td>Name of the log file relative to <jetspeed-home></td>
+ </tr>
+ <tr>
+ <td>className</td>
+ <td>org.apache.turbine.services.logging.Log4JavaLogger</td>
+ </tr>
+ <tr>
+ <td>level</td>
+ <td>
+ <table>
+ <tr>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>FATAL</td>
+ <td>Designates very severe error events that will presumably lead
the application to abort.</td>
+ </tr>
+ <tr>
+ <td>ERROR</td>
+ <td>Designates error events that might still allow the
application to continue running</td>
+ </tr>
+ <tr>
+ <td>WARN</td>
+ <td>Designates potentially harmful situations</td>
+ </tr>
+ <tr>
+ <td>INFO</td>
+ <td>Designates informational messages that highlight the progress
of the application at coarse-grained level.</td>
+ </tr>
+ <tr>
+ <td>DEBUG</td>
+ <td>Designates fine-grained informational events that are most
useful to debug an application</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td>destination.console</td>
+ <td>Optional, default = false <br/>
+ <table>
+ <tr>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>false</td>
+ <td>message will NOT be sent to the console</td>
+ </tr>
+ <tr>
+ <td>true</td>
+ <td>message will ALSO be sent to the console</td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td>file.size</td>
+ <td>Approximate log file size in bytes. 1MB = 1048576 bytes</td>
+ </tr>
+ <tr>
+ <td>file.backups</td>
+ <td>
+ Number of backup log files to maintain. The actual number of log
files
+ will be file.backups + 1.
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Example configuration">
+ <p>
+ The following confuration will rotate the logging among 6 files. All
logging
+ will be at the DEBUG level.
+ </p>
+<source>
+# -------------------------------------------------------------------
+#
+# L O G S
+#
+# -------------------------------------------------------------------
+# This is the configuration for the logging system. In most cases
+# you don't need to modify anything. However, if you wish to add more
+# facilities or modify the existing settings, then you can do so.
+#
+# destination.file: A path relative to the web app root
+# -------------------------------------------------------------------
+services.LoggingService.facilities=rotation,system,debug
+services.LoggingService.default=rotation
+services.LoggingService.loggingConfig=org.apache.turbine.services.logging.PropertiesLoggingConfig
+
+# A facility for system logging.
+services.LoggingService.system.destination.file=/WEB-INF/log/jetspeed.log
+services.LoggingService.system.className=org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.system.level=DEBUG
+
+# A facility for the scheduler service
+# To disable started/stopped messages set the level to ERROR
+services.LoggingService.scheduler.destination.file=/WEB-INF/log/jetspeed.log
+services.LoggingService.scheduler.className=org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.scheduler.level=DEBUG
+
+# A facility for debugging applications. Messages will go both
+# to the log file and the server console.
+services.LoggingService.debug.destination.file=/WEB-INF/log/jetspeed.log
+services.LoggingService.debug.destination.console=true
+services.LoggingService.debug.className=org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.debug.level=DEBUG
+
+# A facility for SQL query logging
+# To enable SQL query logging, set the level to DEBUG
+services.LoggingService.sql.destination.file=/WEB-INF/log/jetspeed.log
+services.LoggingService.sql.className=org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.sql.level=DEBUG
+
+# A facility for security audit. NOTE! As of 23 Jan 2001
+# Turbine does not have any standard security auditing
+# functionality. It's up to your application.
+services.LoggingService.security.destination.file=/WEB-INF/log/jetspeed.log
+services.LoggingService.security.className=org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.security.level=DEBUG
+
+# An example configuration for automatic log rotation using Log4Java
+# This will keep the log file size under 1MB and save up to 5 backup copies
+services.LoggingService.rotation.destination.file=/WEB-INF/log/jetspeed.log
+services.LoggingService.rotation.file.size=1048576
+services.LoggingService.rotation.file.backups=5
+services.LoggingService.rotation.className=org.apache.turbine.services.logging.Log4JavaLogger
+services.LoggingService.rotation.level=DEBUG
+
+</source>
+ </subsection>
</section>
<section name="Enable e-mail confirmation">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
<p>
</p>
</section>
<section name="Backup and Test">
- <p><center><strong>This section is incomplete</strong></center></p>
+ <p><center>This section is incomplete</center></p>
<p>
+ Backup early and often!
</p>
</section>
</body>
1.9 +3 -0 jakarta-jetspeed/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/stylesheets/project.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- project.xml 2001/07/23 04:41:02 1.8
+++ project.xml 2001/09/29 05:17:57 1.9
@@ -24,6 +24,7 @@
<item name="Coding Spec" href="/code-standards.html"/>
</menu>
<menu name="Documentation">
+ <item name="Configuration Guide" href="/config_guide.html"/>
<item name="Javadoc"
href="http://www.bluesunrise.com/jetspeed-docs/javadocs/"/>
<item name="Development" href="/application-development.html"/>
<item name="Portlet Howto"
href="http://www.bluesunrise.com/jetspeed-docs/PortletHowTo.htm"/>
@@ -36,7 +37,9 @@
<item name="Customization" href="/customizer.html"/>
<item name="Cache" href="/diskcache.html"/>
<item name="PSML" href="/psml.html"/>
+<!--
<item name="iCalendar" href="/icalendar.html"/>
+-->
</menu>
</body>
</project>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
