The Hippo CMS is very configurable, here are some of the settings.
Jetty Properties
| Property name |
Optional? |
Description |
| maven.jetty.port |
Yes |
Specifies the port jetty should listen on. (Default is 8888) |
| maven.jetty.maxformcontentsize |
Yes |
Limits the size of the data a client can push at the server (Default is 200000 bytes) |
Cocoon properties
Site properties
| Property name |
Optional? |
Description |
| maven.cocoon.site.domain |
No |
Sets domain HippoCMS will be running on. |
| maven.cocoon.site.version |
Yes |
Sets the HippoCMS version. |
| maven.cocoon.site.displayname |
Yes |
Sets the displayname that is used by the CMS. |
| maven.cocoon.site.name |
No |
Sets the name for the configured site. This name will be written into the sites.xconf. |
Repository properties
| Property name |
Optional? |
Description |
| maven.cocoon.repository.name |
No |
Sets the name of the repository used by the repository.xconf. |
| maven.cocoon.repository.port |
No |
Sets the port Hippo-repository is running on. |
| maven.cocoon.repository.host |
No |
Sets the host Hippo-repository is running on. |
| maven.cocoon.repository.filespath |
No |
Sets the filespath for the repository. (Should look something like: /files/${maven.cocoon.repository.name}.preview) |
| maven.cocoon.repository.rootpath |
No |
Sets the rootpath for the repository. (Should look something like: /$
{maven.cocoon.repository.name} |
| maven.cocoon.repository.authenticationrealm |
No |
Sets the repository authentication realm. |
| maven.cocoon.repository.systemcredentials.username |
No |
Sets the repository user. |
| maven.cocoon.repository.systemcredentials.password |
No |
Sets the password for the repository user. |
Global cocoon memory settings
Please take extreme care when setting the build.properties of your Cocoon project.
 | Always make sure to configure both maven.wrapper.maxmemory (in mb's) and maven.cocoon.heapsize (in bytes, 20 mb lower). |
| Property name |
Optional |
Default |
Description |
| maven.wrapper.initmemory |
No |
64 |
Sets the amount of memory in megabytes the JVM initially gets assigned by the Wrapper. This is patched into /bin/wrapper.conf. 64 is a good start - no real need to make this higher. |
| maven.wrapper.maxmemory |
No |
128 |
Sets the maximum mount of memory in megabytes the JVM assigns to the Wrapper. This is patched into /bin/wrapper.conf. 128 is pretty standard, but values anywhere between 128 and 512 are common. Whenever you change this value, immidiately change the maven.cocoon.heapsize too! |
| maven.cocoon.heapsize |
No |
108000000 |
Sets the maximum amount of memory Cocoon's (cache) store takes from within the JVM in bytes. This is patched into /cocoon/WEB-INF/cocoon.xconf. Take extreme care with the amount of zero's assigned - it's in bytes! This value should be approximately 20mb lower than maven.wrapper.maxmemory. |
| maven.cocoon.store.maxobjects |
No |
1100 |
Sets the maximum number of objects stored by Cocoon in store in the {{/cocoon/WEB-INF/cocoon.xconf }}
DEPRECATED SINCE HIPPO COCOON 2.1.8.11 |
| maven.cocoon.transientstore.maxobjects |
No |
1200 |
Sets the maximum number of objects stored by Cocoon in transient-store in the {{/cocoon/WEB-INF/cocoon.xconf }}
DEPRECATED SINCE HIPPO COCOON 2.1.8.11 |
| maven.cocoon.continuations.ttl |
No |
3600000 |
Sets the number of seconds a continuation should live. Patched into the /cocoon/WEB-INF/cocoon.xconf |
| timeToLiveSeconds |
yes |
0 |
| timeToIdleSeconds |
yes |
10800 |
CMS properties
| Property name |
Optional? |
Description |
| cms.model |
No |
This tells the CMS where it can find its documenttypes. Should look something like: context://types/types.xml or repository://types/types.xml |
| cms.preview.url |
Yes |
This tells the CMS the preview url. If an empty value is used, the preview button in the CMS will dissapear. |
| cms.fileimportservice.url |
Yes |
This tells the CMS the fileimportservice url. If an empty value is used, the fileimport button in the CMS will dissapear. |
| cms.autonomy.url |
Yes |
This tells the CMS the url for autonomy. If an empty value is used, the autonomy button in the CMS will dissapear. |
| cms.perspectives.search |
No |
This will tell the CMS if it uses the search perspective. Values can be off or on. |
| cms.history.actions |
No |
This will tell the CMS if it uses history actions. Values can be off or on. |
| cms.use.trash.bin |
Yes |
This will tell the CMS to move deleted items to the trash bin or not. Value can be 'off' or 'on'.
|
cms.use.locking
|
Yes |
This will tell the CMS to lock documents while they are being edited. Value can be 'off' or 'on'.
|
cms.tree.sortby
|
Yes |
This will tell the CMS left tree panel to order on which property. Default 'caption'.
|
cms.tree.sortorder
|
Yes |
This will tell the CMS left tree panel how to order. Default 'ascending'
|
cms.tree.paging
|
Yes |
Since Hippo CMS version 6.05.03. This will tell the CMS documents and assets listing to use paging. Default 'true'
|
cms.tree.pagesize
|
Yes |
Since Hippo CMS version 6.05.03. This will set the # of pages that will be displayed per page when paging is enabled. Default '20'
|
cms.inline-upload.maxsize
|
No |
Control the maximum size of inline-uploaded images. Default is '40' KB
|
cms.linkchecker.active
|
No |
Since Hippo CMS version 6.05.01. Enable the linkchecker background task, which checks both internal and external links in all XML documents. Default is 'false'. See documentation
|
cms.linkchecker.cron
|
No |
Since Hippo CMS version 6.05.01. A cron expression desribing when the linkchecker background task will run. Default is daily at 3:30 AM. See documentation
|
cms.linkchecker.interval
|
No |
Since Hippo CMS version 6.05.01. The period (in seconds) in which the linkchecker background task will run. Default is '86400' (which is one day). See documentation
|
cms.startup.function
|
Yes |
Since Hippo CMS version 6.05.03. This will tell the CMS what flowscript function to use to start the CMS, default is 'start'. See documentation
|
Project specific properties
| Property name |
Optional? |
Description |
| cms.project-specific.sitemap |
Yes |
This property points to a project specific sitemap, which is mostly used for custom processing in combination with the editor. Default value is repository://configuration/project-specific/sitemap.xmap. |
| cms.project-specific.i18n-htmlarea-popups |
Yes |
When using HTMLArea (e.g. in CForms XML Editor), this property determines whether to use i18n popups (true) or use the original CForms popups(false). Default is false. DEPRECATED SINCE 6.03.00 |
Workflow properties
Workflow quartzscheduler configuration
| Property name |
Optional? |
Description |
| cms.datasource.quartz.name |
Yes |
This tells the cronjob what databasename to use. |
| cms.datasource.quartz.url |
Yes |
This tells the cronjob the connection string to the database. Should look something like jdbc:mysql://{host}/osworkflow_{projectname}?characterEncoding=latin1 |
| cms.datasource.quartz.user |
Yes |
This tells the cronjob usercredentials for the database. |
| cms.datasource.quartz.password |
Yes |
This tells the cronjob usercredentials for the database. |
Workflow store configuration
| Property name |
Optional? |
Description |
| workflow.localdevdomains |
No |
Sets the domain the cms is running on. |
| workflow.localdevWorkflow.datasource.url |
Yes |
This tells the workflow the connection string to the database. Should look something like jdbc:mysql://{host}/dev_projectdata |
| workflow.localdevWorkflow.datasource.username |
Yes |
This tells the workflow usercredentials for the database. |
| workflow.localdevWorkflow.datasource.password |
Yes |
This tells the workflow usercredentials for the database. |
| workflow.localdevWorkflow.datasource.driver |
Yes
|
This sets the datasource driver. Should be something like org.hsqldb.jdbcDriver
|
| cms.workflow.store.role |
Yes |
Sets workflow store role. Should be something like: com.opensymphony.workflow.spi.WorkflowStore/mysql |
| cms.workflow.store.class |
Yes |
Sets workflow store class. Should be something like: nl.hippo.workflow.store.ExcaliburMySQLWorkflowStore |
| cms.workflow.store.datasource.name |
Yes |
Sets workflow store datasource name. |
Lucene properties
| Property name |
Optional? |
Description |
| lucene.index.path |
Yes |
Sets the path where the lucene index can be found. |
Debug properties
| Property name |
Optional? |
Description |
| log4j.loglevel |
No |
Used to set the debuglevel. Possible values: INFO,WARN,ERROR,DEBUG |
| logkit.cms.loglevel |
No |
Used to set the CMS debuglevel. Possible values: INFO,WARN,ERROR,DEBUG |
Page Operations
Browse Space
I think it could be useful to provide an indication of which 'realm' each of these properties is usable in.
i.e. 'Repository Setup', 'CMS Setup', 'Site Setup' or all three.