[pal-cvs 3421] [1155] added config doc.

svnno****@sourc***** svnno****@sourc*****
2008年 9月 11日 (木) 15:33:34 JST


Revision: 1155
          http://svn.sourceforge.jp/cgi-bin/viewcvs.cgi?root=pal&view=rev&rev=1155
Author:   shinsuke
Date:     2008-09-11 15:33:34 +0900 (Thu, 11 Sep 2008)

Log Message:
-----------
added config doc.

Added Paths:
-----------
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/guide.xml
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/log.xml
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/port.xml
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/properties.xml


-------------- next part --------------
Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/guide.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/guide.xml	                        (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/guide.xml	2008-09-11 06:33:34 UTC (rev 1155)
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <title>設定</title>
+    <subtitle>概要</subtitle>
+    <authors>
+      <person name="菅谷信介" email="shins****@yahoo*****"/>
+    </authors>
+  </properties>
+  <body>
+    <section name="設定概要">
+      <p>
+ポータルの設定に関する情報は、<code>webapps/palportal/WEB-INF</code> 以下の様々なファイルに保存されています。
+ポータルの機能をカスタマイズしていくためには、対象のファイルの設定値を変更することで、変更することができます。
+      </p>
+      <p>
+基本的な設定情報は、<code>webapps/palportal/WEB-INF/conf</code> のプロパティファイル内に定義されています。
+また、PALポータルは、コンポーネントアーキテクチャにより構築されているので、コンポーネントの構成データに関しては、Spring の設定ファイルとして記述されています。それらのファイルは、<code>webapps/palportal/WEB-INF/assembly</code> に保存されています。
+      </p>
+    </section>
+  </body>
+</document>


Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/guide.xml
___________________________________________________________________
Name: svn:eol-style
   + native

Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/log.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/log.xml	                        (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/log.xml	2008-09-11 06:33:34 UTC (rev 1155)
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <title>設定</title>
+    <subtitle>ログの設定</subtitle>
+    <authors>
+      <person name="菅谷信介" email="shins****@yahoo*****"/>
+    </authors>
+  </properties>
+  <body>
+    <section name="ログの設定について">
+      <p>
+PALポータルは、Log4j を利用して、ログの制御を行っています。
+ログの設定ファイルは、<code>webapps/palportal/WEB-INF/conf/Log4j.properties</code> に記述されています。
+そこで指定されている値を変更することで、ログファイルの保存先を変更したり、出力するログレベルを変更することができます。
+      </p>
+    </section>
+    <section name="設定ファイル">
+      <p>
+<code>Log4j.properties</code> のデフォルトの設定は以下の通りです(一部略)。
+      </p>
+<source><![CDATA[
+# ------------------------------------------------------------------------
+#
+# Logging Configuration
+#
+# ------------------------------------------------------------------------
+
+# If we don't know the logging facility, put it into the jetspeed.log
+log4j.rootLogger = ERROR, jetspeed
+
+# Jetspeed goes into Jetspeed Log
+log4j.category.org.apache.jetspeed = ERROR, jetspeed
+log4j.additivity.org.apache.jetspeed = false
+
+
+log4j.category.org.apache.jetspeed.tools = ERROR, jetspeed
+log4j.additivity.org.apache.jetspeed.tools = false
+
+
+# Velocity Logfile
+log4j.category.velocity = ERROR, velocity
+log4j.additivity.velocity = false
+
+# Deployment Category
+log4j.category.deployment = ERROR, DEPLOYMENT
+log4j.additivity.deployment = false
+
+
+########################################################################
+#
+# Logfile definitions
+#
+########################################################################
+
+# jetspeed.log
+log4j.appender.jetspeed = org.apache.log4j.RollingFileAppender
+log4j.appender.jetspeed.File = ${applicationRoot}/WEB-INF/logs/jetspeed.log
+log4j.appender.jetspeed.layout = org.apache.log4j.PatternLayout
+log4j.appender.jetspeed.layout.ConversionPattern = %d [%t] %-5p %c - %m%n
+log4j.appender.jetspeed.Append = true
+log4j.appender.jetspeed.MaxFileSize = 10MB
+log4j.appender.jetspeed.MaxBackupIndex = 5
+
+# deployment.log
+log4j.appender.DEPLOYMENT = org.apache.log4j.RollingFileAppender
+log4j.appender.DEPLOYMENT.File = ${applicationRoot}/WEB-INF/logs/deployment.log
+log4j.appender.DEPLOYMENT.layout = org.apache.log4j.PatternLayout
+log4j.appender.DEPLOYMENT.layout.ConversionPattern = %d [%t] %-5p %c - %m%n
+log4j.appender.DEPLOYMENT.Append = true
+log4j.appender.DEPLOYMENT.MaxFileSize = 10MB
+log4j.appender.DEPLOYMENT.MaxBackupIndex = 5
+
+# Velocity gets configured to write its output onto the velocity category.
+log4j.appender.velocity = org.apache.log4j.RollingFileAppender
+log4j.appender.velocity.File = ${applicationRoot}/WEB-INF/logs/velocity.log
+log4j.appender.velocity.layout = org.apache.log4j.PatternLayout
+log4j.appender.velocity.layout.ConversionPattern = %d [%t] %-5p %c - %m%n
+log4j.appender.velocity.Append = true
+log4j.appender.velocity.MaxFileSize = 10MB
+log4j.appender.velocity.MaxBackupIndex = 5
+
+]]></source>
+      <p>
+デフォルトのログレベルは ERROR に設定されています。
+出力されるログファイルの保存先は、<code>webapps/palportal/WEB-INF/logs</code> に保存されます。
+ログファイルの内容は、PALポータルを再起動しても保存されたままで、ログを追記します。
+各ログファイルのファイルサイズは、10MB まで保存し、それ以上のサイズになった場合は &lt;ファイル名&gt;.&lt;数字&gt; として保存され、最大 5 つまで保持します。
+それ以上になった場合は古いものから削除されます。
+      </p>
+      <subsection name="jetspeed.log">
+        <p>
+<code>jetspeed.log</code> は、PALポータルの処理中に出力するログが保存されます。
+        </p>
+      </subsection>
+      <subsection name="deployment.log">
+        <p>
+<code>deployment.log</code> は、PALポータルにポートレットを配備の処理中に出力するログが保存されます。
+        </p>
+      </subsection>
+      <subsection name="velocity.log">
+        <p>
+<code>velocity.log</code> は、レイアウトデコレータやポートレットデコレータなどで Velocity の処理中に出力するログが保存されます。
+        </p>
+      </subsection>
+    </section>
+    <section name="ログレベルの変更">
+      <p>
+<code>Log4j.properties</code> で、対象ログの log4j.category.* プロパティで設定します。
+デフォルトでは ERROR が設定されているので、この値を DEBUG などに変更すると、ログレベルがデバッグになります。
+利用可能なログレベルは以下の通りです。
+<ul>
+<li>DEBUG: アプリケーションのデバッグ用のログを出力する。以下のログレベルで指定したものは出力される。</li>
+<li>INFO: アプリケーションの必要な情報を出力する用などのログを出力する。以下のログレベルで指定したものは出力される。</li>
+<li>WARN: 警告メッセージなどの情報を出力するログレベル。以下のログレベルで指定したものは出力される。</li>
+<li>ERROR: エラーメッセージなどの情報を出力するログレベル。以下のログレベルで指定したものは出力される。</li>
+<li>FATAL: 致命的なエラーメッセージを表示するログレベル。</li>
+</ul>
+値を変更後ポータルを再起動することで変更が有効になります。
+      </p>
+    </section>
+    <section name="保存先の変更">
+      <p>
+各ログファイルの保存先を変更することができます。
+<code>Log4j.properties</code> で、対象ログの log4j.appender.*.File プロパティで設定します。
+${applicationRoot} は PALポータルのルートディレクトリである <code>webapps/palportal</code> を示しています。
+値を変更後ポータルを再起動することで変更が有効になります。
+      </p>
+    </section>
+  </body>
+</document>


Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/log.xml
___________________________________________________________________
Name: svn:eol-style
   + native

Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/port.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/port.xml	                        (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/port.xml	2008-09-11 06:33:34 UTC (rev 1155)
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <title>設定</title>
+    <subtitle>ポートの変更</subtitle>
+    <authors>
+      <person name="菅谷信介" email="shins****@yahoo*****"/>
+    </authors>
+  </properties>
+  <body>
+    <section name="ポートの変更について">
+      <p>
+PALポータルは、標準で Tomcat 5.5 をバンドルして利用しています。
+そのため、PALポータルへのアクセスポートを変更するためには、Tomcat のリクエスト受信ポートを変更する必要があります。
+      </p>
+      <p>
+PALポータルを Tomcat 以外のアプリケーションサーバーで動作させる場合は、アクセスポートの変更方法はそのアプリケーションサーバーの設定方法に従います。
+      </p>
+    </section>
+    <section name="受信ポートの変更">
+      <p>
+デフォルトの受信ポートは、8080 を利用しています。
+受信ポートを変更する場合は、<code>conf/server.xml</code> の以下の 8080 を利用したいポート番号に変更します。
+      </p>
+<source><![CDATA[
+    <Connector port="8080" maxHttpHeaderSize="8192"
+               emptySessionPath="true"
+               maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
+               enableLookups="false" redirectPort="8443" acceptCount="100"
+               connectionTimeout="20000" disableUploadTimeout="true" />
+]]></source>
+      <p>
+値を変更後、設定を保存し、ポータルを再起動後に有効になります。
+      </p>
+    </section>
+    <section name="停止ポートの変更">
+      <p>
+PALポータルを同じサーバー上などで同時に複数上げたい場合、受信ポート以外に停止ポートも変更する必要があります。
+停止ポートを変更する場合は、<code>conf/server.xml</code> の以下の 8005 を利用したいポート番号に変更します。
+      </p>
+<source><![CDATA[
+<Server port="8005" shutdown="SHUTDOWN">
+]]></source>
+      <p>
+値を変更後、設定を保存し、ポータルを再起動後に有効になります。
+      </p>
+    </section>
+  </body>
+</document>


Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/port.xml
___________________________________________________________________
Name: svn:eol-style
   + native

Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/properties.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/properties.xml	                        (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/properties.xml	2008-09-11 06:33:34 UTC (rev 1155)
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+  <properties>
+    <title>設定</title>
+    <subtitle>基本設定</subtitle>
+    <authors>
+      <person name="菅谷信介" email="shins****@yahoo*****"/>
+    </authors>
+  </properties>
+  <body>
+    <section name="基本設定情報について">
+      <p>
+PALポータルの基本的な設定情報は、<code>webapps/palportal/WEB-INF/conf</code> に保存されています。
+ベースとなる設定情報は、<code>jetspeed.properties</code> に保存されています。
+これらの設定値を変更したい場合は、<code>override.properties</code> に定義して、<code>jetspeed.properties</code> の設定情報を上書きします。
+      </p>
+    </section>
+  </body>
+</document>


Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/config/properties.xml
___________________________________________________________________
Name: svn:eol-style
   + native


pal-cvs メーリングリストの案内