Difference between revisions of "OpenKM.cfg"

From OpenKM Documentation
Jump to: navigation, search
(Redirected page to Application configuration)
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== OpenKM configuration file ==
+
#REDIRECT [[Application configuration]]
OpenKM.cfg file is the main OpenKM configuration file. You can find this file in your server in $JBOSS_HOME/OpenKM.cfg.
 
 
 
'''Important !!!''' Each time you make some change in the OpenKM.cfg file JBoss server must be restarted to take effect.
 
 
 
== List of admited configuration file properties ==
 
<source lang="java">
 
repository.config=
 
repository.home=
 
system.user=
 
default.user.role=
 
default.admin.role=
 
principal.adapter=
 
max.file.size=
 
max.search.results=
 
system.demo=
 
system.ocr=
 
application.url=
 
default.lang=
 
system.login.username.lowercase=
 
system.pdf2swf=
 
ssystem.openoffice=
 
kea.thesaurus.skos.file=
 
kea.thesaurus.owl.file=
 
kea.thesaurus.base.url=
 
kea.thesaurus.vocabulary.serql=
 
kea.stopwords.file=
 
kea.automatic.keyword.extraction.number=
 
kea.thesaurus.tree.root=
 
kea.thesaurus.tree.childs=
 
subscription.message.subject=
 
subscription.message.body=
 
notify.message.subject=
 
notify.message.body=
 
</source>
 
 
 
== Changing uploading max file size ==
 
The default limit is 25MB. If you want to increase to 50MB:
 
file.size=50.
 
 
 
== Changing repository.xml configuration filename and path ==
 
repository.config=repository.xml
 
 
 
== Changing default repository home ==
 
By default repository is stored in $JBOSS_HOME/repository folder but you can change it with:
 
repository.home=repotest
 
 
 
== Changing default connection role ==
 
By default connection role to OpenKM is called UserRole, you can change to other role name. This change need some changes too in web.xml file into OpenKM.war/WEB-INF
 
default.user.role=OtherRole
 
 
 
<source lang="xml">
 
<security-constraint>
 
    <web-resource-collection>
 
      <web-resource-name>OpenKM Protected Area</web-resource-name>
 
      <!-- GWT -->
 
      <url-pattern>/es.git.openkm.frontend.Main/*</url-pattern>
 
      <url-pattern>/es.git.openkm.backend.Main/*</url-pattern>
 
      <!-- JSPs -->
 
      <url-pattern>/admin/*</url-pattern>
 
      <url-pattern>/mobi/*</url-pattern>
 
      <!-- Servlets -->
 
      <url-pattern>/RepositoryStartupServlet</url-pattern>
 
      <url-pattern>/Test</url-pattern>
 
      <url-pattern>/OKM*</url-pattern>
 
    </web-resource-collection>
 
    <auth-constraint>
 
      <role-name>AdminRole</role-name>
 
      <role-name>OtherRole</role-name>
 
    </auth-constraint>
 
    <user-data-constraint>
 
      <transport-guarantee>NONE</transport-guarantee>
 
    </user-data-constraint>
 
  </security-constraint>
 
  <login-config>
 
    <auth-method>FORM</auth-method>
 
    <realm-name>OpenKM</realm-name>
 
    <form-login-config>
 
      <form-login-page>/login.jsp</form-login-page>
 
      <form-error-page>/login.jsp?error=1</form-error-page>
 
    </form-login-config>
 
  </login-config>
 
  <security-role>
 
    <description>Admin user access</description>
 
    <role-name>AdminRole</role-name>
 
  </security-role>
 
  <security-role>
 
    <description>General user access</description>
 
    <role-name>OtherRole</role-name>
 
  </security-role>
 
</source>
 
 
 
== Changing default admin role ==
 
By default connection role to OpenKM is called AdminRole, you can change to other role name. This change need some changes too in web.xml file into OpenKM.war/WEB-INF
 
default.admin.role=OtherAdminRole
 
 
 
<source lang="xml">
 
<security-constraint>
 
    <web-resource-collection>
 
      <web-resource-name>OpenKM Protected Area</web-resource-name>
 
      <!-- GWT -->
 
      <url-pattern>/es.git.openkm.frontend.Main/*</url-pattern>
 
      <url-pattern>/es.git.openkm.backend.Main/*</url-pattern>
 
      <!-- JSPs -->
 
      <url-pattern>/admin/*</url-pattern>
 
      <url-pattern>/mobi/*</url-pattern>
 
      <!-- Servlets -->
 
      <url-pattern>/RepositoryStartupServlet</url-pattern>
 
      <url-pattern>/Test</url-pattern>
 
      <url-pattern>/OKM*</url-pattern>
 
    </web-resource-collection>
 
    <auth-constraint>
 
      <role-name>OtherAdminRole</role-name>
 
      <role-name>UserRole</role-name>
 
    </auth-constraint>
 
    <user-data-constraint>
 
      <transport-guarantee>NONE</transport-guarantee>
 
    </user-data-constraint>
 
  </security-constraint>
 
  <login-config>
 
    <auth-method>FORM</auth-method>
 
    <realm-name>OpenKM</realm-name>
 
    <form-login-config>
 
      <form-login-page>/login.jsp</form-login-page>
 
      <form-error-page>/login.jsp?error=1</form-error-page>
 
    </form-login-config>
 
  </login-config>
 
  <security-role>
 
    <description>Admin user access</description>
 
    <role-name>OtherAdminRole</role-name>
 
  </security-role>
 
  <security-role>
 
    <description>General user access</description>
 
    <role-name>UserRole</role-name>
 
  </security-role>
 
</source>
 
 
 
== Change max results in UI ==
 
This option limits the search results in UI.
 
max.search.results=25
 
 
 
== Change principal adapter ==
 
OpenKM can handle user access using the JBoss DatabasePrincipalAdapter login module by default. OpenKM needs an available method for reading users and roles. The class DatabasePrincipalAdapter does this job.
 
 
 
principal.adapter=es.git.openkm.core.DatabasePrincipalAdapter
 
 
 
 
 
[[Category: Configuration]]
 
[[Category: OpenKM 1.0]]
 
[[Category: OpenKM 1.2]]
 
[[Category: OpenKM 2.0]]
 
[[Category: OpenKM 3.0]]
 
[[Category: OpenKM 4.0]]
 
[[Category: OpenKM 5.0]]
 

Latest revision as of 13:03, 2 November 2010