Wiki source code of Anwendungseinstellungen

Show last authors
1 {{content/}}
2
3 The file //application.properties// stores several application-wide properties, such as which links are shown on the start page or settings regarding failed logins.
4
5 == UI ==
6
7
8 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding the user interface."}}
9 |= Property |= Default value|= Explanation
10 |login.show.link.register|true|Whether a link for creating a new account is shown on the start page.
11 |login.show.link.password|true|Whether a link for forgotten passwords is shown on the start page.
12 |login.show.link.help|true|Whether a link to these help pages is shown on the start page.
13 |login.show.link.faq|true|Whether a link to the Q&A page is shown on the start page.
14 |login.show.link.privacy|true|Whether a link to the privacy policy is shown on the start page.
15 |login.show.link.imprint|true|Whether a link to the imprint is shown on the start page.
16 |login.show.link.terms|true|Whether a link to the terms and conditions is shown on the start page.
17 |login.show.link.license|true|Whether a link to the licensing conditions is shown on the start page.
18 |login.show.footer|true|Whether the footer is shown on the start page. The footer contains the imprint, privacy policy etc.
19 |defaults.show.logo|true|Whether the logo of the application is shown on the start page.
20 |defaults.show.version|true|Whether the version of the application is shown on the start page.
21 {{/table}}
22
23 == URLs ==
24
25 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding URLs to various external pages."}}
26 |= Property|= Default value|= Explanation
27 |defaults.url.help.designer|https://help.formcycle.eu/xwiki/bin/view/Main/Designer|URL for the help pages of the {{designer case="gen"/}}.
28 |defaults.url.video|http://www.formcycle.de/videos/|URL for the tutorial videos for {{formcycle/}}.
29 |defaults.url.help|https://help.formcycle.eu/xwiki/bin/view/Main/|URL for the help pages of {{formcycle/}}.
30 |defaults.url.qa|https://faq.formcycle.eu/|URL for the Q&A pages for {{formcycle/}}.
31 |defaults.url.register|https://form.cloud|URL for creating a new account.
32 |defaults.url.privacy|https://form.cloud/datenschutz.html|URL for the privacy policy.
33 |defaults.url.imprint|https://www.xima.de/impressum/|URL for the imprint.
34 |defaults.url.terms|https://form.cloud/agb.html|URL for the terms and conditions.
35 |defaults.url.license|https://www.formcycle.de/lizenzbedingungen|URL for the licensing conditions.
36 |defaults.url.formcycle|https://www.formcycle.de|URL to {{formcycle/}}
37 |defaults.url.formcloud|https://www.form.cloud|URL to the {{formcloud/}}.
38 |defaults.url.loopback.base ^^since 5.0.17^^||Alternative loopback URL for internal calls (e.g. print) .
39 {{/table}}
40
41 == Default language ==
42
43 Change the default language of the application by modifying these properties. The application itself is fully internationalizable.
44
45 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding the default language"}}
46 |= Property|= Default value|= Explanation
47 |defaults.systemeinstellung.language|-|Language code for the default language of the application.[[ISO-639 alpha-2 oder alpha-3>>https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html||target="_blank"]].
48 |defaults.systemeinstellung.county|-|Region code for the default language of the application. [[ISO 3166 alpha-2 country code or UN M.49 numeric-3 area code.>>https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html||target="_blank"]]
49 |defaults.systemeinstellung.variant|-|[[Language variation for the default language of the application.>>https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html||target="_blank"]]
50 {{/table}}
51
52 == Login ==
53
54 To prevent attacks on user passwords, you can limit how often each user may fail to enter the correct password before they are locked out for a certain amount of time.
55
56 By default, a user must wait for 15 minutes after 5 consecutive failed login attempts.
57
58 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding login restrictions"}}
59 |= Property|= Default value|= Explanation
60 |login.fails.lock.timeout|900 (=15 minutes)|The amount of time in seconds a user needs to wait after using up all their login attempts. If the value is less than {{code language="none"}}60{{/code}}, it is clamped to {{code language="none"}}60{{/code}}.
61 |login.fails.lock.count|5|The number of consecutive failed login attempts before a user is locked out. Set to {{code language="none"}}0{{/code}} for an unlimited amount of attempts.
62 |login.fails.lock.onfullcache|true|Whether the system is locked when the login cache is full. Users cannot login anymore if the system is locked.
63 |login.fails.cache.heap.count|10000|The number of login attempts kept in memory. If less than or equal to {{code language="none"}}0{{/code}}, it is clamped to {{code language="none"}}1000{{/code}}.
64 |login.fails.lock.maxentries|11000|The maximum number of login attempts stored in the cache. If the cache is full, no more logins are allowed. Set to {{code language="none"}}0{{/code}} to disable the limit.
65 |login.fails.cache.disk.size|102400|The number of login attempts cached in the file system. Set to {{code language="none"}}0{{/code}} to disable this limit, and make sure you have got sufficient disk space. Set to a value less than {{code language="none"}}0{{/code}} to disable the file cache (and use only the in-memory cache).
66 |last.login.save|false|Whether the most recent date when a user signed in is saved and shown for each client.
67 {{/table}}
68
69 An example for a configuration requiring a user to wait to 100 minutes after 10 failed login attempts.
70
71 {{code language="none"}}
72 login.fails.lock.timeout=6000
73 login.fails.lock.count=10
74 {{/code}}
75
76 {{info}}
77 The number of login attempts before a user is locked out is separate for each {{mserver/}} and {{fserver/}}. Please note that this may change in upcoming releases.
78 {{/info}}
79
80 == Cache ==
81
82 The file cache stores files used by the system, the form cache stores rendered HTML forms.
83
84 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding the file and form caches"}}
85 |= Property|= Default value|= Explanation
86 |cache.files.disk.size|-1|Maximum size in MB of what the file cache stores in the file system. No limit when set to {{code language="none"}}-1{{/code}}. If set to {{code language="none"}}0{{/code}}, the file system is not used by the cache.
87 |cache.files.heap.size|75|Maximum size in MB of what the file cache stores in-memory. If set to {{code language="none"}}0{{/code}}, the in-memory file cache is disabled.
88 |cache.files.idletime|0|Time interval in seconds until an item in the form cache is removed when it is never accessed during that time interval. Set to {{code language="none"}}0{{/code}} to disable.
89 |cache.forms.disk.size|-1|Maximum size in MB of what the form cache stores in the file system. No limit when set to {{code language="none"}}-1{{/code}}. If set to {{code language="none"}}0{{/code}}, the file system is not used by the cache.
90 |cache.forms.heap.size|75|Maximum size in MB of what the form cache stores in-memory. If set to {{code language="none"}}0{{/code}}, the in-memory form cache is disabled.
91 |cache.forms.idletime|0|Time interval in seconds until an item in the form cache is removed when it is never accessed during that time interval. Set to {{code language="none"}}0{{/code}} to disable.
92 {{/table}}
93
94 == System ==
95
96 {{table dataTypeAlpha="0" preSort="0-asc" caption="Various settings regarding the application"}}
97 |= Property|= Default value|= Explanation
98 |bot.field.name|x-i-m-a-5536-required|Name of the hidden input field [[for detecting bots.>>doc:Formcycle.SystemSettings.ErrorMessageTemplates]]
99 |defaults.systemeinstellung.loginName|sadmin|Login name for the super administrator of the system.
100 |defaults.systemeinstellung.passwort|hash(admin)|Login name for the super administrator of the system. Should be changed after installing the application. The password is stored hashed, it should not be set manually in the configuration file, but only via the user interface.
101 |cluster.implementation|jgroups|The implementation used for [[clustering>>doc:Formcycle.SystemSettings.UserInterface.Cluster.WebHome]]. Allowed options are [[jgroups>>http://www.jgroups.org/||target="_blank"]] and [[shoal>>https://javaee.github.io/shoal/||target="_blank"]].
102 |system.server.id {{version major="6" minor="6" patch="5"/}}|(generated)|Unique ID of the server which can be included in the HTTP header and attached to the submit URL of a form for the use of load balancers. See //HTTP//.
103 {{/table}}
104
105 == Limits ==
106
107 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding various limits"}}
108 |= Property|= Default value|= Explanation
109 |defaults.upload.max_size|-1|Maximum size in bytes for file uploads within forms. Applies to each file individually. Set to {{code language="none"}}-1{{/code}} to disable.
110 |defaults.query.database.max_rowcount|5000|Maximum number of returned rows for a query to the database. Set to {{code language="none"}}0{{/code}} to disable.
111 |defaults.upload.max_fieldsize|0|Maximum size in bytes when retrieving columns of type //character// (eg. char or varchar) or //binary//. Set to {{code language="none"}}0{{/code}} to disable.
112 {{/table}}
113
114 == Frontend Server ==
115
116 These settings control the connection to the {{fserver/}}. They should be edited [[via the user interface>>doc:Formcycle.SystemSettings.UserInterface.FrontendServer]].
117
118 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding the frontend server."}}
119 |= Property|= Default value|= Explanation
120 |fs.settings.interface|0.0.0.0|The network interface the {{fserver/}} uses for listening to connections from the {{mserver/}}.
121 |fs.settings.port|4753|The port for the connection to the {{mserver/}}.
122 |fs.settings.ssl.use|false|Whether the connection between the {{mserver/}}and {{fserver/}} is encrypted via SSL.
123 |fs.settings.authKey|(empty string)|The token of this {{fserver/}}. Used to check if the {{mserver/}} is authorized to establish a connection to this {{fserver/}}.
124 |fs.settings.ssl.keystore.path|(empty string)|The path to the keystore file (on the file system) for the connection. Required if SSL is used.
125 |fs.settings.ssl.keystore.pass|(empty string)|The password needed to access the keystore. Required if SSL is used.
126 {{/table}}
127
128 == LDAP ==
129
130 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings regarding LDAP"}}
131 |= Property|= Default value|= Explanation
132 |ldap.override.filter.user|(~|(objectclass=user)(objectclass=person)(objectclass=inetOrgPerson)(objectclass=organizationalPerson))|LDAP filter for searching for available [[LDAP users>>doc:Formcycle.UserInterface.UserSettings.LDAP]]. By default, finds all objects with the object class {{code language="none"}}user{{/code}}, {{code language="none"}}person{{/code}}, {{code language="none"}}inetOrgPerson{{/code}}, or {{code language="none"}}organinsationalPerson{{/code}}.
133 |ldap.override.filter.user.login|(~|(sAMAccountName={0})(userPrincipalName={0})(uid={0}))|LDAP-Filter for locating a user with a given login name. Specify the login name with the placeholder {{code language="none"}}{0}{{/code}}. By default, finds all users if the attribute {{code language="none"}}sAMAccountName{{/code}}, {{code language="none"}}userPrincipalName{{/code}} or {{code language="none"}}uid{{/code}} matches the login name.
134 |ldap.override.filter.kerberos.user {{version major="6" minor="6" patch="5"/}}|//Value of the user query see above.//|LDAP filter for searching a user after Kerberos authentication. The available login corresponds to the pattern {{code language="none"}}<username>(/<instance>)@<REALM>{{/code}} where the {{code language="none"}}/<instance>{{/code}} part is optional. Using the example {{code language="none"}}test/admin@EXAMPLE.COM{{/code}}, the individual components are available in the corresponding filter as follows: {{code language="none"}}{0}{{/code}}={{code language="none"}}test/admin@EXAMPLE.COM{{/code}}, {{code language="none"}}{1}{{/code}}={{code language="none"}}test/admin{{/code}}, {{code language="none"}}{2}{{/code}}={{code language="none"}}test{{/code}},{{code language="none"}}{3}{{/code}}={{code language="none"}}admin{{/code}},{{code language="none"}}{4}{{/code}}={{code language="none"}}EXAMPLE.COM{{/code}}. For example, to perform a user search within a single-domain environment with a non-standard {{code language="none"}}userPrincipalName{{/code}}, the query could be defined as follows: {{code language="none"}}(sAMAccountName={2}){{/code}}
135 |ldap.override.filter.group|(~|(objectclass=group)(objectclass=groupofnames)(objectclass=groupofuniquenames))|LDAP filter for searching for [[LDAP groups>>doc:Formcycle.UserInterface.UserSettings.LDAPGroups]]. By default, searches for all objects with the object class {{code language="none"}}group{{/code}}, {{code language="none"}}groupofnames{{/code}}, or {{code language="none"}}groupofuniquenames{{/code}}.
136 {{/table}}
137
138 == HTTP ==
139
140 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings for HTTP requests and responses"}}
141 |= Property|= Default value|= Explanation
142 |http.header.server.id (migrated to system.server.id as of {{version major="6" minor="6" patch="5"/}})|(empty)|Value of the HTTP header //XFC-Server-Id//. It is set on each response and identifies the {{formcycle/}} server. If this property is not set at all, a randomly generated UUID is used. If this property is empty, the header is not set.
143 |http.header.referer|same-origin|The referre policy for HTTP responses. You can also change this setting [[in the system settings menu >>doc:Formcycle.SystemSettings.UserInterface.General.WebHome]].
144 |http.header.hsts.max|(empty)|The value for the //max-age// of the HTTP Strict Transport Security. You can also change this setting [[in the system settings menu >>doc:Formcycle.SystemSettings.UserInterface.General.WebHome]].
145 |http.header.hsts.sub|false|Whether the HTTP Strict Transport Security should be applied to sub domains as well. You can also change this setting [[in the system settings menu >>doc:Formcycle.SystemSettings.UserInterface.General.WebHome]].
146 |http.header.serverid.name {{version major="6" minor="6" patch="5"/}}|(not available)|Specifies the header name with which the //system.server.id// is written to all requests. If this entry exists but is empty the corresponding header will not be set. If the entry does not exist the default //XFC-Server-Id// is used.
147 |http.param.serverid.name {{version major="6" minor="6" patch="5"/}}|(not available)|Specifies the name of the URL parameter used to append the //system.server.id// to the form submission URL. If the value is empty or not available, no parameter will be appended.
148 {{/table}}
149
150 == Debug ==
151
152 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings for debugging"}}
153 |= Property|= Default value|= Explanation
154 |debug.show_sql|false|Sets [[the Hibernate properties>>http://docs.jboss.org/hibernate/core/4.3/manual/en-US/html/ch03.html#configuration-logging]] {{code language="none"}}hibernate.show_sql{{/code}} and {{code language="none"}}hibernate.format_sql{{/code}} to {{code language="none"}}true{{/code}}. Write all executed SQL statements to the console.
155 {{/table}}
156
157 == Quartz jobs ==
158
159 {{table dataTypeAlpha="0" preSort="0-asc" caption="Settings for quartz jobs"}}
160 |= Property|= Default value|= Explanation
161 |cleanup.worker.active|true|Whether the system cleanup job is active and run periodically. The system clean up jobs, for example, checks for unconfirmed form records waitning for a double opt-in confirmation, and deletes them when they are expired.
162 |cleanup.worker.cronexpression|0 0,15,30,45 * ? * *|The cron expression for the system clean up job that indicates when and how often that job is run. The system clean up jobs, for example, checks for unconfirmed form records waitning for a double opt-in confirmation, and deletes them when they are expired.
163 {{/table}}

Navigation

Copyright 2000-2024