| Administering the Community / Fine-Tuning with System Properties | |
System properties configure application-wide settings. Some of the settings correspond to configuration elements in the Admin Console user interface.
To make changes to system properties, in the Admin Console go to . Keep in mind that both property names and values are case-sensitive.
The following is a list of system properties that are set by default when you install Jive.
| Property | Description |
|---|---|
| blog.searchComments.enabled | true to enable return of comments on search; false to disable it (default: true). |
| bridge.connection.proxy.host | Specify the host name of the proxy server so Jive can bring information from the internet into the community for bridging. Make sure the proxy server does not require a username and password because its not supported by the client used for bridging. |
| bridge.connection.proxy.port | Specify the port for the proxy server. |
| browse.main.docs.show.space.browser | true to have the Documents page use the original space browsing UI. |
| browse.main.threads.show.space.browser | true to have the Discussions page use the original space browsing UI. |
| checkmail.host | Email server name used for verifying mail settings provided in the System - Settings - Email Server screen in the Admin Console. |
| checkmail.port | Email server port used for verifying mail settings provided in the System - Settings - Email Server screen in the Admin Console (default: 110) |
| checkmail.protocol | Email protocol used for verifying mail settings provided in the System - Settings - Email Server screen in the Admin Console (default: pop3) |
| communityThreadCount.updateInterval.seconds | The interval, in seconds, between updates to the count of discussions displayed in the community -- such as on the "Discussions" tab of a social group. Default is 5 seconds. |
| document.searchComments.enabled | true to enable return of comments on search; false to disable it (default: true). |
| documentmanager.correctdeletedusers.completed | Determines if the CorrectDeletedUsersTask should run, which finds all the documents in the system and check to make sure that the original author of the document hasn't been deleted. If the author has been deleted, then this task sets the author to "guest" (id: -1) |
| email.search.allowWhiteSpace | Set to true if you want people search to allow white spaces in the email field. Default is false. |
| feeds.protected | Determines whether or not feeds are protected by Basic Authentication. |
| GroupManager.className | Qualified class name for the default GroupManager implementation. Modify this property to identify a custom GroupManager implementation to associate users with various groups on the system. |
| http.proxyHost | Specify the host name of the proxy server so Jive can bring information from the internet into the community for certain features, such as RSS, bookmarks, and bridging. |
| http.proxyPort | Specify the port for the proxy server. |
| http.proxyUsername | Specify the username for your proxy server, if required. |
| http.proxyPassword | Specify the password for your proxy server, if required. |
| i18n.allowedLanguages | Not currently used |
| i18n.defaultLanguage | Not currently used |
| ip.header.max.depth | Specifies how many email jumps are secure from the X_FORWARDED_FOR email header. This is designed to reduce the possibility of a fake header when the header is set by a proxy. With this set, the application takes the IP at the position given to get to a known trustworthy address. For example, if the value of X_FORWARDED_FOR is "127.0.0.5, 10.61.8.223, 10.61.201.116, 10.61.3.9" (there are four IPs in the list) and ip.header.max.depth is set to 2, then the remote address will be interpreted as 10.61.201.116. If this property is not set, or is set to 0, the application takes the head of the list of addresses (the 0 position). |
| jive.APIThrowsClause.enabled | Setting to true adds a security string to the beginning of every core V3 JSON response and all data returned via API. Setting to false with no query parameters removes the security string, except for vulnerable arrays. When you set to false and you add a noThrows=true query parameter, the security string is removed for all data, even vulnerable arrays. Default is false with no parameters. |
| jive.auth.disallowGuest | Determines whether or not non-authenticated users are not allowed. When this property is set to true, any non-authenticated user will be redirected to the login page for all requests. |
| jive.bodyConversionTask.completed | Determines if the BodyConversionTask should run, which goes through all messages, documents, blog posts, comments, and announcements and converts their bodies to the new xml storage format, backing up the previous content if any changes were made. |
| jive.container.category.tagcloudmax | The maximum number of tags shown in a tag cloud when filtering content by categories and tags. This is an integer that defaults to 30. A very high number might impair performance or cause UI problems. |
| jive.devMode | Set to true to ensure that images, attachments, and binary documents are not cached. Also turns off page compression when set to false in conjunction with the jive.compressionFilter.enabled property being set to false. |
| jive.digest.enabled | false to disable the email digest feature. The feature is designed to send email to users with a summary of their activity in the community. |
| jive.digest.email.sendHour | Hour of the day at which digest emails are sent to users who have requested them in their preferences. The value should be a simple integer indicating the hours of the day. Examples are "10" for 10 a.m., "14" for 2 p.m., and "23" for 11 p.m. Default is 9. |
| jive.dv.service.connection.verification | true to have the application server test its connection with the document conversion machine before using the connection. You might want to set this to false if you're unable to open TCP port 7 (which is used for the test) on the conversion machine. |
| jive.featuredcontent.enabled | false to disable the featured content feature. The feature is enabled by default. |
| jive.featuredcontent.objecttype.<typevalue> | false to disable featuring for the specified kind of content. Append the objecttype value of the content you want to disable. For example, to disable documents set it this way: jive.featuredcontent.objecttype.102 = false. All types are enabled by default. |
| jive.freemarker.templateUpdateDelay | Set to 1 to tell the application to look for changes to theme files. When you're editing theme FTL files outside of the Admin Console, use this property and value to ensure that your changes are picked up as you make them. (Because it can slow performance, be sure to remove this property for your production instance.) |
| jiveInstanceId | The universally unique instance of the application cluster, used to distinguish each server node in a clustered server configuration. |
| jive.module.video.enabled | Set to true if you want
enable the video feature by default with only the Embed a Video option
(not upload or record). Default is true. Note: You can use
video.upload.enabled and video.webcam.enabled to enable/disable those
features (both are true by default).
|
| jive.pageCached.enabled | Freemarker pages are cached by default in versions 2.0 and greater (default = true even if not set in the Admin Console). Set this property to false to turn off caching for development purposes, which will allow theme changes to be reflected immediately in the UI without restarting the server. Page caching should be enabled for production instances however, to increase performance. |
| jive.pdf.paper.size | Specifies the default paper size for PDF files generated from content. The following values are supported: ANSI_A, ANSI_B, ANSI_C, ANSI_D, ANSI_E, ISO_A0, ISO_A1, ISO_A2, ISO_A3, ISO_A4, ISO_A5, ISO_A6, ISO_A7, ISO_A8, ISO_A9, ISO_A10, ISO_B0, ISO_B1, ISO_B2, ISO_B3, ISO_B4, ISO_B5, ISO_B6, ISO_B7, ISO_B8, ISO_B9, ISO_B10, ISO_C0, ISO_C1, ISO_C2, ISO_C3, ISO_C4, ISO_C5, ISO_C6, ISO_C7, ISO_C8, ISO_C9, ISO_C10, JIS_0, JIS_1, JIS_2, JIS_3, JIS_4, JIS_5, JIS_6, JIS_7, JIS_8, JIS_9, JIS_10, JIS_11, JIS_12 |
| jive.sync.profile.ldap.login | Determines whether LDAP-provided user profile fields should be refreshed when users log in. Set to false for external communities where LDAP is not commonly used (default: true) |
| jive.sync.relationships.ldap | true to use LDAP to build the organizational chart and specify reporting relationships. |
| jiveURL | The base URL of the installation. This must be set in order for the application to work correctly. |
| jive.user.lastname.firstname.enabled | Determines whether user names are stored as two values -- one each for first and last names. If the value is false, then user names are stored as a single value combining first and last names. This is set during application setup. |
| jive.usercontainer.document.enabled | false to turn off the "Your Documents" feature. |
| jive.usercontainer.thread.enabled | false to turn off the private discussions feature. |
| jive.xmpp.enabled | Determines whether the XMPP service is enabled. |
| ldap.adminPassword.key | The private key used to decrypt the LDAP password in the database. |
| ldap.searchFilter | no longer used |
| log4j.threshold | The level at which logging messages will be recorded (default: ERROR) |
| mail.smtp.host | Mail server used for sending notifications and messages to users |
| mail.smtp.port | Mail server port used for mail notifications |
| mail.valid.tld.pattern | Identifies the valid TLDs pattern used to validate email addresses. The default pattern is com|net|org|edu|int|mil|gov|arpa|biz|aero|name|coop|info|pro|museum|mobi|cat|jobs|asia|tel|travel and accepts email addresses ending in these suffixes, for example user@email.travel. This can be changed by adding the new supported TLD to the end of the list. For example, to support qlat append |qlat to the property to make it com|net|org|edu|int|mil|gov|arpa|biz|aero|name|coop|info|pro|museum|mobi|cat|jobs|asia|tel|travel|qlat |
| officeintegration.enabled | true to enable support for a preview view of some documents, including PDFs and those from Microsoft Office; default is false. |
| opensearch.key | Unique ID used for external search engine integration |
| passwordReset.caseSensitive | true to allow case-sensitive lookup of usernames when setting a password; default is true. Set this to false to allow for case-insensitive username lookup when resetting a password. When this is set to false, if two username values differ only by case, a password reset may fail with an error message until distinct usernames are created. To avoid this, you need to manually change one of the usernames to make the usernames different for case insensitivity. |
| polls.voting.private | true to exclude poll votes from visible activity. The default value -- false -- will allow poll votes to appear among other recent activity. |
| profile.security.collagues.mgr.enabled | true to specify that a person's manager is included in the "Colleagues" option when the person is setting visibility for a profile field. Default is true. If you change this property, you must rebuild the user search index for the changes to take effect. See Configuring Main Search for more information. |
| profile.security.collagues.drpts.enabled | true to specify that a person's direct reports are included in the "Colleagues" option when the person is setting visibility for a profile field. Default is true. If you change this property, you must rebuild the user search index for the changes to take effect. See Configuring Main Search for more information. |
| search.indexCreated | Tracks the last time the search index was created (set by the system) |
| search.indexVersion | The version of the currently used user index. |
| skin.default.displayFullNames | Set to true to display the full names of users, or false to use their username. |
| skin.default.newAccountCreationEnabled | Determines whether users are allowed to register to create a new account (default: true) |
| system.adminuser.email | The default email address that the system will use when sending email notifications |
| system.adminuser.fromName | The default "From" name that the system will use when sending email notifications |
| update.lastCheck | Tracks the last time the system checked for updates to plugins or the server (set by the system). New versions of plugins can be downloaded and installed. However, new server releases should be manually installed. |
| ur.graph.hier.default.ID | The ID of the default (hierarchical) org chart graph. |
| ur.graph.mesh.default.ID | The ID of the default (mesh) friends/connections graph. |
| user.default.displayEmailAddress | Determines whether or not to display a user's email address. |
| webservices.rest.enabled | Determines whether or not REST-style web services are enabled. |
| webservices.soap.accessType | The access type for SOAP web services. Possible values include all (for all users), registered (for registered users only), specificUsers (for specifically named users only), and specificGroups (for specifically named groups only). |
| macros.unproxyobjects | true to render the link -- rather than an error message -- even when the user might not have permission to view the linked content. This is false by default in order to prevent potentially sensitive content (such as the linked document's title) from being seen by those who don't have permission to view the content. |
| people.search.pagesize | The number of results per page in people search |
| polls.enabled | Turns on polls, and displays the "Create a poll" link in the Actions sidebar if the user has been given permissions to create polls. |
| questions.markThreadAsQuestionByDefault | Set to true to mark discussions as questions by default (display the "Mark thread as question" checkbox in new discussions as checked), or set to false to leave it unchecked by default. Often users do not even notice that the checkbox is there, and turning it on by default allows users to give points to other users when they provide a correct or helpful answer. |
| skin.default.changePasswordEnabled | Determines whether users can change their password. Values(true,false). |
| skin.default.headerHTML | Replaces the header logo for the entire application with the html entered in this system property. |
| skin.default.newAccountCreationEnabled | Determines whether users can register their own user accounts. Values(true,false). |
| skin.default.recentHistoryEnabled | Set to false to hide the History menu on the userbar (defaults to true) |
| system.console.custom.title | The value that should be used in the page title for the Admin Console. Typically, this matches the title of your community, such as "Acme Community Admin Console". |
| webservices.soap.enabled | Whether or not SOAP webservices are enabled (default: false) |
| webservices.xmlrpc.enabled | Whether or not XML-RPC webservices are enabled (default: false) |
| webservices.soap.accessType | Sets how users can access
webservices possible values are
(default: all) |
| webservices.soap.allowedUsers | Comma separated list of allowed users by username (see property: webservices.soap.accessType) |
| webservices.soap.allowedGroups | Comma separated list of allowed groups by group name (see property: webservices.soap.accessType) |
| webservices.soap.forceSSL | If this property is set requests that are not over SSL will fail. (default: false) |
| webservices.soap.permissionHandler.className | Override this property to customize the inbound Handler for XFire. (default:com.jivesoftware.community.webservices.server.xfire.PermissionHandler) |