Configuration

Configuration manual for PageSeeder

Global Properties

The global properties apply to the entire PageSeeder server.

These values, stored in global.properties, can be found in WEB-INF/config.

PropertyDescriptionDefault value

productKey

Product key for PageSeeder license

eval

projects

Number of projects allowed by PageSeeder license or unlimited

unlimited

topics

Number of groups allowed by PageSeeder license or unlimited

unlimited

members

Number of groups allowed by PageSeeder license or unlimited

unlimited

licenseExpires

The date when the PageSeeder license expires (ISO 8859 format YYYY-MM-DD)

 

publishEngineUrl

URL to use the Publish Engine on a different PageSeeder server (e.g. http://myserver.com/ps/servlet/publisher )

 

documentFolder

File system path for document storage. If not specified, it uses the [pageseeder install]/documents folder.

 

attachmentSubDir

The folder name within a group to place email attachments

attachments

maxUploadSize

The maximum size in bytes for an individual file being uploaded (if more than 1GB then Nginx client_max_body_size may need updating)

50000000

maxUploadNotificationAttachments

The maximum number of document attachments on an upload notification (if more than this then none are attached to the notification – there is no limit for email attachments).

20

emailMaxThreadMessages

If the number of recipients for a notification is more than this, the emails will be sent in the background.

20

mailServer

A boolean indicating that the PageSeeder mail server should be enabled

true

mailPort

Port for PageSeeder email server

25

mailIp

IP address to bind PageSeeder email server to if not all IPs

apiPort

HTTP port for local non HTTPS access (required if using HTTPS)

 

apiAccountUsernames

Comma separated list of API account usernames (apiAccountIPs must also be set). API account passwords cannot be reset.

apiAccountIPs

Comma-separated list of IP addresses from which API accounts can be used.

contentLineLength

Maximum line length when sending plain text email messages

80

notifyDailyTime

Time in 24 hour format when daily comment digests are sent out

23:59

notifyWeeklyDay

The day that weekly comment notifications are sent out (they are sent at the notifyDailyTime) – must be monday, tuesday, wednesday, thursday, friday, saturday or sunday.

sunday

smtpServerAddress

SMTP server to use for outgoing email messages (if blank outgoing email is disabled)

localhost

smtpServerPort

Port of SMTP server to use for outgoing email messages if not 25

smtpServerUsername

Username for SMTP authentication of outgoing emails

smtpServerPassword

Password for SMTP authentication of outgoing emails

notifyProcess

A boolean indicating that daily comment notifications should be enabled

true

diffXMaxEvents

Maximum size of number of words multiplied by number of compare words when diffing content in history

4000000

maxFacetSize

The maximum number of facets that can be returned by the GenericSearch servlet

100

minBadLogins

The minimum number of incorrect logins before an account is locked

5

maxBadLogins

The maximum number of incorrect logins before an account is locked

10

minAccountLockout

The minimum number of minutes an account can be locked for

30

maxAccountLockout

The maximum number of minutes an account can be locked for

60

redirectPortsComma-separated list of TCP ports which will be redirected to webSitePort in template.properties (e.g. 80,8080) – only supported on Windows, for Linux we recommend using Nginx.
logsFolder
 

Absolute folder path for log files. If not set, the pageseeder/webapp/WEB-INF/logs folder is used.

logsAccessLevel

Must be one of DEBUG, INFO, WARN, ERROR, OFF.
To log all access, use DEBUG or INFO.
To only log access that generates HTTP status code >= 400, use WARN.
To only log access that generates HTTP status code >= 500, use ERROR.
To not log any access, use OFF.

INFO
logsAccessHistory

Positive integer corresponding to the number of days the access log history is kept.

7

servletApi

Should always be 2.3

2.3

maxPageSize

The absolute maximum number of results returned per page

10000
passwordAlgorithm

The algorithm for hashing passwords – must be sN where N >=0 (weakest/fastest) and N<=9 (strongest/slowest).

s5
maxAttachmentSize

The maximum size of an attachment in a notification email in bytes.

10000000
maxAttachmentNumber

The maximum number of files that can be attached to a comment in the web interface.

20
maxWorkflowNotifications

The maximum number of notifications when adding bulk workflows by upload, folder or search (if more than this then none will be sent).

20
maxVersionNotifications

The maximum number of notifications when adding bulk versions by upload, folder or search (if more than this then none will be sent).

20
maxReverseXRefs

The maximum number of reverse XRefs that will be output in a PSML document (must not be more than maxPageSize).

1000
maxForwardXRefs

The maximum number of forward XRefs in a PSML document.

3000
maxOpenedIndexes

The maximum number of indexes which can be open at one time

50
maxIndexingThreads

The maximum number of indexing threads. More threads should increase indexing speed but should not be more than the number of CPUs on the server.

2
slowIndexingSize

Non-PSML files with larger than this number of bytes will join the slow indexing queue to conserve memory.

1000000
maxIndexingSize

Non-PSML files with larger than this number of bytes will not have their content indexed to conserve memory (for DocX this is the uncompressed size of the document.xml file).

30000000
serviceStrict

A boolean indicating whether an HTTP error should be returned for deprecated or non-released services.

false
emailEmbedImages

A boolean indicating that images in outgoing emails should be embedded as attachments – useful for intranet testing (always done when webSiteAddress=localhost or *.localhost).

false
webhookRequestInterval

The number of seconds to collect webook events into a batch before sending as a single request (0 means 0.5 seconds).

5
webhookRequestSize

The maximum number of bytes in a single webhook request (requests will be split if they exceed this limit).

500000
webhookRetries

The maximum number of times a failed webhook request will be resent before the webhook status is changed to "unreachable".

12

 

Deprecated properties

Deprecation warning!

The following properties have been deprecated and are no longer used in the latest version of PageSeeder.

PropertyDescriptionSince Version
attachmentDirFile system path to save email attachments to save them in PageSeeder.5.8
customPackagePackage name for customized java classes (requires a special license)5.93
mailRelayList of IP addresses that are allowed to send email using the PageSeeder email server.

5.7

Obsolete properties

This item is obsolete!

The following properties are obsolete and no longer used in recent versions of PageSeeder

PropertySince version
autoNoSeed5.1
autoSeed5.1
autoToolbar5.1 
backupExtension5.2
country
ignoreExtensions5.2
ignorePrefix5.2
indexExtension5.2 
htmlOutputEncoding
htmlSourceEncoding
language
mailReturnedAddress
manualExtension5.2
originalExtension5.2
notifyFromAddress
sessionPrefix
treeMaxObjects5.8
webExtension5.2

Notes

  • Wherever multiple values occur, the values are separated by commas. Spaces are not permitted before or after the comma.
  • For properties that expect Boolean flags, the allowable values are: 'true' or 'false'.
  • The Default values are provided for convenience only; check the 'global.properties' on your PageSeeder installation.

Created on , last edited on