You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@roller.apache.org by sn...@apache.org on 2006/05/03 22:43:09 UTC
svn commit: r399422 - in /incubator/roller/trunk: ./ docs/installguide/
docs/installguide/generated/
Author: snoopdave
Date: Wed May 3 13:43:07 2006
New Revision: 399422
URL: http://svn.apache.org/viewcvs?rev=399422&view=rev
Log:
Updating docs for 2.3 release
Modified:
incubator/roller/trunk/CHANGES.txt
incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html
incubator/roller/trunk/docs/installguide/generated/roller-install-guide.pdf
incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt
incubator/roller/trunk/docs/installguide/roller-install-guide.odt
Modified: incubator/roller/trunk/CHANGES.txt
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/CHANGES.txt?rev=399422&r1=399421&r2=399422&view=diff
==============================================================================
--- incubator/roller/trunk/CHANGES.txt (original)
+++ incubator/roller/trunk/CHANGES.txt Wed May 3 13:43:07 2006
@@ -2,7 +2,21 @@
ROLLER CHANGE LOG
-----------------
-Roller 2.2 release: improvements and bug fixes, no major new features
+Roller 2.3: improvements and bug fixes, no major new features
+
+ * [ROL-872] - Support for both entry summary and content
+ * [ROL-1079] - Slight modification on the file upload confirmation message
+ * [ROL-1102] - NPE in CommentServlet.doGet(CommentServlet.java:52)
+ * [ROL-1115] - Make it possible to require comment moderation for all weblogs
+ * [ROL-1116] - Make it possible to set default weblog editor
+ * [ROL-980] - Change to org.apache.roller packaging
+ * [ROL-982] - Add Apache license text to all source files
+ * [ROL-1111] - Backend Refactorings
+
+
+-------------------------------------------------------------------------------
+
+Roller 2.2: (not a public release) improvements and bug fixes, no major new features
Improvement
* [ROL-995] - Limit comments to safe HTML subset only
Modified: incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html?rev=399422&r1=399421&r2=399422&view=diff
==============================================================================
--- incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html (original)
+++ incubator/roller/trunk/docs/installguide/generated/roller-install-guide.html Wed May 3 13:43:07 2006
@@ -7,7 +7,7 @@
<META NAME="AUTHOR" CONTENT="Dave Johnson">
<META NAME="CREATED" CONTENT="20060123;11164600">
<META NAME="CHANGEDBY" CONTENT="Dave Johnson">
- <META NAME="CHANGED" CONTENT="20060501;14392900">
+ <META NAME="CHANGED" CONTENT="20060503;16394400">
<STYLE>
<!--
@page { size: 8.5in 11in; margin: 0.79in }
@@ -87,57 +87,71 @@
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
2: Unpack the Roller distribution 5</B></FONT></P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
- 3: Create Roller tables in your database 6</B></FONT></P>
- <P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
- 4: Install required third party jars 7</B></FONT></P>
- <P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 4.1: Install
- JDBC driver jar(s) 7</P>
+ 3: Install required third party jars 6</B></FONT></P>
+ <P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 4.1:
+ Download and install Hibernate 6</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 4.2: Install
+ JDBC driver jar(s) 6</P>
+ <P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 4.3: Install
JavaMail and Activation jars 7</P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
- 5: Deploy Roller to your application server 8</B></FONT></P>
+ 4: Create Roller tables in your database 8</B></FONT></P>
+ <P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
+ 5: Deploy Roller to your application server 9</B></FONT></P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
- 6: Check your internationalization settings 10</B></FONT></P>
+ 6: Check your internationalization settings 11</B></FONT></P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
- 7: Setup Roller data directories 11</B></FONT></P>
+ 7: Setup Roller data directories 12</B></FONT></P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 7.1: Create
- uploads directory 11</P>
+ uploads directory 12</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 7.2: Create
- search-index directory 11</P>
+ search-index directory 12</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 7.3: Create
- planet-cache directory (optional) 11</P>
+ planet-cache directory (optional) 12</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 7.4: Make
- sure that the logs subdirectory exists 12</P>
+ sure that the logs subdirectory exists 13</P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
- 8: Review Roller configuration 13</B></FONT></P>
+ 8: Review Roller configuration 14</B></FONT></P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 8.1: Review
- the WEB-INF/classes/roller.properties file 13</P>
+ the WEB-INF/classes/roller.properties file 14</P>
<P STYLE="margin-left: 0.59in; margin-bottom: 0in">Where to define
- custom properties 13</P>
+ custom properties 14</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 8.2: Change
- keys in the WEB-INF/security.xml file 14</P>
+ keys in the WEB-INF/security.xml file 15</P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>STEP
- 9: Start Tomcat and start using Roller 15</B></FONT></P>
+ 9: Start Tomcat and start using Roller 16</B></FONT></P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>Appendix
- A: Upgrading an existing Roller installation 16</B></FONT></P>
+ A: Upgrading an existing Roller installation 17</B></FONT></P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 1: Shutdown
- and backup your old Roller [#1] 16</P>
+ and backup your old Roller [#1] 17</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 2: Install
- the new Roller [#2] 16</P>
+ the new Roller [#2] 17</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 3: Copy
- resources and update configs [#3] 17</P>
+ resources and update configs [#3] 18</P>
<P STYLE="margin-left: 0.59in; margin-bottom: 0in">3.1 Copy your old
- resources and other files you've added 17</P>
+ resources and other files you've added 18</P>
<P STYLE="margin-left: 0.59in; margin-bottom: 0in">3.2 Remove
- JavaMail jars if duplicated 17</P>
+ JavaMail jars if duplicated 18</P>
<P STYLE="margin-left: 0.59in; margin-bottom: 0in">3.3 Review
- configuration properties 17</P>
+ configuration properties 18</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 4: Upgrade
- the database [#4] 17</P>
+ the database [#4] 18</P>
<P STYLE="margin-left: 0.39in; margin-bottom: 0in">STEP 5: Startup
- your app server [#5] 18</P>
+ your app server [#5] 19</P>
+ <P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>Appendix
+ B: The WEB-INF/roller.properties file 20</B></FONT></P>
<P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>Appendix
- B: The WEB-INF/roller.properties file 19</B></FONT></P>
+ C: Setting up the optional JSPWiki plugin 27</B></FONT></P>
+ <P STYLE="margin-left: 0.39in; margin-bottom: 0in">Downloading and
+ installing the required JSPWiki jars 27</P>
+ <P STYLE="margin-left: 0.39in; margin-bottom: 0in">Enable the
+ JSPWiki plugin via Roller property override 27</P>
+ <P STYLE="margin-left: 0.2in; margin-bottom: 0in"><FONT SIZE=4 STYLE="font-size: 16pt"><B>Appendix
+ D: Setting up the optional Ekit editor page 28</B></FONT></P>
+ <P STYLE="margin-left: 0.39in; margin-bottom: 0in">Downloading and
+ installing the required Ekit applet jar 28</P>
+ <P STYLE="margin-left: 0.39in; margin-bottom: 0in">Enable the Ekit
+ plugin via Roller runtime configuration definitions file 28</P>
</DIV>
<P STYLE="margin-bottom: 0in"><BR>
</P>
@@ -199,18 +213,17 @@
your Tomcat installation.</P>
<P>For UNIX with bash shell:</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2> %
-export CATALINA_HOME=/opt/jakarta-tomcat-5.0.29</FONT></FONT></P>
+export CATALINA_HOME=/opt/jakarta-tomcat-5.5.9</FONT></FONT></P>
<P><BR><BR>
</P>
<P>For UNIX with c-shell:</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2> %
-setenv CATALINA_HOME /opt/jakarta-tomcat-5.0.29</FONT></FONT></P>
+setenv CATALINA_HOME /opt/jakarta-tomcat-5.5.9</FONT></FONT></P>
<P><BR><BR>
</P>
<P>For Windows with DOS shell</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2> C>
-set CATALINA_HOME d:\jakarta-tomcat-5.0.29 </FONT></FONT>
-</P>
+set CATALINA_HOME d:\jakarta-tomcat-5.5.9</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P><B>NOTES</B></P>
@@ -250,17 +263,19 @@
<P><B>Windows example</B></P>
<P>Use WinZip to extract the Roller distribution file into the
directory of your choice for example, no example necessary.</P>
-<H3>Download required jars
-</H3>
+<H3><A NAME="DDE_LINK3"></A></H3>
+<H2></H2>
+<H2 STYLE="page-break-before: always"><A NAME="section-InstallationGuide_2.x-STEP4DownloadAndInstallRequiredJars4"></A>
+STEP 3: Install required third party jars</H2>
+<P>You also need to download and install some third-party jars, jars
+that we can't include in Roller due to licensing restrictions. These
+are the JDBC driver, JavaMail and Activation jars.</P>
+<H3>STEP 4.1: Download and install Hibernate</H3>
<P>Roller <I>requires</I> the Hibernate persistence library, which
you must download separately from Roller.
</P>
-<P><BR><BR>
-</P>
<P> Download Hibernate 3.1.2 from SourceForge</P>
<P> <A HREF="http://prdownloads.sourceforge.net/hibernate/hibernate-3.1.2.tar.gz">http://prdownloads.sourceforge.net/hibernate/hibernate-3.1.2.tar.gz</A></P>
-<P><BR><BR>
-</P>
<P>Copy the following files from Hibernate into the Roller
WEB-INF/lib directory:</P>
<UL>
@@ -275,22 +290,62 @@
<LI><P>jdbc2_0-stdext.jar</P>
<LI><P>jta.jar</P>
</UL>
-<P><BR><BR>
-</P>
<P>The Roller Support project at Java.Net offers some required jar
-bundles that might make installation easier. Visit
+bundles that might make this part of the installation easier. Visit
<A HREF="http://roller.dev.java.net/">http://roller.dev.java.net</A>
for more information.</P>
-<P><BR><BR>
+<H3>STEP 4.2: Install JDBC driver jar(s)</H3>
+<P>Download the JDBC driver jar for your database and put it in the
+classpath of your application server. For example, assuming Tomcat
+and MySQL, you'd download the J/Connector JDBC driver from mysql.com
+and you'd place it in the Tomcat <FONT FACE="Courier New">common/lib</FONT>
+directory.</P>
+<P><B>UNIX example</B></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2> %
+cp mysql-connector.jar $CATALINA_HOME/common/lib</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
</P>
-<P><BR><BR>
+<P><B>Windows example</B></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2> C>
+copy mysql-connector.jar %CATALINA_HOME%\common\lib</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
</P>
+<P><B>NOTES</B></P>
+<UL>
+ <LI><P STYLE="margin-bottom: 0in">For MySQL 4.1.X users, we
+ recommend that you use the J/Connector 3.0.X JDBC drivers instead of
+ the newer 3.1.X series. If you <I>must</I> use J/Connector/J 3.1.X
+ then please read <I>Installation FAQ</I> page item #13 on the Roller
+ wiki.</P>
+</UL>
<P><BR><BR>
</P>
-<P STYLE="margin-bottom: 0in"><BR>
-</P>
+<H3>STEP 4.3: Install JavaMail and Activation jars</H3>
+<P>If you like to use Roller's e-mail notification features, you'll
+need to add the JavaMail and Activation jars to your application
+server's classpath. Currently, we ship these jars with Roller, but
+you will need to <B>move</B> them from the Roller <FONT FACE="Courier New">WEB-INF/lib</FONT>
+directory and into the Tomcat <FONT FACE="Courier New">common/lib</FONT>
+directory, or your server's equivalent location.</P>
+<P><B>UNIX example</B></P>
+<P><FONT FACE="Courier New"><FONT SIZE=2> % mv
+$ROLLER/WEB-INF/lib/mail.jar $CATALINA_HOME/common/lib</FONT></FONT></P>
+<P><FONT SIZE=2><FONT FACE="Courier New"> % mv
+$ROLLER/WEB-INF/lib/activation.jar $CATALINA_HOME/common/lib</FONT> </FONT></P>
+<P><B>Windows example</B></P>
+<P><FONT FACE="Courier New"><FONT SIZE=2> c> move
+%ROLLER%\WEB-INF\lib\mail.jar %CATALINA_HOME%\common\lib</FONT></FONT></P>
+<P><FONT FACE="Courier New"><FONT SIZE=2> C> move
+%ROLLER%\WEB-INF\lib\activation.jar %CATALINA_HOME%\common\lib</FONT></FONT></P>
+<P><B>NOTES</B></P>
+<UL>
+ <LI><P>To enable the Roller's e-mail notification features, you'll
+ also need to setup a mail session resource in your application
+ server configuration file (see the next section) and you'll need to
+ configure e-mail notification in the Roller UI.</P>
+</UL>
<H2 STYLE="page-break-before: always"><A NAME="section-InstallationGuide_2.x-STEP3CreateRollerTablesInYourDatabase3"></A><A NAME="ref-InstallationGuide_2.x-3"></A>
-STEP 3: Create Roller tables in your database</H2>
+STEP 4: Create Roller tables in your database</H2>
<P>Create a new database within your MySQL installation, create a
user with all privileges within that database and run the Roller
database creation script to create tables within that new database.</P>
@@ -345,65 +400,6 @@
<P><BR><BR>
</P>
<P> </P>
-<H2><A NAME="section-InstallationGuide_2.x-STEP4DownloadAndInstallRequiredJars4"></A>
-STEP 4: Install required third party jars</H2>
-<P>You also need to download and install some third-party jars, jars
-that we can't include in Roller due to licensing restrictions. These
-are the JDBC driver, JavaMail and Activation jars.</P>
-<H3>STEP 4.1: Install JDBC driver jar(s)</H3>
-<P>Download the JDBC driver jar for your database and put it in the
-classpath of your application server. For example, assuming Tomcat
-and MySQL, you'd download the J/Connector JDBC driver from mysql.com
-and you'd place it in the Tomcat <FONT FACE="Courier New">common/lib</FONT>
-directory.</P>
-<P><B>UNIX example</B></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2> %
-cp mysql-connector.jar $CATALINA_HOME/common/lib</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><BR>
-</P>
-<P><B>Windows example</B></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2> C>
-copy mysql-connector.jar %CATALINA_HOME%\common\lib</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><BR>
-</P>
-<P><B>NOTES</B></P>
-<UL>
- <LI><P STYLE="margin-bottom: 0in">For MySQL 4.1.X users, we
- recommend that you use the J/Connector 3.0.X JDBC drivers instead of
- the newer 3.1.X series. If you <I>must</I> use J/Connector/J 3.1.X
- then please read <I>Installation FAQ</I> page item #13 on the Roller
- wiki.</P>
-</UL>
-<P><BR><BR>
-</P>
-<H3>STEP 4.2: Install JavaMail and Activation jars</H3>
-<P>If you like to use Roller's e-mail notification features, you'll
-need to add the JavaMail and Activation jars to your application
-server's classpath. Currently, we ship these jars with Roller. You
-will need to <B>move</B> them from the Roller <FONT FACE="Courier New">WEB-INF/lib</FONT>
-directory and into the Tomcat <FONT FACE="Courier New">common/lib</FONT>
-directory, or your server's equivalent location.</P>
-<P><B>UNIX example</B></P>
-<P><FONT FACE="Courier New"><FONT SIZE=2> % mv
-$ROLLER/WEB-INF/lib/mail.jar $CATALINA_HOME/common/lib</FONT></FONT></P>
-<P><FONT SIZE=2><FONT FACE="Courier New"> % mv
-$ROLLER/WEB-INF/lib/activation.jar $CATALINA_HOME/common/lib</FONT> </FONT></P>
-<P><B>Windows example</B></P>
-<P><FONT FACE="Courier New"><FONT SIZE=2> c> move
-%ROLLER%\WEB-INF\lib\mail.jar %CATALINA_HOME%\common\lib</FONT></FONT></P>
-<P><FONT FACE="Courier New"><FONT SIZE=2> C> move
-%ROLLER%\WEB-INF\lib\activation.jar %CATALINA_HOME%\common\lib</FONT></FONT></P>
-<P><B>NOTES</B></P>
-<UL>
- <LI><P>To enable the Roller's e-mail notification features, you'll
- also need to setup a mail session resource in your application
- server configuration file (see the next section) and you'll need to
- configure e-mail notification in the Roller UI.</P>
-</UL>
-<P><BR><BR>
-</P>
-<P STYLE="margin-bottom: 0in"><BR>
-</P>
<H2 STYLE="page-break-before: always"><A NAME="section-InstallationGuide_2.x-STEP5DeployRollerToYourApplicationServer5"></A><A NAME="ref-InstallationGuide_2.x-5"></A>
STEP 5: Deploy Roller to your application server</H2>
<P>To deploy Roller to your application server you need to inform
@@ -813,6 +809,13 @@
sure you create the first user yourself. An admin user can grant and
revoke admin rights from other users. </SPAN>
</P>
+<P STYLE="margin-bottom: 0in; font-weight: medium"><BR>
+</P>
+<P STYLE="margin-bottom: 0in; font-weight: medium"><B>NOTE</B>: if
+you'd like to use Roller's JSPWiki plugin, which allows you to enter
+blog entries using JSPWiki syntax, then you'll have to download and
+install separately the JSPWiki jars. See Appendix C for more
+information.</P>
<P><BR><BR>
</P>
<P><B>You're done! </B>
@@ -926,6 +929,14 @@
3.3 Review configuration properties</H4>
<P>Review properties as described in STEP #8 of the installation
guide.</P>
+<P><B>WARNING: In Roller 2.3 we changed the Roller package names from
+<FONT FACE="Courier New">org.roller</FONT> to <FONT FACE="Courier New">org.apache.roller</FONT>.
+Because of this you MUST review your roller-custom.properties file,
+search for the string “org.roller”and replace all
+occurances of it with “org.apache.roller”.</B></P>
+<P><B>WARNING: The jars required for Roller's JSPWiki plugin and Ekit
+editor have been removed from the Roller distribution. If you'd like
+to continue to use these plugins, please refer to Appendices C and D.</B></P>
<H3><A NAME="section-UpgradeGuide_2.1-STEP4UpgradeTheDatabase4"></A><A NAME="ref-UpgradeGuide_2.1-4"></A>
STEP 4: Upgrade the database [#4]</H3>
<P>Use the appropriate database upgrade script to upgrade your
@@ -992,12 +1003,86 @@
<P><BR><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+Licensed to the Apache Software Foundation (ASF) under one or more</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+contributor license agreements. The ASF licenses this file to You</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+under the Apache License, Version 2.0 (the "License"); you
+may not</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+use this file except in compliance with the License.</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+You may obtain a copy of the License at</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ http://www.apache.org/licenses/LICENSE-2.0</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+Unless required by applicable law or agreed to in writing, software</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+distributed under the License is distributed on an "AS IS"
+BASIS,</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+See the License for the specific language governing permissions and</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+limitations under the License. For additional information regarding</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+copyright in this work, please see the NOTICE file in the top level</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+directory of this distribution.</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
+</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
roller.properties</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
This file is for meant for Roller deployment properties</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Any properties that don't change at runtime are defined here</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+You can override the values in this file in a couple ways ..</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ 1. define a roller-custom.properties file and place it somewhere</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ at the root of one of your classpath locations.</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ for example:</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ $TOMCAT_HOME/common/classes</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ $ROLLER_LOCATION/WEB-INF/classes</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ 2. specify a custom properties file via jvm option</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ example:</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ roller.custom.config=/path/to/properties/file</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ **NOTE: if you run multiple instances of roller on the same server</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ then you should beware of the fact that the override
+options above</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ may affect *all* of you running instances. if you want to
+do</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ custom overrides for each instance then you must do it by</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ placing a roller-custom.properties file at WEB-INF/classes/
+in</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ each of you roller installations.</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+properties in this file are accessed like this ...</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+ RollerConfig.getProperty("propname");</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
@@ -1094,12 +1179,22 @@
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
The default cache implementation we want to use</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>cache.defaultFactory=org.roller.presentation.cache.ExpiringLRUCacheFactoryImpl</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>cache.defaultFactory=org.apache.roller.presentation.cache.ExpiringLRUCacheFactoryImpl</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>cache.customHandlers=</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
-Main/Planet page cache (this is low on purpose)</FONT></FONT></P>
+This sets how many minutes into the future we look to prepare</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+entries posted into the future which need to be invalidated from the
+cache.</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+It is very unlikely that this should ever need to be changed</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>cache.futureInvalidations.peerTime=3</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
+</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+Main page cache (this is low on purpose)</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>cache.mainpage.size=10</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>cache.mainpage.timeout=1800</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
@@ -1169,7 +1264,8 @@
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>schemeenforcement.enabled=false</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
URL patterns that require HTTPS</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>schemeenforcement.https.urls=/editor/yourProfile.do*,/admin/user.do*</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>schemeenforcement.https.urls=/j_security_check,/login-redirect.jsp,/login.jsp,\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>/user.do,/editor/yourProfile.do,/admin/user.do,/editor/userdata</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
@@ -1186,25 +1282,25 @@
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Weblog entry editor plugins</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>plugins.page=\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.roller.presentation.velocity.plugins.convertbreaks.ConvertLineBreaksPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.presentation.velocity.plugins.convertbreaks.ConvertLineBreaksPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.search.WikipediaLinkPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.search.WikipediaLinkPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.search.GoogleLinkPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.search.GoogleLinkPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.textile.TextilePlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.textile.TextilePlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.acronyms.AcronymsPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.acronyms.AcronymsPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.bookmarks.BookmarkPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.bookmarks.BookmarkPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.email.ObfuscateEmailPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.email.ObfuscateEmailPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.smileys.SmileysPlugin
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.smileys.SmileysPlugin
\</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.roller.presentation.velocity.plugins.readmore.ReadMorePlugin</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>,org.apache.roller.presentation.velocity.plugins.readmore.ReadMorePlugin</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#----------------------------------</FONT></FONT></P>
@@ -1214,18 +1310,18 @@
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Comma separated list of task classnames to be executed once per day</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>tasks.daily=org.roller.presentation.TurnoverReferersTask\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>tasks.daily=org.apache.roller.presentation.TurnoverReferersTask\</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Needed to enable nightly fetching of blacklist</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#,org.roller.presentation.BlacklistUpdateTask\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#,org.apache.roller.presentation.BlacklistUpdateTask\</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Daily Planet task: syncs weblog list with Roller, refreshes
Technorati stats</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#,org.roller.presentation.planet.SyncWebsitesTask</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#,org.apache.roller.presentation.planet.SyncWebsitesTask</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
@@ -1236,7 +1332,7 @@
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Hourly Planet task: refresh latest entry list from all weblogs in
list</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#org.roller.presentation.planet.RefreshEntriesTask</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#org.apache.roller.presentation.planet.RefreshEntriesTask</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#----------------------------------</FONT></FONT></P>
@@ -1250,11 +1346,11 @@
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Page model implementation</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>velocity.pagemodel.classname=org.roller.presentation.velocity.PageModel</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>velocity.pagemodel.classname=org.apache.roller.presentation.velocity.PageModel</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Experimental page model that allows user's access to Planet
aggregations</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#velocity.pagemodel.classname=org.roller.presentation.velocity.planet.PlanetPageModel</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#velocity.pagemodel.classname=org.apache.roller.presentation.velocity.planet.PlanetPageModel</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#----------------------------------</FONT></FONT></P>
@@ -1262,13 +1358,13 @@
Persistence settings</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>persistence.roller.classname=org.roller.business.hibernate.HibernateRollerImpl</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>persistence.filemanager.classname=org.roller.business.FileManagerImpl</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>persistence.roller.classname=org.apache.roller.business.hibernate.HibernateRollerImpl</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>persistence.filemanager.classname=org.apache.roller.business.FileManagerImpl</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
authenticator settings (experimental)</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>authenticator.classname=org.roller.presentation.DefaultAuthenticator</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>authenticator.classname=org.apache.roller.presentation.DefaultAuthenticator</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#----------------------------------</FONT></FONT></P>
@@ -1276,7 +1372,7 @@
comment, referrer and trackback settings</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>comment.authenticator.classname=org.roller.presentation.velocity.MathCommentAuthenticator</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>comment.authenticator.classname=org.apache.roller.presentation.velocity.MathCommentAuthenticator</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>comment.notification.separateOwnerMessage=false</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>comment.notification.hideCommenterAddresses=false</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
@@ -1309,7 +1405,7 @@
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#Robot
-check in referral processing. If this pattern is set and the
+check in referral processing. If this pattern is set and the
User-Agent in the</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#request
matches this pattern, all referral processing is skipped; this means
@@ -1531,9 +1627,14 @@
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>planet.aggregator.cache.dir=/var/roller/planetcache</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+Number of queries allowed per day</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>planet.aggregator.technorati.limit=500</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
+</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#----------------------------------</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
-user creation setttings: blogroll and cats for new users</FONT></FONT></P>
+defaults for new weblogs</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
@@ -1561,6 +1662,13 @@
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>General,Status,Java,Music,Politics</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+Default weblog editor</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+The list of available editors is in rollerRuntimeConfigDefs.xml</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>newweblog.editor=editor-text.jsp</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
+</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#----------------------------------</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
misc settings</FONT></FONT></P>
@@ -1589,21 +1697,36 @@
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
applied if these were omitted.</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicBookmarkName=Default
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicBookmarkName=Default
Topic Site</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicSite=http://www.technorati.com/tag</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithBookmark=topic:\\{(.*?)\\}\\[(.*?)\\]</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithoutBookmark=topic:\\[(.*?)\\]</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.linkFormatString=<a
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicSite=http://www.technorati.com/tag</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithBookmark=topic:\\{(.*?)\\}\\[(.*?)\\]</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithoutBookmark=topic:\\[(.*?)\\]</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.linkFormatString=<a
rel=\"tag\" href=\"{0}{1}\">{2}</a></FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
Set to true to allow only default topic tag site (and avoid costly
bookmark queries)</FONT></FONT></P>
-<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.ignoreBookmarks=true</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.ignoreBookmarks=true</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
+</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#---------------------------------</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+Experimental settings</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+Atom Publishing Protocol (APP) - this is an incomplete and untested </FONT></FONT>
+</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+implementation of an unfinished IETF specification. Intended only for
+</FONT></FONT>
+</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#
+interoperability testing. DO NOT ENABLE IN PRODUCTION!</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>webservices.atomprotocol.enabled=false</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>#----------------------------------</FONT></FONT></P>
@@ -1618,5 +1741,91 @@
<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2>aggregator.cache.timeout=14400</FONT></FONT></P>
<P STYLE="margin-bottom: 0in"><BR>
</P>
+<H2 STYLE="page-break-before: always"><A NAME="DDE_LINK2"></A>Appendix
+C: Setting up the optional JSPWiki plugin</H2>
+<P>If you'd like to use Roller's JSPWiki plugin, you must 1) download
+and install the required JSPWiki jars and 2) enable the JSPWiki
+plugin via a Roller custom configuration file.</P>
+<P><B>WARNING</B>: The JSPWiki editor has been deprecated (due to
+LGPL licensing) and may be removed from a future release of Roller.</P>
+<H3>Downloading and installing the required JSPWiki jars</H3>
+<P>Download JSPWiki version 2.2.33 from <A HREF="http://jspwiki.org/">http://jspwiki.org</A>,
+copy the following jars from JSPWiki's WEB-INF/lib directory to
+Roller's WEB-INF/lib directory:</P>
+<UL>
+ <LI><P>JSPWiki.jar</P>
+ <LI><P>ecs.jar</P>
+ <LI><P>jrcs-diff.jar</P>
+ <LI><P>oscache.jar</P>
+</UL>
+<P><B>NOTE</B>: The Roller Support project at Java.Net offers some
+required jar bundles that might make this part of the installation
+easier. Visit <A HREF="http://roller.dev.java.net/">http://roller.dev.java.net</A>
+for more information.</P>
+<H3>Enable the JSPWiki plugin via Roller property override</H3>
+<P>Follow the instructions in Appendix B for setting up a
+<FONT FACE="Courier New">roller-custom.properties</FONT> file. You'll
+need to override the <FONT FACE="Courier New">plugins.page</FONT>
+property to ensure that the JSPWiki plugin is included in the list.
+For example, this setting would add the JSPWiki to the end of the
+list of built-in Roller plugins:</P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">plugins.page=\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">org.apache.roller.presentation.velocity.plugins.convertbreaks.ConvertLineBreaksPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.search.WikipediaLinkPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.search.GoogleLinkPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.textile.TextilePlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.acronyms.AcronymsPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.bookmarks.BookmarkPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.email.ObfuscateEmailPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.smileys.SmileysPlugin
+\</FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT FACE="Courier New"><FONT SIZE=2 STYLE="font-size: 9pt">,org.apache.roller.presentation.velocity.plugins.readmore.ReadMorePlugin<B>
+\</B></FONT></FONT></P>
+<P STYLE="margin-bottom: 0in"><FONT SIZE=2 STYLE="font-size: 9pt"><B><FONT FACE="Courier New">,org.apache.roller.presentation.velocity.plugins.jspwiki.WikiPlugin</FONT></B></FONT></P>
+<P STYLE="margin-bottom: 0in"><BR>
+</P>
+<P></P>
+<P></P>
+<H2 STYLE="page-break-before: always">Appendix D: Setting up the
+optional Ekit editor page</H2>
+<P>If you'd like to continue to use Roller's Ekit editor page, which
+was deprecated in Roller 2.3, you must 1) download and install the
+Ekit applet jar and 2) add the Ekit page to the list of available
+editors in the Roller runtime configuration file.</P>
+<P><B>WARNING</B>: The Ekit editor has been deprecated (due to LGPL
+licensing) and may be removed from a future release of Roller.</P>
+<H3>Downloading and installing the required Ekit applet jar</H3>
+<P>Download Ekit version 1.1 from <A HREF="http://www.hexidec.com/ekit.phaa">http://www.hexidec.com/ekit.ph</A>p
+and place the Ekit <FONT FACE="Courier New">ekitappletspell.jar</FONT>
+jar in Roller's editor direcotory.</P>
+<P><B>NOTE</B>: The Roller Support project at Java.Net offers some
+required jar bundles that might make this part of the installation
+easier. Visit <A HREF="http://roller.dev.java.net/">http://roller.dev.java.net</A>
+for more information.</P>
+<H3>Enable the Ekit plugin via Roller runtime configuration
+definitions file</H3>
+<P>If you want users to be able to pick the old Ekit editor page,
+then you'll need to add it to the Roller runtime configuration
+definition file in <FONT FACE="Courier New">WEB-INF/rollerRuntimeConfigDefs.xml</FONT>
+as follows:</P>
+<P STYLE="margin-bottom: 0in; font-weight: medium"><FONT SIZE=2><FONT FACE="Courier New"><property-def
+ name="users.editor.pages" key="configForm.editorPages"></FONT></FONT></P>
+<P STYLE="margin-bottom: 0in; font-weight: medium">
+<FONT FACE="Courier New"><FONT SIZE=2><type>text</type></FONT></FONT></P>
+<P STYLE="margin-bottom: 0in; font-weight: medium">
+<FONT FACE="Courier New"><FONT SIZE=2><default-value>editor-text.jsp,editor-rte.jsp,
+<B>editor-ekit.jsp</B></default-value></FONT></FONT></P>
+<P STYLE="margin-bottom: 0in; font-weight: medium"> <FONT FACE="Courier New"><FONT SIZE=2><rows>3</rows></FONT></FONT></P>
+<P STYLE="margin-bottom: 0in; font-weight: medium"> <FONT FACE="Courier New"><FONT SIZE=2><cols>40</cols></FONT></FONT></P>
+<P STYLE="margin-bottom: 0in; font-weight: medium"><FONT FACE="Courier New"><FONT SIZE=2></property-def></FONT></FONT></P>
</BODY>
</HTML>
Modified: incubator/roller/trunk/docs/installguide/generated/roller-install-guide.pdf
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/installguide/generated/roller-install-guide.pdf?rev=399422&r1=399421&r2=399422&view=diff
==============================================================================
Binary files - no diff available.
Modified: incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt?rev=399422&r1=399421&r2=399422&view=diff
==============================================================================
--- incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt (original)
+++ incubator/roller/trunk/docs/installguide/generated/roller-install-guide.txt Wed May 3 13:43:07 2006
@@ -31,32 +31,39 @@
Introduction 3
STEP 1: Before you install Roller 4
STEP 2: Unpack the Roller distribution 5
-STEP 3: Create Roller tables in your database 6
-STEP 4: Install required third party jars 7
-STEP 4.1: Install JDBC driver jar(s) 7
-STEP 4.2: Install JavaMail and Activation jars 7
-STEP 5: Deploy Roller to your application server 8
-STEP 6: Check your internationalization settings 10
-STEP 7: Setup Roller data directories 11
-STEP 7.1: Create uploads directory 11
-STEP 7.2: Create search-index directory 11
-STEP 7.3: Create planet-cache directory (optional) 11
-STEP 7.4: Make sure that the logs subdirectory exists 12
-STEP 8: Review Roller configuration 13
-STEP 8.1: Review the WEB-INF/classes/roller.properties file 13
-Where to define custom properties 13
-STEP 8.2: Change keys in the WEB-INF/security.xml file 14
-STEP 9: Start Tomcat and start using Roller 15
-Appendix A: Upgrading an existing Roller installation 16
-STEP 1: Shutdown and backup your old Roller [#1] 16
-STEP 2: Install the new Roller [#2] 16
-STEP 3: Copy resources and update configs [#3] 17
-3.1 Copy your old resources and other files you've added 17
-3.2 Remove JavaMail jars if duplicated 17
-3.3 Review configuration properties 17
-STEP 4: Upgrade the database [#4] 17
-STEP 5: Startup your app server [#5] 18
-Appendix B: The WEB-INF/roller.properties file 19
+STEP 3: Install required third party jars 6
+STEP 4.1: Download and install Hibernate 6
+STEP 4.2: Install JDBC driver jar(s) 6
+STEP 4.3: Install JavaMail and Activation jars 7
+STEP 4: Create Roller tables in your database 8
+STEP 5: Deploy Roller to your application server 9
+STEP 6: Check your internationalization settings 11
+STEP 7: Setup Roller data directories 12
+STEP 7.1: Create uploads directory 12
+STEP 7.2: Create search-index directory 12
+STEP 7.3: Create planet-cache directory (optional) 12
+STEP 7.4: Make sure that the logs subdirectory exists 13
+STEP 8: Review Roller configuration 14
+STEP 8.1: Review the WEB-INF/classes/roller.properties file 14
+Where to define custom properties 14
+STEP 8.2: Change keys in the WEB-INF/security.xml file 15
+STEP 9: Start Tomcat and start using Roller 16
+Appendix A: Upgrading an existing Roller installation 17
+STEP 1: Shutdown and backup your old Roller [#1] 17
+STEP 2: Install the new Roller [#2] 17
+STEP 3: Copy resources and update configs [#3] 18
+3.1 Copy your old resources and other files you've added 18
+3.2 Remove JavaMail jars if duplicated 18
+3.3 Review configuration properties 18
+STEP 4: Upgrade the database [#4] 18
+STEP 5: Startup your app server [#5] 19
+Appendix B: The WEB-INF/roller.properties file 20
+Appendix C: Setting up the optional JSPWiki plugin 27
+Downloading and installing the required JSPWiki jars 27
+Enable the JSPWiki plugin via Roller property override 27
+Appendix D: Setting up the optional Ekit editor page 28
+Downloading and installing the required Ekit applet jar 28
+Enable the Ekit plugin via Roller runtime configuration definitions file 28
Introduction
This document describes how to install Roller in the following environment:
@@ -77,13 +84,13 @@
Before you install Roller software you should install and configure the Java development kit, your application server and your database.
As part of the Tomcat install you should have set the environment variable CATALINA_HOME to point to your Tomcat installation directory. If not, you might want to set it now because we will refer to it in this installation guide. Below are some examples that show how to set this variable. Make sure you substitute the right path to your Tomcat installation.
For UNIX with bash shell:
- % export CATALINA_HOME=/opt/jakarta-tomcat-5.0.29
+ % export CATALINA_HOME=/opt/jakarta-tomcat-5.5.9
For UNIX with c-shell:
- % setenv CATALINA_HOME /opt/jakarta-tomcat-5.0.29
+ % setenv CATALINA_HOME /opt/jakarta-tomcat-5.5.9
For Windows with DOS shell
- C> set CATALINA_HOME d:\jakarta-tomcat-5.0.29
+ C> set CATALINA_HOME d:\jakarta-tomcat-5.5.9
NOTES
For MySQL, make sure you enable UTF-8 support. See the page Setting Up UTF-8 on MySQL page on the Roller wiki for details.
@@ -101,12 +108,14 @@
That would create the Roller installation directory /usr/local/roller.
Windows example
Use WinZip to extract the Roller distribution file into the directory of your choice for example, no example necessary.
-Download required jars
-Roller requires the Hibernate persistence library, which you must download separately from Roller.
+
+STEP 3: Install required third party jars
+You also need to download and install some third-party jars, jars that we can't include in Roller due to licensing restrictions. These are the JDBC driver, JavaMail and Activation jars.
+STEP 4.1: Download and install Hibernate
+Roller requires the Hibernate persistence library, which you must download separately from Roller.
Download Hibernate 3.1.2 from SourceForge
http://prdownloads.sourceforge.net/hibernate/hibernate-3.1.2.tar.gz
-
Copy the following files from Hibernate into the Roller WEB-INF/lib directory:
hibernate3.jar
asm-attrs.jar
@@ -116,13 +125,29 @@
ehcache-1.1.jar
jdbc2_0-stdext.jar
jta.jar
+The Roller Support project at Java.Net offers some required jar bundles that might make this part of the installation easier. Visit http://roller.dev.java.net for more information.
+STEP 4.2: Install JDBC driver jar(s)
+Download the JDBC driver jar for your database and put it in the classpath of your application server. For example, assuming Tomcat and MySQL, you'd download the J/Connector JDBC driver from mysql.com and you'd place it in the Tomcat common/lib directory.
+UNIX example
+ % cp mysql-connector.jar $CATALINA_HOME/common/lib
-The Roller Support project at Java.Net offers some required jar bundles that might make installation easier. Visit http://roller.dev.java.net for more information.
-
-
+Windows example
+ C> copy mysql-connector.jar %CATALINA_HOME%\common\lib
+NOTES
+For MySQL 4.1.X users, we recommend that you use the J/Connector 3.0.X JDBC drivers instead of the newer 3.1.X series. If you must use J/Connector/J 3.1.X then please read Installation FAQ page item #13 on the Roller wiki.
-STEP 3: Create Roller tables in your database
+STEP 4.3: Install JavaMail and Activation jars
+If you like to use Roller's e-mail notification features, you'll need to add the JavaMail and Activation jars to your application server's classpath. Currently, we ship these jars with Roller, but you will need to move them from the Roller WEB-INF/lib directory and into the Tomcat common/lib directory, or your server's equivalent location.
+UNIX example
+ % mv $ROLLER/WEB-INF/lib/mail.jar $CATALINA_HOME/common/lib
+ % mv $ROLLER/WEB-INF/lib/activation.jar $CATALINA_HOME/common/lib
+Windows example
+ c> move %ROLLER%\WEB-INF\lib\mail.jar %CATALINA_HOME%\common\lib
+ C> move %ROLLER%\WEB-INF\lib\activation.jar %CATALINA_HOME%\common\lib
+NOTES
+To enable the Roller's e-mail notification features, you'll also need to setup a mail session resource in your application server configuration file (see the next section) and you'll need to configure e-mail notification in the Roller UI.
+STEP 4: Create Roller tables in your database
Create a new database within your MySQL installation, create a user with all privileges within that database and run the Roller database creation script to create tables within that new database.
Roller includes database creation scripts for a variety of database, but MySQL is the most widely used and best supported option. You can find the database creation scripts in the Roller installation directory under WEB-INF/dbscripts/<dbname>. Here's the list of scripts currently in Roller:
WEB-INF/dbscripts/mysql/creatdb.sql
@@ -159,31 +184,6 @@
mysql roller -h 127.0.0.1 -u scott -ptiger
-STEP 4: Install required third party jars
-You also need to download and install some third-party jars, jars that we can't include in Roller due to licensing restrictions. These are the JDBC driver, JavaMail and Activation jars.
-STEP 4.1: Install JDBC driver jar(s)
-Download the JDBC driver jar for your database and put it in the classpath of your application server. For example, assuming Tomcat and MySQL, you'd download the J/Connector JDBC driver from mysql.com and you'd place it in the Tomcat common/lib directory.
-UNIX example
- % cp mysql-connector.jar $CATALINA_HOME/common/lib
-
-Windows example
- C> copy mysql-connector.jar %CATALINA_HOME%\common\lib
-
-NOTES
-For MySQL 4.1.X users, we recommend that you use the J/Connector 3.0.X JDBC drivers instead of the newer 3.1.X series. If you must use J/Connector/J 3.1.X then please read Installation FAQ page item #13 on the Roller wiki.
-
-STEP 4.2: Install JavaMail and Activation jars
-If you like to use Roller's e-mail notification features, you'll need to add the JavaMail and Activation jars to your application server's classpath. Currently, we ship these jars with Roller. You will need to move them from the Roller WEB-INF/lib directory and into the Tomcat common/lib directory, or your server's equivalent location.
-UNIX example
- % mv $ROLLER/WEB-INF/lib/mail.jar $CATALINA_HOME/common/lib
- % mv $ROLLER/WEB-INF/lib/activation.jar $CATALINA_HOME/common/lib
-Windows example
- c> move %ROLLER%\WEB-INF\lib\mail.jar %CATALINA_HOME%\common\lib
- C> move %ROLLER%\WEB-INF\lib\activation.jar %CATALINA_HOME%\common\lib
-NOTES
-To enable the Roller's e-mail notification features, you'll also need to setup a mail session resource in your application server configuration file (see the next section) and you'll need to configure e-mail notification in the Roller UI.
-
-
STEP 5: Deploy Roller to your application server
To deploy Roller to your application server you need to inform your application server:
Where to find the Roller installation directory
@@ -366,6 +366,8 @@
NOTE: the first user you create will have administrator privileges, so make sure you create the first user yourself. An admin user can grant and revoke admin rights from other users.
+NOTE: if you'd like to use Roller's JSPWiki plugin, which allows you to enter blog entries using JSPWiki syntax, then you'll have to download and install separately the JSPWiki jars. See Appendix C for more information.
+
You're done!
Roller should be working perfectly now. If not, then please consult the Installation FAQ page on the Roller wiki and then check with the experts on the Roller mailing lists. Somebody has probably encountered the very same problems that you are encountering.
@@ -413,6 +415,8 @@
In an upgrade installation, you may already have the JavaMail jars mail.jar and activation.jar in your Tomcat common/lib. If so, you should remove them from the WEB-INF/lib directory within the web app. (Keep them only in the common/lib directory.)
3.3 Review configuration properties
Review properties as described in STEP #8 of the installation guide.
+WARNING: In Roller 2.3 we changed the Roller package names from org.roller to org.apache.roller. Because of this you MUST review your roller-custom.properties file, search for the string "org.roller"and replace all occurances of it with "org.apache.roller".
+WARNING: The jars required for Roller's JSPWiki plugin and Ekit editor have been removed from the Roller distribution. If you'd like to continue to use these plugins, please refer to Appendices C and D.
STEP 4: Upgrade the database [#4]
Use the appropriate database upgrade script to upgrade your database. To do this, login to your database and run one (or more) of the Roller upgrade scripts located in Roller's WEB-INF/dbscripts directory that corresponds to your database. There's a directory for MySQL, PostgreSQL, HSQLDB and more.
The database script directories
@@ -437,10 +441,47 @@
Appendix B: The WEB-INF/roller.properties file
This file defines the default start-up properties for Roller. See step 8 for instructions on how to override the properties in this file.
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. The ASF licenses this file to You
+# 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. For additional information regarding
+# copyright in this work, please see the NOTICE file in the top level
+# directory of this distribution.
+
# roller.properties
#
# This file is for meant for Roller deployment properties
# Any properties that don't change at runtime are defined here
+#
+# You can override the values in this file in a couple ways ..
+# 1. define a roller-custom.properties file and place it somewhere
+# at the root of one of your classpath locations.
+# for example:
+# $TOMCAT_HOME/common/classes
+# $ROLLER_LOCATION/WEB-INF/classes
+#
+# 2. specify a custom properties file via jvm option
+# example:
+# roller.custom.config=/path/to/properties/file
+#
+# **NOTE: if you run multiple instances of roller on the same server
+# then you should beware of the fact that the override options above
+# may affect *all* of you running instances. if you want to do
+# custom overrides for each instance then you must do it by
+# placing a roller-custom.properties file at WEB-INF/classes/ in
+# each of you roller installations.
+#
+# properties in this file are accessed like this ...
+# RollerConfig.getProperty("propname");
# User management settings
@@ -491,10 +532,15 @@
#-----------------------------------
# The default cache implementation we want to use
-cache.defaultFactory=org.roller.presentation.cache.ExpiringLRUCacheFactoryImpl
+cache.defaultFactory=org.apache.roller.presentation.cache.ExpiringLRUCacheFactoryImpl
cache.customHandlers=
-# Main/Planet page cache (this is low on purpose)
+# This sets how many minutes into the future we look to prepare
+# entries posted into the future which need to be invalidated from the cache.
+# It is very unlikely that this should ever need to be changed
+cache.futureInvalidations.peerTime=3
+
+# Main page cache (this is low on purpose)
cache.mainpage.size=10
cache.mainpage.timeout=1800
# set "true" to NOT cache the custom pages for users who are logged in
@@ -536,7 +582,8 @@
# Scheme enforcement ensures that specific URLs are viewed only via HTTPS
schemeenforcement.enabled=false
# URL patterns that require HTTPS
-schemeenforcement.https.urls=/editor/yourProfile.do*,/admin/user.do*
+schemeenforcement.https.urls=/j_security_check,/login-redirect.jsp,/login.jsp,\
+/user.do,/editor/yourProfile.do,/admin/user.do,/editor/userdata
# Password security settings
passwds.encryption.enabled=false
@@ -547,34 +594,34 @@
# Weblog entry editor plugins
plugins.page=\
-org.roller.presentation.velocity.plugins.convertbreaks.ConvertLineBreaksPlugin \
-,org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin \
-,org.roller.presentation.velocity.plugins.search.WikipediaLinkPlugin \
-,org.roller.presentation.velocity.plugins.search.GoogleLinkPlugin \
-,org.roller.presentation.velocity.plugins.textile.TextilePlugin \
-,org.roller.presentation.velocity.plugins.acronyms.AcronymsPlugin \
-,org.roller.presentation.velocity.plugins.bookmarks.BookmarkPlugin \
-,org.roller.presentation.velocity.plugins.email.ObfuscateEmailPlugin \
-,org.roller.presentation.velocity.plugins.smileys.SmileysPlugin \
-,org.roller.presentation.velocity.plugins.readmore.ReadMorePlugin
+org.apache.roller.presentation.velocity.plugins.convertbreaks.ConvertLineBreaksPlugin \
+,org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin \
+,org.apache.roller.presentation.velocity.plugins.search.WikipediaLinkPlugin \
+,org.apache.roller.presentation.velocity.plugins.search.GoogleLinkPlugin \
+,org.apache.roller.presentation.velocity.plugins.textile.TextilePlugin \
+,org.apache.roller.presentation.velocity.plugins.acronyms.AcronymsPlugin \
+,org.apache.roller.presentation.velocity.plugins.bookmarks.BookmarkPlugin \
+,org.apache.roller.presentation.velocity.plugins.email.ObfuscateEmailPlugin \
+,org.apache.roller.presentation.velocity.plugins.smileys.SmileysPlugin \
+,org.apache.roller.presentation.velocity.plugins.readmore.ReadMorePlugin
#----------------------------------
# scheduled tasks, each is comma separated list of classes
# Comma separated list of task classnames to be executed once per day
-tasks.daily=org.roller.presentation.TurnoverReferersTask\
+tasks.daily=org.apache.roller.presentation.TurnoverReferersTask\
# Needed to enable nightly fetching of blacklist
-#,org.roller.presentation.BlacklistUpdateTask\
+#,org.apache.roller.presentation.BlacklistUpdateTask\
# Daily Planet task: syncs weblog list with Roller, refreshes Technorati stats
-#,org.roller.presentation.planet.SyncWebsitesTask
+#,org.apache.roller.presentation.planet.SyncWebsitesTask
# Comma separated list of task classnames to be executed hourly
tasks.hourly=\
# Hourly Planet task: refresh latest entry list from all weblogs in list
-#org.roller.presentation.planet.RefreshEntriesTask
+#org.apache.roller.presentation.planet.RefreshEntriesTask
#----------------------------------
# Velocity settings
@@ -583,23 +630,23 @@
velocity.toolbox.file=/WEB-INF/toolbox.xml
# Page model implementation
-velocity.pagemodel.classname=org.roller.presentation.velocity.PageModel
+velocity.pagemodel.classname=org.apache.roller.presentation.velocity.PageModel
# Experimental page model that allows user's access to Planet aggregations
-#velocity.pagemodel.classname=org.roller.presentation.velocity.planet.PlanetPageModel
+#velocity.pagemodel.classname=org.apache.roller.presentation.velocity.planet.PlanetPageModel
#----------------------------------
# Persistence settings
-persistence.roller.classname=org.roller.business.hibernate.HibernateRollerImpl
-persistence.filemanager.classname=org.roller.business.FileManagerImpl
+persistence.roller.classname=org.apache.roller.business.hibernate.HibernateRollerImpl
+persistence.filemanager.classname=org.apache.roller.business.FileManagerImpl
# authenticator settings (experimental)
-authenticator.classname=org.roller.presentation.DefaultAuthenticator
+authenticator.classname=org.apache.roller.presentation.DefaultAuthenticator
#----------------------------------
# comment, referrer and trackback settings
-comment.authenticator.classname=org.roller.presentation.velocity.MathCommentAuthenticator
+comment.authenticator.classname=org.apache.roller.presentation.velocity.MathCommentAuthenticator
comment.notification.separateOwnerMessage=false
comment.notification.hideCommenterAddresses=false
@@ -617,7 +664,7 @@
# trackback.allowedURLs=http://w3.ibm.com/.*||http://another.example.com/.*
trackback.allowedURLs=
-#Robot check in referral processing. If this pattern is set and the User-Agent in the
+#Robot check in referral processing. If this pattern is set and the User-Agent in the
#request matches this pattern, all referral processing is skipped; this means that
#the referral spam check is skipped, the request is allowed to proceed, but the
#referrer is not recorded and hit count is not incremented. Recommended for large sites
@@ -709,8 +756,11 @@
# Planet cache must exist and must be writable by Roller process
planet.aggregator.cache.dir=/var/roller/planetcache
+# Number of queries allowed per day
+planet.aggregator.technorati.limit=500
+
#----------------------------------
-# user creation setttings: blogroll and cats for new users
+# defaults for new weblogs
# list of links to include in root bookmark folder of each new blog
# format is like so: linktitle2|linkurl2,linktitle2|linkurl2,linktitle3|linkurl3
@@ -726,6 +776,10 @@
newuser.categories=\
General,Status,Java,Music,Politics
+# Default weblog editor
+# The list of available editors is in rollerRuntimeConfigDefs.xml
+newweblog.editor=editor-text.jsp
+
#----------------------------------
# misc settings
@@ -742,15 +796,22 @@
# Optional site-wide customization settings for the TopicTag plugin.
# n.b. these default settings match the coded default values that would be
# applied if these were omitted.
-org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicBookmarkName=Default Topic Site
-org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicSite=http://www.technorati.com/tag
-org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithBookmark=topic:\\{(.*?)\\}\\[(.*?)\\]
-org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithoutBookmark=topic:\\[(.*?)\\]
-org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.linkFormatString=<a rel=\"tag\" href=\"{0}{1}\">{2}</a>
+org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicBookmarkName=Default Topic Site
+org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.defaultTopicSite=http://www.technorati.com/tag
+org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithBookmark=topic:\\{(.*?)\\}\\[(.*?)\\]
+org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.tagRegexWithoutBookmark=topic:\\[(.*?)\\]
+org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.linkFormatString=<a rel=\"tag\" href=\"{0}{1}\">{2}</a>
# Set to true to allow only default topic tag site (and avoid costly bookmark queries)
-org.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.ignoreBookmarks=true
+org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin.ignoreBookmarks=true
+
+#---------------------------------
+# Experimental settings
+# Atom Publishing Protocol (APP) - this is an incomplete and untested
+# implementation of an unfinished IETF specification. Intended only for
+# interoperability testing. DO NOT ENABLE IN PRODUCTION!
+webservices.atomprotocol.enabled=false
#----------------------------------
# legacy settings (thing that should be deprecated
@@ -760,3 +821,44 @@
aggregator.cache.enabled=
aggregator.cache.timeout=14400
+Appendix C: Setting up the optional JSPWiki plugin
+If you'd like to use Roller's JSPWiki plugin, you must 1) download and install the required JSPWiki jars and 2) enable the JSPWiki plugin via a Roller custom configuration file.
+WARNING: The JSPWiki editor has been deprecated (due to LGPL licensing) and may be removed from a future release of Roller.
+Downloading and installing the required JSPWiki jars
+Download JSPWiki version 2.2.33 from http://jspwiki.org, copy the following jars from JSPWiki's WEB-INF/lib directory to Roller's WEB-INF/lib directory:
+JSPWiki.jar
+ecs.jar
+jrcs-diff.jar
+oscache.jar
+NOTE: The Roller Support project at Java.Net offers some required jar bundles that might make this part of the installation easier. Visit http://roller.dev.java.net for more information.
+Enable the JSPWiki plugin via Roller property override
+Follow the instructions in Appendix B for setting up a roller-custom.properties file. You'll need to override the plugins.page property to ensure that the JSPWiki plugin is included in the list. For example, this setting would add the JSPWiki to the end of the list of built-in Roller plugins:
+plugins.page=\
+org.apache.roller.presentation.velocity.plugins.convertbreaks.ConvertLineBreaksPlugin \
+,org.apache.roller.presentation.velocity.plugins.topictag.TopicTagPlugin \
+,org.apache.roller.presentation.velocity.plugins.search.WikipediaLinkPlugin \
+,org.apache.roller.presentation.velocity.plugins.search.GoogleLinkPlugin \
+,org.apache.roller.presentation.velocity.plugins.textile.TextilePlugin \
+,org.apache.roller.presentation.velocity.plugins.acronyms.AcronymsPlugin \
+,org.apache.roller.presentation.velocity.plugins.bookmarks.BookmarkPlugin \
+,org.apache.roller.presentation.velocity.plugins.email.ObfuscateEmailPlugin \
+,org.apache.roller.presentation.velocity.plugins.smileys.SmileysPlugin \
+,org.apache.roller.presentation.velocity.plugins.readmore.ReadMorePlugin \
+,org.apache.roller.presentation.velocity.plugins.jspwiki.WikiPlugin
+
+
+
+Appendix D: Setting up the optional Ekit editor page
+If you'd like to continue to use Roller's Ekit editor page, which was deprecated in Roller 2.3, you must 1) download and install the Ekit applet jar and 2) add the Ekit page to the list of available editors in the Roller runtime configuration file.
+WARNING: The Ekit editor has been deprecated (due to LGPL licensing) and may be removed from a future release of Roller.
+Downloading and installing the required Ekit applet jar
+Download Ekit version 1.1 from http://www.hexidec.com/ekit.php and place the Ekit ekitappletspell.jar jar in Roller's editor direcotory.
+NOTE: The Roller Support project at Java.Net offers some required jar bundles that might make this part of the installation easier. Visit http://roller.dev.java.net for more information.
+Enable the Ekit plugin via Roller runtime configuration definitions file
+If you want users to be able to pick the old Ekit editor page, then you'll need to add it to the Roller runtime configuration definition file in WEB-INF/rollerRuntimeConfigDefs.xml as follows:
+<property-def name="users.editor.pages" key="configForm.editorPages">
+ <type>text</type>
+ <default-value>editor-text.jsp,editor-rte.jsp, editor-ekit.jsp</default-value>
+ <rows>3</rows>
+ <cols>40</cols>
+</property-def>
\ No newline at end of file
Modified: incubator/roller/trunk/docs/installguide/roller-install-guide.odt
URL: http://svn.apache.org/viewcvs/incubator/roller/trunk/docs/installguide/roller-install-guide.odt?rev=399422&r1=399421&r2=399422&view=diff
==============================================================================
Binary files - no diff available.