some clean ups, add more documentation

This commit is contained in:
Uwe Steinmann 2021-09-10 09:37:07 +02:00
parent da0f5d3053
commit 84887e3b18

View File

@ -115,16 +115,16 @@
- restricted: Restricted access: only allow users to log in if they have an entry in the local database (irrespective of successful authentication with LDAP). - restricted: Restricted access: only allow users to log in if they have an entry in the local database (irrespective of successful authentication with LDAP).
- enableUserImage: enable users images - enableUserImage: enable users images
- disableSelfEdit: if true user cannot edit his own profile - disableSelfEdit: if true user cannot edit his own profile
- passwordStrength: XXX - passwordStrength: minimum strength of password, set to 0 to disable
- passwordStrengthAlgorithm: XXX - passwordStrengthAlgorithm: algorithm used to calculate password strenght (simple or advanced)
- passwordExpiration: XXX - passwordExpiration: number of days after password expires
- passwordHistory: XXX - passwordHistory: number of remembered passwords
- loginFailure: XXX - loginFailure: maximum allowed login failures before an account is disabled
- autoLoginUser: XXX - autoLoginUser: id of user used if auto login is turned on
- quota: XXX - quota: maximum allowed space on disc for each user
- undelUserIds: XXX - undelUserIds: ids of users which cannot be deleted
- encryptionKey: XXX - encryptionKey: arbitrary string used for creating form tokens
- cookieLifetime: XXX - cookieLifetime: lifetime of cookie in seconds, set to 0 for session cookies
--> -->
<authentication <authentication
enableGuestLogin = "false" enableGuestLogin = "false"
@ -188,7 +188,6 @@
</connectors> </connectors>
</authentication> </authentication>
<!-- <!--
- ADOdbPath: Path to adodb. This is the directory containing the adodb directory
- dbDriver: DB-Driver used by adodb (see adodb-readme) - dbDriver: DB-Driver used by adodb (see adodb-readme)
- dbHostname: DB-Server - dbHostname: DB-Server
- dbDatabase: database where the tables for seeddms are stored (optional - see adodb-readme) - dbDatabase: database where the tables for seeddms are stored (optional - see adodb-readme)
@ -197,7 +196,6 @@
- doNotCheckVersion: Whether or not to check the database schema for its correct version. - doNotCheckVersion: Whether or not to check the database schema for its correct version.
--> -->
<database <database
ADOdbPath = ""
dbDriver = "_DBC_DBTYPE_" dbDriver = "_DBC_DBTYPE_"
dbHostname = "_DBC_DBSERVER_" dbHostname = "_DBC_DBSERVER_"
dbDatabase = "_DBC_DBNAME_" dbDatabase = "_DBC_DBNAME_"
@ -209,8 +207,8 @@
- smtpServer: SMTP Server hostname - smtpServer: SMTP Server hostname
- smtpPort: SMTP Server port - smtpPort: SMTP Server port
- smtpSendFrom: Send from - smtpSendFrom: Send from
- smtpUser: XXX - smtpUser: user name used for authenticating against smtp server
- smtpPassword: XXX - smtpPassword: password used for authenticating against smtp server
--> -->
<smtp <smtp
smtpServer = "localhost" smtpServer = "localhost"
@ -224,7 +222,7 @@
<!-- <!--
-siteDefaultPage: Default page on login. Defaults to out/out.ViewFolder.php -siteDefaultPage: Default page on login. Defaults to out/out.ViewFolder.php
- rootFolderID: ID of root-folder (mostly no need to change) - rootFolderID: ID of root-folder (mostly no need to change)
- showMissingTranslations: XXX - showMissingTranslations: set true if missing translation shall be listed at end of page
--> -->
<display <display
siteDefaultPage = "" siteDefaultPage = ""
@ -247,10 +245,10 @@
- enableVersionModification: allow to modify versions after approval - enableVersionModification: allow to modify versions after approval
- enableDuplicateDocNames: allow duplicate names in a folder - enableDuplicateDocNames: allow duplicate names in a folder
- enableDuplicateSubFolderNames: allow duplicate names in a folder - enableDuplicateSubFolderNames: allow duplicate names in a folder
- enableOwnerRevApp: XXX - enableOwnerRevApp: allow owner of a document to review and approve
- enableSelfRevApp: XXX - enableSelfRevApp: allow the user current logged in to add herself as a reviewer or approver
- presetExpirationDate: XXX - presetExpirationDate: set to time period if each document shall expire
- overrideMimeType: XXX - overrideMimeType: set to true if the mimetype of a document version is determined by the server
--> -->
<edition <edition
enableAdminRevApp = "false" enableAdminRevApp = "false"
@ -275,9 +273,9 @@
- be any number or string that does not already exist within $_contentDir. - be any number or string that does not already exist within $_contentDir.
- maxDirID: Maximum number of sub-directories per parent directory. Default: 0. - maxDirID: Maximum number of sub-directories per parent directory. Default: 0.
- updateNotifyTime: users are notified about document-changes that took place within the last "updateNotifyTime" seconds - updateNotifyTime: users are notified about document-changes that took place within the last "updateNotifyTime" seconds
- extraPath: XXX - extraPath: additional path which is added to php's include path
- maxExecutionTime: XXX - maxExecutionTime: maximum script execution time, this cannot be larger than the value set in php.ini
- cmdTimeout: XXX - cmdTimeout: timeout in sec. for external commands
--> -->
<server <server
coreDir = "" coreDir = ""
@ -290,9 +288,9 @@
cmdTimeout = "1" cmdTimeout = "1"
/> />
<!-- <!--
- enableNotificationAppRev: XXX - enableNotificationAppRev: set to true if reviewers and approvers shall be informed about a pending review/approval
- enableOwnerNotification: XXX - enableOwnerNotification: XXX
- enableNotificationWorkflow: XXX - enableNotificationWorkflow: set to true if the users in the workflow shall be informed
--> -->
<notification <notification
enableNotificationAppRev = "true" enableNotificationAppRev = "true"