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/12/16 16:54:18 UTC
svn commit: r487817 - in
/incubator/roller/branches/roller_3.1/docs/installguide:
generated/roller-install-guide.html generated/roller-install-guide.pdf
generated/roller-install-guide.txt roller-install-guide.odt
Author: snoopdave
Date: Sat Dec 16 07:54:18 2006
New Revision: 487817
URL: http://svn.apache.org/viewvc?view=rev&rev=487817
Log:
Added note about using Oracle 10g
Modified:
incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.html
incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.pdf
incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.txt
incubator/roller/branches/roller_3.1/docs/installguide/roller-install-guide.odt
Modified: incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.html
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.html?view=diff&rev=487817&r1=487816&r2=487817
==============================================================================
--- incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.html (original)
+++ incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.html Sat Dec 16 07:54:18 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="20061207;11581100">
+ <META NAME="CHANGED" CONTENT="20061216;10495300">
<STYLE>
<!--
@page { size: 8.5in 11in; margin: 0.5in }
@@ -364,16 +364,16 @@
<P CLASS="western">Copy the following files from Hibernate into the
Roller WEB-INF/lib directory:</P>
<UL>
- <LI><P CLASS="western">hibernate3.jar</P>
- <LI><P CLASS="western">asm-attrs.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">hibernate3.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">asm-attrs.jar</P>
</UL>
<UL>
- <LI><P CLASS="western">asm.jar</P>
- <LI><P CLASS="western">cglib-2.1.3.jar</P>
- <LI><P CLASS="western">dom4j.1.6.1.jar</P>
- <LI><P CLASS="western">ehcache-1.1.jar</P>
- <LI><P CLASS="western">jdbc2_0-stdext.jar</P>
- <LI><P CLASS="western">jta.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">asm.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">cglib-2.1.3.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">dom4j.1.6.1.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">ehcache-1.1.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">jdbc2_0-stdext.jar</P>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in">jta.jar</P>
</UL>
<P CLASS="western">The Roller Support project at Java.Net offers some
bundles that might make this part of the installation easier. Visit
@@ -404,6 +404,12 @@
Hibernate configuration file to use the MySQL5 dialect (see Section
8.3 for details on that).</P>
</UL>
+<UL>
+ <LI><P CLASS="western" STYLE="margin-bottom: 0in"><A NAME="st"></A>For
+ Oracle users, we recommend that you use the 10g (<A HREF="http://10.1.0.2/" TARGET="_blank" ONCLICK="return top.js.OpenExtLink(window,event,this)">10.1.0.2</A>
+ or higher) drivers which should<BR>be packaged as ojdbc14.jar --
+ even if operating on Oracle 9 server.</P>
+</UL>
<P CLASS="western"><BR><BR>
</P>
<H3 CLASS="western" STYLE="page-break-before: always">STEP 3.3:
@@ -1065,7 +1071,7 @@
<PRE> <FONT FACE="Courier New"><FONT SIZE=3>% cd $CATALINA_HOME/webapps</FONT></FONT>
<FONT FACE="Courier New"><FONT SIZE=3>% mkdir /somewhere/safe/roller-old</FONT></FONT>
<FONT FACE="Courier New"><FONT SIZE=3>% mv roller /somewhere/safe/roller-old</FONT></FONT></PRE><H3 CLASS="western">
-<A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller11"></A><A NAME="section-UpgradeGuide_2.1-STEP2InstallTheNewRoller2"></A><A NAME="ref-UpgradeGuide_2.1-2"></A>
+<A NAME="section-UpgradeGuide_2.1-STEP2InstallTheNewRoller2"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller11"></A><A NAME="ref-UpgradeGuide_2.1-2"></A>
UPGRADE STEP 2: Install the new Roller
</H3>
<P CLASS="western">Follow the normal installation instructions to
@@ -1080,7 +1086,7 @@
the installation, we'll do that later
</P>
</UL>
-<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller12"></A><A NAME="section-UpgradeGuide_2.1-STEP3CopyResourcesAndUpdateConfigs3"></A><A NAME="ref-UpgradeGuide_2.1-3"></A>
+<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP3CopyResourcesAndUpdateConfigs3"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller12"></A><A NAME="ref-UpgradeGuide_2.1-3"></A>
UPGRADE STEP 3: Copy resources and update configs
</H3>
<H4 CLASS="western"><A NAME="section-UpgradeGuide_2.1-3.1CopyYourOldResourcesAndOtherFilesYouveAdded"></A>
@@ -1120,7 +1126,7 @@
visit the Roller Support project on Java.Net
(http://roller.dev.java.net).</B></P>
</UL>
-<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller13"></A><A NAME="section-UpgradeGuide_2.1-STEP4UpgradeTheDatabase4"></A><A NAME="ref-UpgradeGuide_2.1-4"></A>
+<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP4UpgradeTheDatabase4"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller13"></A><A NAME="ref-UpgradeGuide_2.1-4"></A>
UPGRADE STEP 4: Upgrade the database
</H3>
<P CLASS="western">Use the appropriate database upgrade script to
@@ -1167,7 +1173,7 @@
<P CLASS="western">If you're upgrading from an earlier release you'll
have to run each of the older scripts in order to upgrade your
database.</P>
-<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller14"></A><A NAME="section-UpgradeGuide_2.1-STEP5StartupTomcat5"></A><A NAME="ref-UpgradeGuide_2.1-5"></A>
+<H3 CLASS="western"><A NAME="section-UpgradeGuide_2.1-STEP5StartupTomcat5"></A><A NAME="section-UpgradeGuide_2.1-STEP1ShutdownAndBackupYourOldRoller14"></A><A NAME="ref-UpgradeGuide_2.1-5"></A>
UPGRADE STEP 5: Startup your app server
</H3>
<P CLASS="western">Use the standard Tomcat <FONT FACE="Courier New">startup.sh</FONT>
Modified: incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.pdf
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.pdf?view=diff&rev=487817&r1=487816&r2=487817
==============================================================================
Binary files - no diff available.
Modified: incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.txt
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.txt?view=diff&rev=487817&r1=487816&r2=487817
==============================================================================
--- incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.txt (original)
+++ incubator/roller/branches/roller_3.1/docs/installguide/generated/roller-install-guide.txt Sat Dec 16 07:54:18 2006
@@ -172,6 +172,8 @@
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.
For MySQL 5.X users, we recommend that you use the J/Connector 3.1.X JDBC drivers instead of the newer 3.1.X series, you'll also need to change the Hibernate configuration file to use the MySQL5 dialect (see Section 8.3 for details on that).
+For Oracle users, we recommend that you use the 10g (10.1.0.2 or higher) drivers which should
+be packaged as ojdbc14.jar -- even if operating on Oracle 9 server.
STEP 3.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. You can find them here: http://java.sun.com/products/javamail/. Add them to Tomcat common/lib directory, or your server's equivalent location.
@@ -357,12 +359,15 @@
We are going to assume you have defined a roller-custom.properties file and placed it in your classpath somewhere. To override any of the default Roller properties you simply add a line with the proper key and the new value you wish to use.
Here is a sample roller-custom.properties with the few properties that should be overridden
-
- uploads.dir=/app/roller/roller_data/uploads
+
+ uploads.dir=/app/roller/roller_data/uploads
search.index.dir=/app/roller/roller_data/search-index
+ passwds.encryption.enabled=true
# etc, etc, etc ... any other properties you want to override
+NOTE: Setting password encryption to true is a very good idea for new Roller sites, but if you are upgrading an existing Roller site you'll need to come up with a strategy for converting your old unencrypted passwords before you turn encryption on.
+
STEP 8.2: Change keys in the WEB-INF/security.xml file
Starting with version 2.1, Roller uses the Acegi security infrastructure. Several of the security features rely on keys that are intended to be site-specific. These keys are used to compute HMAC (hash-based message authentication code) values for Remember Me cookies. Knowledge of these keys could allow an attacker to forge invalid cookies, and thereby gain unauthorized access to your Roller installation (at the application level).
Roller ships with default values, and these should assumed to be widely known. You should change your keys to be secret values specific to your own site.
@@ -540,6 +545,12 @@
# RollerConfig.getProperty("propname");
#---------------------------------
+# Database configuration settings
+
+# Hibernate dialect: You must override this to use a database other than MySQL4
+hibernate.dialect=org.hibernate.dialect.MySQLDialect
+
+#---------------------------------
# User management settings
# True to enable group blogging. False to prevent users from creating more
@@ -563,6 +574,12 @@
uploads.url=/resources
#----------------------------------
+# Themes settings
+
+# The directory in which Roller will look for themes
+themes.dir=${webapp.context}
+
+#----------------------------------
# Search index settings
# Enables indexing of weblog entries and comments and enables search servlet
@@ -634,6 +651,17 @@
org.apache.roller.ui.rendering.model.CalendarModel,\
org.apache.roller.ui.rendering.model.MenuModel
+# Set of models to be made available for weblog page *preview* rendering
+# NOTE: this *does* have some differences between the pageModels
+rendering.previewModels=\
+org.apache.roller.ui.rendering.model.PreviewPageModel,\
+org.apache.roller.ui.rendering.model.ConfigModel,\
+org.apache.roller.ui.rendering.model.UtilitiesModel,\
+org.apache.roller.ui.rendering.model.PreviewURLModel,\
+org.apache.roller.ui.rendering.model.MessageModel,\
+org.apache.roller.ui.rendering.model.CalendarModel,\
+org.apache.roller.ui.rendering.model.MenuModel
+
# Set of page models specifically for site-wide rendering
rendering.siteModels=\
org.apache.roller.ui.rendering.model.SiteModel
@@ -726,24 +754,62 @@
#,org.apache.roller.ui.rendering.plugins.AcronymsPlugin \
#,org.apache.roller.ui.rendering.plugins.BookmarkPlugin
+# The list of configured WeblogEntryEditors available to users
+plugins.weblogEntryEditors=\
+org.apache.roller.ui.core.plugins.TextEditor,\
+org.apache.roller.ui.core.plugins.XinhaEditor
-#----------------------------------
-# scheduled tasks, each is comma separated list of classes
-
-# Comma separated list of task classnames to be executed once per day
-tasks.daily=org.apache.roller.ui.core.tasks.TurnoverReferersTask\
+# The "id" of the default editor to use. NOT the class name
+plugins.defaultEditor=editor-text.jsp
-# Needed to enable nightly fetching of blacklist
-#,org.apache.roller.ui.core.tasks.BlacklistUpdateTask\
+#----------------------------------
+# Scheduled Background Tasks ... all times are in minutes.
+#
+# Task properties should follow the given format ...
+# tasks.<taskname>.<prop>=<value>
+#
+# The *enabled* tasks are defined by tasks.enabled=<taskname>[,<taskname>]
+#-----------------------------------
-# Daily Planet task: syncs weblog list with Roller, refreshes Technorati stats
-#,org.apache.roller.ui.core.tasks.SyncWebsitesTask
+# Tasks which are enabled. Only tasks listed here will be run.
+tasks.enabled=ResetHitCountsTask,TurnoverReferersTask,PingQueueTask
-# Comma separated list of task classnames to be executed hourly
-tasks.hourly=\
+# Reset hit counts
+tasks.ResetHitCountsTask.class=org.apache.roller.business.runnable.ResetHitCountsTask
+tasks.ResetHitCountsTask.startTime=startOfDay
+tasks.ResetHitCountsTask.interval=1440
+tasks.ResetHitCountsTask.leaseTime=30
+
+# Reset referer counts
+tasks.TurnoverReferersTask.class=org.apache.roller.business.runnable.TurnoverReferersTask
+tasks.TurnoverReferersTask.startTime=startOfDay
+tasks.TurnoverReferersTask.interval=1440
+tasks.TurnoverReferersTask.leaseTime=30
+
+# Ping processor, does sending of pings
+tasks.PingQueueTask.class=org.apache.roller.business.pings.PingQueueTask
+tasks.PingQueueTask.startTime=immediate
+tasks.PingQueueTask.interval=5
+tasks.PingQueueTask.leaseTime=30
+
+# Sync Roller weblogs with planet
+tasks.SyncWebsitesTask.class=org.apache.roller.planet.tasks.SyncWebsitesTask
+tasks.SyncWebsitesTask.startTime=startOfDay
+tasks.SyncWebsitesTask.interval=1440
+tasks.SyncWebsitesTask.leaseTime=30
+
+# Refresh entries for planet feeds
+tasks.RefreshEntriesTask.class=org.apache.roller.planet.tasks.RefreshEntriesTask
+tasks.RefreshEntriesTask.startTime=startOfHour
+tasks.RefreshEntriesTask.interval=60
+tasks.RefreshEntriesTask.leaseTime=30
+
+# Technorati rankings for planet feeds
+tasks.TechnoratiRankingsTask.class=org.apache.roller.planet.tasks.TechnoratiRankingsTask
+tasks.TechnoratiRankingsTask.startTime=startOfDay
+tasks.TechnoratiRankingsTask.interval=1440
+tasks.TechnoratiRankingsTask.leaseTime=30
-# Hourly Planet task: refresh latest entry list from all weblogs in list
-#org.apache.roller.ui.core.tasks.RefreshEntriesTask
#----------------------------------
# Persistence settings
@@ -864,14 +930,16 @@
# Planet Aggregator settings
# Set to true to enable the Planet aggregator. This will cause:
-# - The main page of Roller will become an aggregated view of all blogs in the
-# Roller database, plus those defined in the Planet group 'external'.
# - A new menu tab will appear for Roller admin users. This allows admins to
# add/remove newsfeed subscriptions in the 'external' group.
# - Users can then subscribe to several newsfeeds:
# - http://localhost:8080/roller/rss
# - http://localhost:8080/roller/planetrss
# - http://localhost:8080/roller/planetrss?group=external
+# - You'll be able to add the $planet model to the list of page models available
+# to blogs (rendering.pageModels) or to only site-wide blogs (rendering.siteModels)
+# (classname org.apache.roller.ui.rendering.model.SiteModel)
+#
planet.aggregator.enabled=false
# Planet cache must exist and must be writable by Roller process
@@ -896,8 +964,7 @@
jroller.com|http://jroller.com,\
# comma-separated list of top-level categories to be created in each new weblog
-newuser.categories=\
-General,Status,Java,Music,Politics
+newuser.categories=General,Status,Java,Music,Politics
# Default weblog editor
# The list of available editors is in rollerRuntimeConfigDefs.xml
@@ -931,13 +998,33 @@
#----------------------------------
# misc settings
+# Characters to be allowed in user names (change at your own risk)
+username.allowedChars=A-Za-z0-9
+
rememberme.enabled=true
debug.memory.enabled=false
compression.gzipResponse.enabled=true
+# specifies the max number of tags allowed in URL ( /feed?tags=foo+bar+baz )
+tags.queries.maxIntersectionSize=3
+
# editor theme to be used (corresponds to directory name under /theme)
editor.theme=tan
+# Hibernate config resource (a classpath-based path)
+# NO NEED TO OVERRIDE this unless you are customizing Roller
+hibernate.configResource=/hibernate.cfg.xml
+
+# JDBC configuration parameters ONLY NEEDED FOR RUNNING STANDALONE TASKS
+# Don't override these in the roller-custom.properties file you use with the
+# Roller webapp, but for the standalone tasks that you run outside of Roller
+# (e.g. refresh entries) you'll need to override these properties. Do it in a
+# separate roller-custom.properties file.
+jdbc.driverClass=
+jdbc.connectionURL=
+jdbc.username=
+jdbc.password=
+
#---------------------------------
# settings for various plugins
@@ -972,5 +1059,4 @@
# settings for old #showNewseeds macro (not related to Planet stuff)
aggregator.enabled=false
aggregator.cache.enabled=
-aggregator.cache.timeout=14400
-
+aggregator.cache.timeout=14400
\ No newline at end of file
Modified: incubator/roller/branches/roller_3.1/docs/installguide/roller-install-guide.odt
URL: http://svn.apache.org/viewvc/incubator/roller/branches/roller_3.1/docs/installguide/roller-install-guide.odt?view=diff&rev=487817&r1=487816&r2=487817
==============================================================================
Binary files - no diff available.