Difference between revisions of "OpenKM.cfg"
From OpenKM Documentation
| Line 1: | Line 1: | ||
| − | + | You can modify some OpenKM default behavior. | |
| − | + | * '''repository.config''': Specify the repository configuration file. This is an XML which describe the repository configuration. Here you can alter the FileSystem and PersistenceManage for Workspace and Versioning. By default set to "repository.xml". See [[Repository configuration]] for more info. | |
| − | |||
| − | + | * '''repository.home''': This is the folder name where the repository data is stored, but this information depends on the configuration defined in "repository.xml" because the repository contents can be stored in disk or in a database. By default set to "repository". | |
| − | repository. | ||
| − | repository. | ||
| − | |||
| − | default. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * '''principal.adapter''': OpenKM use JAAS (Java Authentication and Authorization Service) to manage authentication. can handle user access using the JBoss ''org.jboss.security.auth.spi.DatabaseServerLoginModule'' login module by default. OpenKM needs an available method for reading users and roles. The class ''com.openkm.principal.DatabasePrincipalAdapter'' does this job. For more info, read http://jboss.org/community/docs/DOC-10760. | |
| − | + | * '''max.file.size''': Defines the maximum size for a document. If the document size exceed this quantity, the application throws an ''FileSizeExceededException'' and the document won't be added to the repository. The size is measured in MB, so if you set this property to 25, the maximum document size will be 25 MB. By default set to 25. | |
| − | The | ||
| − | |||
| − | + | * '''restrict.file.mime''': If you set this property to "on", only files with a registered MIME type are allowed to be added to the repository. If the file don't match any registered MIME type an ''UnsupportedMimeTypeException'' is thrown. The list of registered MIME type is defined in the file ''$JBOSS_HOME/server/default/deploy/OpenKM.war/WEB-INF/classes/com/openkm/core/mime.types''. The changes in the file won't take effect until you restart the JBoss server. If you add a new MIME type, don't forget to add the corresponding icon at ''$JBOSS_HOME/server/default/deploy/OpenKM.war/com.openkm.frontend.Main/img/icon/mime''. By default set to "off". | |
| − | |||
| − | + | * '''restrict.file.extension''': This configuration parameter limit the files added using the WebDAV connector. The reason to add this configuration property is that many application create temporal or backup files while you edit a document using the WebDAV connector, and you don't want to add these "phantom" files to the repository. By default set to “*~,*.bak”. | |
| − | |||
| − | |||
| − | + | * '''max.search.results''': To prevent heavy system load due to large search results, you can configure the maximum search results returned by a query. By default set to 25. | |
| − | |||
| − | |||
| − | + | * '''application.url''': In subscriptions and notification messages an URL with the related document is included. Here you have to configure the URL used to access OpenKM from others computers. Notifications and subscriptions won't be available until this parameter is configured. This is a sample configuration: http://your-domain.com:8080/OpenKM/es.git.openkm.frontend.Main/index.jsp. By default set to null. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * '''notify.message.subject''': Can be used to set the notification mail message subject. See [[Notification and subscription messages]] for more info. By default set to "OpenKM - NOTIFICATION - {0}". | |
| − | By default | ||
| − | |||
| − | + | * '''notify.message.body''': Can be used to set the notification mail message body. See [[Notification and subscription messages]] for more info. By default set to "<b>Document: </b><a href=\"{0}\">{1}</a><br/><b>User: </b>{3}<br/><b>Message:</b>{4}<br/>". | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * '''subscription.message.subject''': Can be used to set the subscription mail message subject. See Notification and subscription messages for more info. By default set to "OpenKM - NOTIFICATION - {0}". subscription.message.body: Can be used to set the subscription mail message body. See [[Notification and subscription messages]] for more info. By default set to "<b>Document:</b><a href=\"{0}\">{1}</a><br/><b>User: </b>{3}<br/><b>Event: </b>{4}<br/><b>Comment: </b>{5}<br/>". | |
| − | |||
| − | |||
| − | + | * '''system.ocr''': If you want to use an OCR you should put here the path to the application executable. Actually only works with Tesseract. See OCR for more info. By default set to "". | |
| − | |||
| − | + | * '''system.antivir''': OpenKM can be configured to check an uploaded document for viruses. Here you can specify the path of the executable antivir. Actually only works with ClamAV. See Antivirus for more info. By default set to "". | |
| − | + | * '''system.readonly''': To configure a read-only OpenKM instance. See Repository mirroring for more info. By default is set to "off". | |
| − | |||
| − | + | * system.openoffice: This parameter is used to enable / disable the integration with OpenOffice.org application. Should be set to "on" to enable the document to PDF conversion feature. See [[Third-party software integration: OpenOffice.org]]for more info. By default set to "off". | |
| − | + | * '''default.lang''': Used to set the default OpenKM web interface language. By default set to english. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[Category: Installation Guide]] | [[Category: Installation Guide]] | ||
Revision as of 19:03, 25 January 2010
You can modify some OpenKM default behavior.
- repository.config: Specify the repository configuration file. This is an XML which describe the repository configuration. Here you can alter the FileSystem and PersistenceManage for Workspace and Versioning. By default set to "repository.xml". See Repository configuration for more info.
- repository.home: This is the folder name where the repository data is stored, but this information depends on the configuration defined in "repository.xml" because the repository contents can be stored in disk or in a database. By default set to "repository".
- principal.adapter: OpenKM use JAAS (Java Authentication and Authorization Service) to manage authentication. can handle user access using the JBoss org.jboss.security.auth.spi.DatabaseServerLoginModule login module by default. OpenKM needs an available method for reading users and roles. The class com.openkm.principal.DatabasePrincipalAdapter does this job. For more info, read http://jboss.org/community/docs/DOC-10760.
- max.file.size: Defines the maximum size for a document. If the document size exceed this quantity, the application throws an FileSizeExceededException and the document won't be added to the repository. The size is measured in MB, so if you set this property to 25, the maximum document size will be 25 MB. By default set to 25.
- restrict.file.mime: If you set this property to "on", only files with a registered MIME type are allowed to be added to the repository. If the file don't match any registered MIME type an UnsupportedMimeTypeException is thrown. The list of registered MIME type is defined in the file $JBOSS_HOME/server/default/deploy/OpenKM.war/WEB-INF/classes/com/openkm/core/mime.types. The changes in the file won't take effect until you restart the JBoss server. If you add a new MIME type, don't forget to add the corresponding icon at $JBOSS_HOME/server/default/deploy/OpenKM.war/com.openkm.frontend.Main/img/icon/mime. By default set to "off".
- restrict.file.extension: This configuration parameter limit the files added using the WebDAV connector. The reason to add this configuration property is that many application create temporal or backup files while you edit a document using the WebDAV connector, and you don't want to add these "phantom" files to the repository. By default set to “*~,*.bak”.
- max.search.results: To prevent heavy system load due to large search results, you can configure the maximum search results returned by a query. By default set to 25.
- application.url: In subscriptions and notification messages an URL with the related document is included. Here you have to configure the URL used to access OpenKM from others computers. Notifications and subscriptions won't be available until this parameter is configured. This is a sample configuration: http://your-domain.com:8080/OpenKM/es.git.openkm.frontend.Main/index.jsp. By default set to null.
- notify.message.subject: Can be used to set the notification mail message subject. See Notification and subscription messages for more info. By default set to "OpenKM - NOTIFICATION - {0}".
- notify.message.body: Can be used to set the notification mail message body. See Notification and subscription messages for more info. By default set to "Document: <a href=\"{0}\">{1}</a>
User: {3}
Message:{4}
".
- subscription.message.subject: Can be used to set the subscription mail message subject. See Notification and subscription messages for more info. By default set to "OpenKM - NOTIFICATION - {0}". subscription.message.body: Can be used to set the subscription mail message body. See Notification and subscription messages for more info. By default set to "Document:<a href=\"{0}\">{1}</a>
User: {3}
Event: {4}
Comment: {5}
".
- system.ocr: If you want to use an OCR you should put here the path to the application executable. Actually only works with Tesseract. See OCR for more info. By default set to "".
- system.antivir: OpenKM can be configured to check an uploaded document for viruses. Here you can specify the path of the executable antivir. Actually only works with ClamAV. See Antivirus for more info. By default set to "".
- system.readonly: To configure a read-only OpenKM instance. See Repository mirroring for more info. By default is set to "off".
- system.openoffice: This parameter is used to enable / disable the integration with OpenOffice.org application. Should be set to "on" to enable the document to PDF conversion feature. See Third-party software integration: OpenOffice.orgfor more info. By default set to "off".
- default.lang: Used to set the default OpenKM web interface language. By default set to english.
