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 2007/07/06 19:59:32 UTC
svn commit: r553975 -
/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/config/roller.properties
Author: snoopdave
Date: Fri Jul 6 10:59:31 2007
New Revision: 553975
URL: http://svn.apache.org/viewvc?view=rev&rev=553975
Log:
Reorganized into sections with important settings first, then directories, then feature specifics then all the rest. Nice and tidy and ready for the new installation guide.
Modified:
roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/config/roller.properties
Modified: roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/config/roller.properties
URL: http://svn.apache.org/viewvc/roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/config/roller.properties?view=diff&rev=553975&r1=553974&r2=553975
==============================================================================
--- roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/config/roller.properties (original)
+++ roller/trunk/apps/weblogger/src/java/org/apache/roller/weblogger/config/roller.properties Fri Jul 6 10:59:31 2007
@@ -40,6 +40,28 @@
# properties in this file are accessed like this ...
# WebloggerConfig.getProperty("propname");
+
+#-----------------------------------------------------------------------------
+# Table of contents
+#-----------------------------------------------------------------------------
+
+# -- Required configuration settings
+# -- Directory settings
+# -- Feature specific settings
+# -- Scheduled tasks configuration
+# -- Cache configuratation
+# -- Security settings
+# -- Rendering system
+# -- Weblog ping system
+# -- Pluggable backend, page and editor plugins
+# -- Other settings
+# -- Experimental, deprecated and "undocumented" settings
+
+
+#-----------------------------------------------------------------------------
+# Required configuration settings
+#-----------------------------------------------------------------------------
+
# Installation type 'auto' or 'manual'
# - Set to 'auto' if you'd like tables to be auto-created if they are not found
# on startup and auto-upgraded if they need it.
@@ -72,152 +94,191 @@
# For database configuration type of 'properties', you MUST override these
mail.hostname=
-mail.username
-mail.password
+mail.username=
+mail.password=
-#---------------------------------
-# Hibernate dialect: You MUST override this to use a database other than MySQL4
-hibernate.dialect=org.hibernate.dialect.MySQLDialect
+#-----------------------------------------------------------------------------
+# Directory settings
+#-----------------------------------------------------------------------------
-#---------------------------------
-# Pluggable backend
+# The directory in which Roller will upload files
+uploads.dir=${user.home}/roller_data/uploads
-# No need to touch these two settings unless you are customizing Roller
-guice.backend.module=org.apache.roller.weblogger.business.jpa.JPAWebloggerModule
+# The context path under which resoures will be made available
+uploads.url=/resources
+
+# The directory in which Roller will look for themes
+themes.dir=${webapp.context}
+
+# Directory in which search index is to be created
+# (delete this directory to force Roller to recreate the entire search index)
+search.index.dir=${user.home}/roller_data/search-index
+# If you enable Planet (see below), then you must specify the path to a cache
+# directory that exists and is writable by the Roller process
+planet.aggregator.cache.dir=${user.home}/roller_data/planetcache
-#---------------------------------
-# User management settings
+
+#-----------------------------------------------------------------------------
+# Feature specific settings
+#-----------------------------------------------------------------------------
# True to enable group blogging. False to prevent users from creating more
# than one weblog and from joining other weblogs.
groupblogging.enabled=true
-#---------------------------------
-# Property expansion settings
+#----------------------------------
+# search
-# Values of the properties in this list get system property expansion
-# applied to them when loaded.
-config.expandedProperties=uploads.dir,search.index.dir
+# Enables indexing of weblog entries and comments and enables search servlet
+search.enabled=true
+
+# Whether or not to include comments in the search index. If this
+# is false, comments are not included in the index.
+search.index.comments=true
#----------------------------------
-# Upload settings
+# comments and trackbacks
-# The directory in which Roller will upload files
-uploads.dir=${user.home}/roller_data/uploads
+comment.notification.hideCommenterAddresses=false
-# The context path under which resoures will be made available
-uploads.url=/resources
+# comment throttleing
+comment.throttle.enabled=false
+comment.throttle.threshold=25
+comment.throttle.interval=60
+comment.throttle.maxentries=250
-#----------------------------------
-# Themes settings
+# Plugable comment authentication
+comment.authenticator.classname=\
+org.apache.roller.weblogger.ui.rendering.plugins.comments.MathCommentAuthenticator
+
+# pluggable comment validation
+comment.validator.classnames=\
+org.apache.roller.weblogger.ui.rendering.plugins.comments.BlacklistCommentValidator,\
+org.apache.roller.weblogger.ui.rendering.plugins.comments.ExcessLinksCommentValidator,\
+org.apache.roller.weblogger.ui.rendering.plugins.comments.ExcessSizeCommentValidator
+#org.apache.roller.weblogger.ui.rendering.plugins.comments.AkismetCommentValidator
+
+comment.validator.excessLinks.threshold=3
+comment.validator.excessSize.threshold=1000
+#comment.validator.akismet.key=<get one at wordpress.com>
+
+# enables site full blacklist check on comment posts (default: true)
+site.blacklist.enable.comments=true
+
+# enables site full blacklist check at time of trackback post (default: true)
+site.blacklist.enable.trackbacks=true
+
+# enables partial blacklist check (not including blacklist.txt) for each incoming referrer
+site.blacklist.enable.referrers=true
+
+# Trackback protection. Set this only if you need to limit the URLs to
+# which users may send trackbacks. Regex expressions are allowed, for example:
+# trackback.allowedURLs=http://w3.ibm.com/.*||http://another.example.com/.*
+trackback.allowedURLs=
-# The directory in which Roller will look for themes
-themes.dir=${webapp.context}
#----------------------------------
-# Search index settings
+# Planet Aggregator settings
-# Enables indexing of weblog entries and comments and enables search servlet
-search.enabled=true
+# Set to true to enable the Planet aggregator. You also need to enable the
+# RefreshRollerPlanetTask task below to get the feed fetcher running.
+planet.aggregator.enabled=false
-# Directory in which search index is to be created (delete this directory to
-# force Roller to recreate the entire search index)
-search.index.dir=${user.home}/roller_data/search-index
+# Planet backend guice module, customized for use with Weblogger
+planet.aggregator.guice.module=\
+org.apache.roller.weblogger.planet.business.jpa.RollerPlanetModule
+
+# Number of queries allowed per day
+planet.aggregator.technorati.limit=500
-# Whether or not to include comments in the search index. If this
-# is false, comments are not included in the index.
-search.index.comments=true
#----------------------------------
-# Rendering system settings.
+# referrer processing
-# Are the old pre-3.0 models and macros enabled?
-rendering.legacyModels.enabled=false
+# Enable built-in referrer processing?
+referrers.processing.enabled=true
-# The set of default Roller renderer factories.
-rendering.rollerRendererFactories=\
-org.apache.roller.weblogger.ui.rendering.velocity.VelocityRendererFactory
+# Change to true if you want to process referrers asynchronously.
+# You can choose how many threads to use and sleep time (in seconds)
+referrers.asyncProcessing.enabled=false
+referrers.queue.numWorkers=3
+referrers.queue.sleepTime=10
-# List of available template languages
-rendering.templateLanguages=velocity
+# 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 that get a lot of legitimate crawler bot traffic.
+# The pattern here is a suggestion that has been reported to work well.
+#referrer.robotCheck.userAgentPattern=.*(slurp|bot|java).*
-# The set of user defined renderer factories. These are prepended to the list above.
-rendering.userRendererFactories=
-# The set of default Roller request mappers
-rendering.rollerRequestMappers=\
-org.apache.roller.weblogger.ui.rendering.WeblogRequestMapper
+#-----------------------------------------------------------------------------
+# Scheduled tasks configuration
+#-----------------------------------------------------------------------------
-# The set of user defined request mappers. These are prepended to the list above.
-rendering.userRequestMappers=
+# 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>]
-# Url path elements which can NEVER be considered a weblog url
-# each represents a url at the application root, i.e. /<elem>/*
-rendering.weblogMapper.rollerProtectedUrls=\
-roller-ui,images,theme,themes,CommentAuthenticatorServlet,\
-index.jsp,favicon.ico,robots.txt,\
-page,flavor,rss,atom,language,search,comments,rsd,resource,xmlrpc,planetrss
+# Tasks which are enabled. Only tasks listed here will be run.
+tasks.enabled=ScheduledEntriesTask,ResetHitCountsTask,TurnoverReferersTask,PingQueueTask
-# Set of user defined protected urls. These are added to the set above.
-rendering.weblogMapper.userProtectedUrls=
+# client identifier. should be unique for each instance in a cluster.
+tasks.clientId=defaultClientId
-# Set of models to be made available for weblog page rendering
-rendering.pageModels=\
-org.apache.roller.weblogger.ui.rendering.model.PageModel,\
-org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
-org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
-org.apache.roller.weblogger.ui.rendering.model.URLModel,\
-org.apache.roller.weblogger.ui.rendering.model.MessageModel,\
-org.apache.roller.weblogger.ui.rendering.model.CalendarModel,\
-org.apache.roller.weblogger.ui.rendering.model.MenuModel
+# Publish scheduled weblog entries
+tasks.ScheduledEntriesTask.class=org.apache.roller.weblogger.business.runnable.ScheduledEntriesTask
+tasks.ScheduledEntriesTask.startTime=immediate
+tasks.ScheduledEntriesTask.interval=1
+tasks.ScheduledEntriesTask.leaseTime=30
-# Set of models to be made available for weblog feed rendering
-rendering.feedModels=\
-org.apache.roller.weblogger.ui.rendering.model.FeedModel,\
-org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
-org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
-org.apache.roller.weblogger.ui.rendering.model.URLModel,\
-org.apache.roller.weblogger.ui.rendering.model.MessageModel
+# Reset hit counts
+tasks.ResetHitCountsTask.class=org.apache.roller.weblogger.business.runnable.ResetHitCountsTask
+tasks.ResetHitCountsTask.startTime=startOfDay
+tasks.ResetHitCountsTask.interval=1440
+tasks.ResetHitCountsTask.leaseTime=30
-# Set of models to be made available for weblog search rendering
-rendering.searchModels=\
-org.apache.roller.weblogger.ui.rendering.model.SearchResultsModel,\
-org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
-org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
-org.apache.roller.weblogger.ui.rendering.model.URLModel,\
-org.apache.roller.weblogger.ui.rendering.model.MessageModel,\
-org.apache.roller.weblogger.ui.rendering.model.CalendarModel,\
-org.apache.roller.weblogger.ui.rendering.model.MenuModel
+# Reset referer counts
+tasks.TurnoverReferersTask.class=org.apache.roller.weblogger.business.runnable.TurnoverReferersTask
+tasks.TurnoverReferersTask.startTime=startOfDay
+tasks.TurnoverReferersTask.interval=1440
+tasks.TurnoverReferersTask.leaseTime=30
-# 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.weblogger.ui.rendering.model.PreviewPageModel,\
-org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
-org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
-org.apache.roller.weblogger.ui.rendering.model.PreviewURLModel,\
-org.apache.roller.weblogger.ui.rendering.model.MessageModel,\
-org.apache.roller.weblogger.ui.rendering.model.CalendarModel,\
-org.apache.roller.weblogger.ui.rendering.model.MenuModel
+# Ping processor, does sending of pings
+tasks.PingQueueTask.class=org.apache.roller.weblogger.business.pings.PingQueueTask
+tasks.PingQueueTask.startTime=immediate
+tasks.PingQueueTask.interval=5
+tasks.PingQueueTask.leaseTime=30
-# Set of page models specifically for site-wide rendering
-rendering.siteModels=\
-org.apache.roller.weblogger.ui.rendering.model.SiteModel
+# Sync Roller weblogs with planet
+tasks.SyncWebsitesTask.class=org.apache.roller.weblogger.planet.tasks.SyncWebsitesTask
+tasks.SyncWebsitesTask.startTime=startOfDay
+tasks.SyncWebsitesTask.interval=1440
+tasks.SyncWebsitesTask.leaseTime=30
-# Velocity settings
-velocity.properties=/WEB-INF/velocity.properties
+# Refresh entries for planet feeds
+tasks.RefreshRollerPlanetTask.class=org.apache.roller.weblogger.planet.tasks.RefreshRollerPlanetTask
+tasks.RefreshRollerPlanetTask.startTime=startOfHour
+tasks.RefreshRollerPlanetTask.interval=60
+tasks.RefreshRollerPlanetTask.leaseTime=30
-# Old velocity macro libraries
-velocity.oldMacroLibraries=\
-deprecated/roller.vm,deprecated/bookmark.vm,deprecated/comments.vm,\
-deprecated/navbar.vm,deprecated/newsfeed.vm,deprecated/referer.vm,\
-deprecated/atommacros.vm,deprecated/rssmacros.vm,deprecated/user.vm,\
-deprecated/weblog.vm,deprecated/website.vm
+# Technorati rankings for planet feeds
+tasks.TechnoratiRankingsTask.class=org.apache.roller.weblogger.planet.tasks.TechnoratiRankingsTask
+tasks.TechnoratiRankingsTask.startTime=startOfDay
+tasks.TechnoratiRankingsTask.interval=1440
+tasks.TechnoratiRankingsTask.leaseTime=30
+
+
+#-----------------------------------------------------------------------------
+# Cache configuratation
+#-----------------------------------------------------------------------------
-#----------------------------------
-# Cache settings.
# Remember... times are in seconds
# Default settings suitable for 100 user system
@@ -261,8 +322,10 @@
cache.planet.size=10
cache.planet.timeout=1800
-#----------------------------------
-# Secure login configs
+
+#-----------------------------------------------------------------------------
+# Security settings
+#-----------------------------------------------------------------------------
# Enables HTTPS for login page only
securelogin.enabled=false
@@ -287,158 +350,122 @@
passwds.encryption.algorithm=SHA
#----------------------------------
-# Enabled plugins ... remember, order does matter!!
-
-# Weblog entry plugins
-plugins.page=\
-org.apache.roller.weblogger.business.plugins.entry.ConvertLineBreaksPlugin \
-,org.apache.roller.weblogger.business.plugins.entry.TopicTagPlugin \
-,org.apache.roller.weblogger.business.plugins.entry.ObfuscateEmailPlugin \
-,org.apache.roller.weblogger.business.plugins.entry.SmileysPlugin
-#,org.apache.roller.weblogger.business.plugins.entry.WikipediaLinkPlugin \
-#,org.apache.roller.weblogger.business.plugins.entry.GoogleLinkPlugin \
-#,org.apache.roller.weblogger.business.plugins.entry.AcronymsPlugin \
-#,org.apache.roller.weblogger.business.plugins.entry.BookmarkPlugin
-
-# The list of configured WeblogEntryEditors available to users
-plugins.weblogEntryEditors=\
-org.apache.roller.weblogger.ui.core.plugins.TextEditor,\
-org.apache.roller.weblogger.ui.core.plugins.XinhaEditor
-
-# The "id" of the default editor to use. NOT the class name
-plugins.defaultEditor=editor-text.jsp
-
-#----------------------------------
-# 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>]
-
-# Tasks which are enabled. Only tasks listed here will be run.
-tasks.enabled=ScheduledEntriesTask,ResetHitCountsTask,TurnoverReferersTask,PingQueueTask
-
-# client identifier. should be unique for each instance in a cluster.
-tasks.clientId=defaultClientId
-
-# Publish scheduled weblog entries
-tasks.ScheduledEntriesTask.class=org.apache.roller.weblogger.business.runnable.ScheduledEntriesTask
-tasks.ScheduledEntriesTask.startTime=immediate
-tasks.ScheduledEntriesTask.interval=1
-tasks.ScheduledEntriesTask.leaseTime=30
-
-# Reset hit counts
-tasks.ResetHitCountsTask.class=org.apache.roller.weblogger.business.runnable.ResetHitCountsTask
-tasks.ResetHitCountsTask.startTime=startOfDay
-tasks.ResetHitCountsTask.interval=1440
-tasks.ResetHitCountsTask.leaseTime=30
-
-# Reset referer counts
-tasks.TurnoverReferersTask.class=org.apache.roller.weblogger.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.weblogger.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.weblogger.planet.tasks.SyncWebsitesTask
-tasks.SyncWebsitesTask.startTime=startOfDay
-tasks.SyncWebsitesTask.interval=1440
-tasks.SyncWebsitesTask.leaseTime=30
+# Single-Sign-On
-# Refresh entries for planet feeds
-tasks.RefreshRollerPlanetTask.class=org.apache.roller.weblogger.planet.tasks.RefreshRollerPlanetTask
-tasks.RefreshRollerPlanetTask.startTime=startOfHour
-tasks.RefreshRollerPlanetTask.interval=60
-tasks.RefreshRollerPlanetTask.leaseTime=30
+# Enables Roller to behave differently when registering new users
+# in an SSO-enabled environment. You must configure security.xml appropriately.
+users.sso.enabled=false
-# Technorati rankings for planet feeds
-tasks.TechnoratiRankingsTask.class=org.apache.roller.weblogger.planet.tasks.TechnoratiRankingsTask
-tasks.TechnoratiRankingsTask.startTime=startOfDay
-tasks.TechnoratiRankingsTask.interval=1440
-tasks.TechnoratiRankingsTask.leaseTime=30
+# Set these properties for a custom LDAP schema (optional)
+#users.sso.registry.ldap.attributes.name=cn
+#users.sso.registry.ldap.attributes.email=mail
+#users.sso.registry.ldap.attributes.locale=locale
+#users.sso.registry.ldap.attributes.timezone=timezone
+# If you don't want user credentials from LDAP/etc to be stored in Roller
+# (possibly in clear-text) leave this alone, otherwise set to true.
+# i.e. you would like a backup auth mechanism in case LDAP is down.
+users.sso.passwords.save=false
-#----------------------------------
-# comment authentication
+# if you don't want passwords stored in DB, set this to the default value.
+users.sso.passwords.defaultValue=<unknown>
-comment.authenticator.classname=org.apache.roller.weblogger.ui.rendering.plugins.comments.MathCommentAuthenticator
+users.sso.autoProvision.enabled=false
+users.sso.autoProvision.className=\
+org.apache.roller.weblogger.ui.core.security.BasicUserAutoProvision
-#----------------------------------
-# comment notification
-comment.notification.hideCommenterAddresses=false
+#-----------------------------------------------------------------------------
+# Rendering system
+#-----------------------------------------------------------------------------
-#----------------------------------
-# comment throttleing
+# Are the old pre-3.0 models and macros enabled?
+rendering.legacyModels.enabled=false
-comment.throttle.enabled=false
-comment.throttle.threshold=25
-comment.throttle.interval=60
-comment.throttle.maxentries=250
+# The set of default Roller renderer factories.
+rendering.rollerRendererFactories=\
+org.apache.roller.weblogger.ui.rendering.velocity.VelocityRendererFactory
-#----------------------------------
-# comment validation
+# List of available template languages
+rendering.templateLanguages=velocity
-comment.validator.classnames=\
-org.apache.roller.weblogger.ui.rendering.plugins.comments.BlacklistCommentValidator,\
-org.apache.roller.weblogger.ui.rendering.plugins.comments.ExcessLinksCommentValidator,\
-org.apache.roller.weblogger.ui.rendering.plugins.comments.ExcessSizeCommentValidator
-#org.apache.roller.weblogger.ui.rendering.plugins.comments.AkismetCommentValidator
+# The set of user defined renderer factories. These are prepended to the list above.
+rendering.userRendererFactories=
-comment.validator.excessLinks.threshold=3
-comment.validator.excessSize.threshold=1000
-#comment.validator.akismet.key=<get one at wordpress.com>
+# The set of default Roller request mappers
+rendering.rollerRequestMappers=\
+org.apache.roller.weblogger.ui.rendering.WeblogRequestMapper
-#----------------------------------
-# comment, trackback and referrer blacklisting
+# The set of user defined request mappers. These are prepended to the list above.
+rendering.userRequestMappers=
-# enables site full blacklist check on comment posts (default: true)
-site.blacklist.enable.comments=true
+# Url path elements which can NEVER be considered a weblog url
+# each represents a url at the application root, i.e. /<elem>/*
+rendering.weblogMapper.rollerProtectedUrls=\
+roller-ui,images,theme,themes,CommentAuthenticatorServlet,\
+index.jsp,favicon.ico,robots.txt,\
+page,flavor,rss,atom,language,search,comments,rsd,resource,xmlrpc,planetrss
-# enables site full blacklist check at time of trackback post (default: true)
-site.blacklist.enable.trackbacks=true
+# Set of user defined protected urls. These are added to the set above.
+rendering.weblogMapper.userProtectedUrls=
-# enables partial blacklist check (not including blacklist.txt) for each incoming referrer
-site.blacklist.enable.referrers=true
+# Set of models to be made available for weblog page rendering
+rendering.pageModels=\
+org.apache.roller.weblogger.ui.rendering.model.PageModel,\
+org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
+org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
+org.apache.roller.weblogger.ui.rendering.model.URLModel,\
+org.apache.roller.weblogger.ui.rendering.model.MessageModel,\
+org.apache.roller.weblogger.ui.rendering.model.CalendarModel,\
+org.apache.roller.weblogger.ui.rendering.model.MenuModel
-#----------------------------------
-# restricted trackbacks
+# Set of models to be made available for weblog feed rendering
+rendering.feedModels=\
+org.apache.roller.weblogger.ui.rendering.model.FeedModel,\
+org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
+org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
+org.apache.roller.weblogger.ui.rendering.model.URLModel,\
+org.apache.roller.weblogger.ui.rendering.model.MessageModel
-# Trackback protection. Set this only if you need to limit the URLs to
-# which users may send trackbacks. Regex expressions are allowed, for example:
-# trackback.allowedURLs=http://w3.ibm.com/.*||http://another.example.com/.*
-trackback.allowedURLs=
+# Set of models to be made available for weblog search rendering
+rendering.searchModels=\
+org.apache.roller.weblogger.ui.rendering.model.SearchResultsModel,\
+org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
+org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
+org.apache.roller.weblogger.ui.rendering.model.URLModel,\
+org.apache.roller.weblogger.ui.rendering.model.MessageModel,\
+org.apache.roller.weblogger.ui.rendering.model.CalendarModel,\
+org.apache.roller.weblogger.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.weblogger.ui.rendering.model.PreviewPageModel,\
+org.apache.roller.weblogger.ui.rendering.model.ConfigModel,\
+org.apache.roller.weblogger.ui.rendering.model.UtilitiesModel,\
+org.apache.roller.weblogger.ui.rendering.model.PreviewURLModel,\
+org.apache.roller.weblogger.ui.rendering.model.MessageModel,\
+org.apache.roller.weblogger.ui.rendering.model.CalendarModel,\
+org.apache.roller.weblogger.ui.rendering.model.MenuModel
-#----------------------------------
-# referrer processing
+# Set of page models specifically for site-wide rendering
+rendering.siteModels=\
+org.apache.roller.weblogger.ui.rendering.model.SiteModel
-#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
-#that get a lot of legitimate crawler bot traffic. The pattern here is a suggestion that
-#has been reported to work well.
-#referrer.robotCheck.userAgentPattern=.*(slurp|bot|java).*
+# Velocity settings
+velocity.properties=/WEB-INF/velocity.properties
-# Enable built-in referrer processing?
-referrers.processing.enabled=true
+# Old velocity macro libraries
+velocity.oldMacroLibraries=\
+deprecated/roller.vm,deprecated/bookmark.vm,deprecated/comments.vm,\
+deprecated/navbar.vm,deprecated/newsfeed.vm,deprecated/referer.vm,\
+deprecated/atommacros.vm,deprecated/rssmacros.vm,deprecated/user.vm,\
+deprecated/weblog.vm,deprecated/website.vm
-# Change to true if you want to process referrers asynchronously.
-# You can choose how many threads to use and sleep time (in seconds)
-referrers.asyncProcessing.enabled=false
-referrers.queue.numWorkers=3
-referrers.queue.sleepTime=10
-#----------------------------------
-# ping settings
+#-----------------------------------------------------------------------------
+# Weblog ping system
+#-----------------------------------------------------------------------------
# The number of attempts to try to reach a ping target before refusing to
# requeue it for further retrials. If absent, this defaults to 3.
@@ -468,8 +495,7 @@
,{{IceRocket}{http://rpc.icerocket.com:10080/}}
# Specify variant options for known buggy ping targets.
-pings.variantOptions=\
-{{http://rpc.icerocket.com:10080/}{noname}}
+pings.variantOptions={{http://rpc.icerocket.com:10080/}{noname}}
# This controls whether users are allowed to add custom ping targets.
@@ -501,82 +527,39 @@
# commented for normal behavior.
pings.logOnly=false
-#----------------------------------
-# Planet Aggregator settings
-
-# Set to true to enable the Planet aggregator. This will cause:
-# - 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.weblogger.ui.rendering.model.SiteModel)
-#
-planet.aggregator.enabled=false
-# planet backend guice module, customized for use with weblogger
-planet.aggregator.guice.module=org.apache.roller.weblogger.planet.business.jpa.RollerPlanetModule
+#-----------------------------------------------------------------------------
+# Pluggable backend, page and editor plugins
+#-----------------------------------------------------------------------------
-# Planet cache must exist and must be writable by Roller process
-planet.aggregator.cache.dir=/var/roller/planetcache
+# Backend Guice module
+guice.backend.module=org.apache.roller.weblogger.business.jpa.JPAWebloggerModule
-# Number of queries allowed per day
-planet.aggregator.technorati.limit=500
+#---------------------------------
+# Weblog entry plugins
-#----------------------------------
-# defaults for new weblogs
+plugins.page=\
+org.apache.roller.weblogger.business.plugins.entry.ConvertLineBreaksPlugin \
+,org.apache.roller.weblogger.business.plugins.entry.TopicTagPlugin \
+,org.apache.roller.weblogger.business.plugins.entry.ObfuscateEmailPlugin \
+,org.apache.roller.weblogger.business.plugins.entry.SmileysPlugin
+#,org.apache.roller.weblogger.business.plugins.entry.WikipediaLinkPlugin \
+#,org.apache.roller.weblogger.business.plugins.entry.GoogleLinkPlugin \
+#,org.apache.roller.weblogger.business.plugins.entry.AcronymsPlugin \
+#,org.apache.roller.weblogger.business.plugins.entry.BookmarkPlugin
-# list of links to include in root bookmark folder of each new blog
-# format is like so: linktitle2|linkurl2,linktitle2|linkurl2,linktitle3|linkurl3
-newuser.blogroll=\
-Dave Johnson|http://rollerweblogger.org/roller,\
-Matt Raible|http://raibledesigns.com/page/rd,\
-Lance Lavandowska|http://rollerweblogger.org/lance,\
-Henri Yandell|http://blog.generationjava.com/,\
-Elias Torres|http://torrez.us/,\
-Jeff Blattman|http://blogs.sun.com/jtb,\
-blogs.sun.com|http://blogs.sun.com,\
-jroller.com|http://jroller.com
+# The list of configured WeblogEntryEditors available to users
+plugins.weblogEntryEditors=\
+org.apache.roller.weblogger.ui.core.plugins.TextEditor,\
+org.apache.roller.weblogger.ui.core.plugins.XinhaEditor
-# comma-separated list of top-level categories to be created in each new weblog
-newuser.categories=\
-General,Status,Java,Music,Politics
+# The "id" of the default editor to use. NOT the class name
+plugins.defaultEditor=editor-text.jsp
# Default weblog editor
# The list of available editors is in rollerRuntimeConfigDefs.xml
newweblog.editor=editor-text.jsp
-
-#----------------------------------
-# Single-Sign-On
-
-# Enables Roller to behave differently when registering new users
-# in an SSO-enabled environment. You must configure security.xml appropriately.
-users.sso.enabled=false
-
-# Set these properties for a custom LDAP schema (optional)
-#users.sso.registry.ldap.attributes.name=cn
-#users.sso.registry.ldap.attributes.email=mail
-#users.sso.registry.ldap.attributes.locale=locale
-#users.sso.registry.ldap.attributes.timezone=timezone
-
-# If you don't want user credentials from LDAP/etc to be stored in Roller
-# (possibly in clear-text) leave this alone, otherwise set to true.
-# i.e. you would like a backup auth mechanism in case LDAP is down.
-users.sso.passwords.save=false
-
-# if you don't want passwords stored in DB, set this to the default value.
-users.sso.passwords.defaultValue=<unknown>
-
-users.sso.autoProvision.enabled=false
-users.sso.autoProvision.className=org.apache.roller.weblogger.ui.core.security.BasicUserAutoProvision
-
-#---------------------------------
-# settings for various plugins
-
# 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.
@@ -589,9 +572,16 @@
# Set to true to allow only default topic tag site (and avoid costly bookmark queries)
plugins.topictag.ignoreBookmarks=true
-#----------------------------------
-# misc settings
+#-----------------------------------------------------------------------------
+# Other settings
+#-----------------------------------------------------------------------------
+
+# Values of the properties in this list get system property expansion
+# applied to them when loaded.
+config.expandedProperties=uploads.dir,search.index.dir
+
+# True to enable history in Atom feeds with next/prev links
site.newsfeeds.history.enabled=false
# Some folks consider remember-me type functionality to be a security
@@ -609,8 +599,25 @@
# editor theme to be used (corresponds to directory name under /theme)
editor.theme=tan
-#---------------------------------
-# Experimental settings
+# list of links to include in root bookmark folder of each new blog
+# format is like so: linktitle2|linkurl2,linktitle2|linkurl2,linktitle3|linkurl3
+newuser.blogroll=\
+Dave Johnson|http://rollerweblogger.org/roller,\
+Matt Raible|http://raibledesigns.com/page/rd,\
+Lance Lavandowska|http://rollerweblogger.org/lance,\
+Henri Yandell|http://blog.generationjava.com/,\
+Elias Torres|http://torrez.us/,\
+Jeff Blattman|http://blogs.sun.com/jtb,\
+blogs.sun.com|http://blogs.sun.com,\
+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
+
+
+#-----------------------------------------------------------------------------
+# Experimental, deprecated and "undocumented" settings
+#-----------------------------------------------------------------------------
# Atom Publishing Protocol (APP) - this is an incomplete and untested
# implementation of an unfinished IETF specification.
@@ -625,12 +632,6 @@
# Intended only for interoperability testing. DO NOT ENABLE IN PRODUCTION!
webservices.adminprotocol.enabled=false
-#----------------------------------
-# legacy settings (things that should be deprecated)
-
-# settings for old #showNewseeds macro (not related to Planet stuff)
-aggregator.enabled=false
-aggregator.cache.enabled=
-aggregator.cache.timeout=14400
-
-debug.memory.enabled=false
+# If you are using the Hibernate backend (deprecated as of Roller 4.0),
+# you MUST override this to use a database other than MySQL4
+hibernate.dialect=org.hibernate.dialect.MySQLDialect