<allowed_languagesdesc="List of supported languages of Writing Aids (spell checker, grammar checker, thesaurus, hyphenation) on this instance. Allowing too many has negative effect on startup performance."default="de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru">@ALLOWED_LANGUAGES@</allowed_languages>
These are the settings of external (remote) spellchecker and grammar checker services. Currently LanguageTool and Duden Korrekturserver APIs are supported, you can
set either of them. By default they are disabled. To turn the support on, please set "enabled" property to true. It works with self hosted or cloud services, free
and premium as well. The "base_url" may be https://api.languagetoolplus.com/v2 if the cloud version of LanguageTool is used. Please note that your data in the
document e.g. the text part of it will be sent to the cloud API. Please read the respective privacy policies, e.g. https://languagetool.org/legal/privacy.
<languagetooldesc="Remote API settings for spell and grammar checking">
<enableddesc="Enable Remote Spell and Grammar Checker"type="bool"default="false"></enabled>
<base_urldesc="HTTP endpoint for the API server, without /check or /languages postfix at the end."type="string"default=""></base_url>
<user_namedesc="LanguageTool or Duden account username for premium usage."type="string"default=""></user_name>
<api_keydesc="API key provided by LanguageTool or Duden account for premium usage."type="string"default=""></api_key>
<ssl_verificationdesc="Enable or disable SSL verification. You may have to disable it in test environments with self-signed certificates."type="string"default="true"></ssl_verification>
<rest_protocoldesc="REST API protocol. For LanguageTool leave it blank, for Duden Korrekturserver use the string 'duden'."type="string"default=""></rest_protocol>
<enableddesc="If true, shows translate option as a menu entry in the compact view and as an icon in the tabbed view."type="bool"default="false">false</enabled>
<sys_template_pathdesc="Path to a template tree with shared libraries etc to be used as source for chroot jails for child processes."type="path"relative="true"default="systemplate"></sys_template_path>
<child_root_pathdesc="Path to the directory under which the chroot jails for the child processes will be created. Should be on the same file system as systemplate and lotemplate. Must be an empty directory."type="path"relative="true"default="jails"></child_root_path>
<mount_jail_treedesc="Controls whether the systemplate and lotemplate contents are mounted or not, which is much faster than the default of linking/copying each file."type="bool"default="true"></mount_jail_tree>
<server_namedesc="External hostname:port of the server running coolwsd. If empty, it's derived from the request (please set it if this doesn't work). May be specified when behind a reverse-proxy or when the hostname is not reachable directly."type="string"default=""></server_name>
<file_server_root_pathdesc="Path to the directory that should be considered root for the file server. This should be the directory containing cool."type="path"relative="true"default="browser/../"></file_server_root_path>
<hexify_embedded_urlsdesc="Enable to protect encoded URLs from getting decoded by intermediate hops. Particularly useful on Azure deployments"type="bool"default="false"></hexify_embedded_urls>
<memproportiondesc="The maximum percentage of available memory consumed by all of the @APP_NAME@ processes, after which we start cleaning up idle documents. If cgroup memory limits are set, this is the maximum percentage of that limit to consume."type="double"default="80.0"></memproportion>
<num_prespawn_childrendesc="Number of child processes to keep started in advance and waiting for new clients."type="uint"default="1">1</num_prespawn_children>
<!-- <fetch_update_check desc="Every number of hours will fetch latest version data. Defaults to 10 hours." type="uint" default="10">10</fetch_update_check> -->
<batch_prioritydesc="A (lower) priority for use by batch eg. convert-to processes to avoid starving interactive ones"type="uint"default="5">5</batch_priority>
<pdf_resolution_dpidesc="The resolution, in DPI, used to render PDF documents as image. Memory consumption grows proportionally. Must be a positive value less than 385. Defaults to 96."type="uint"default="96">96</pdf_resolution_dpi>
<idle_timeout_secsdesc="The maximum number of seconds before unloading an idle document. Defaults to 1 hour."type="uint"default="3600">3600</idle_timeout_secs>
<idlesave_duration_secsdesc="The number of idle seconds after which document, if modified, should be saved. Disabled when 0. Defaults to 30 seconds."type="uint"default="30">30</idlesave_duration_secs>
<autosave_duration_secsdesc="The number of seconds after which document, if modified, should be saved. Disabled when 0. Defaults to 5 minutes."type="uint"default="300">300</autosave_duration_secs>
<always_save_on_exitdesc="On exiting the last editor, always perform a save and upload if the document had been modified. This is to allow the storage to store the document, if it had skipped doing so, previously, as an optimization."type="bool"default="false">false</always_save_on_exit>
<limit_load_secsdesc="Maximum number of seconds to wait for a document load to succeed. 0 for unlimited."type="uint"default="100">100</limit_load_secs>
<limit_store_failuresdesc="Maximum number of consecutive save-and-upload to storage failures when unloading the document. 0 for unlimited (not recommended)."type="uint"default="5">5</limit_store_failures>
<limit_convert_secsdesc="Maximum number of seconds to wait for a document conversion to succeed. 0 for unlimited."type="uint"default="100">100</limit_convert_secs>
<min_time_between_saves_msdesc="Minimum number of milliseconds between saving the document on disk."type="uint"default="500">500</min_time_between_saves_ms>
<min_time_between_uploads_msdesc="Minimum number of milliseconds between uploading the document to storage."type="uint"default="5000">5000</min_time_between_uploads_ms>
<cleanupdesc="Checks for resource consuming (bad) documents and kills associated kit process. A document is considered resource consuming (bad) if is in idle state for idle_time_secs period and memory usage passed limit_dirty_mem_mb or CPU usage passed limit_cpu_per"enable="true">
<cleanup_interval_msdesc="Interval between two checks"type="uint"default="10000">10000</cleanup_interval_ms>
<bad_behavior_period_secsdesc="Minimum time period for a document to be in bad state before associated kit process is killed. If in this period the condition for bad document is not met once then this period is reset"type="uint"default="60">60</bad_behavior_period_secs>
<idle_time_secsdesc="Minimum idle time for a document to be candidate for bad state"type="uint"default="300">300</idle_time_secs>
<limit_dirty_mem_mbdesc="Minimum memory usage for a document to be candidate for bad state"type="uint"default="3072">3072</limit_dirty_mem_mb>
<limit_cpu_perdesc="Minimum CPU usage for a document to be candidate for bad state"type="uint"default="85">85</limit_cpu_per>
<lost_kit_grace_period_secsdesc="The minimum grace period for a lost kit process (not referenced by coolwsd) to resolve its lost status before it is terminated. To disable the cleanup of lost kits use value 0"default="120">120</lost_kit_grace_period_secs>
<group_download_asdesc="If set to true, groups download as icons into a dropdown for the notebookbar view."type="bool"default="true">true</group_download_as>
<out_of_focus_timeout_secsdesc="The maximum number of seconds before dimming and stopping updates when the browser tab is no longer in focus. Defaults to 120 seconds."type="uint"default="120">120</out_of_focus_timeout_secs>
<idle_timeout_secsdesc="The maximum number of seconds before dimming and stopping updates when the user is no longer active (even if the browser is in focus). Defaults to 15 minutes."type="uint"default="900">900</idle_timeout_secs>
<leveltype="string"desc="Can be 0-8 (with the lowest numbers being the least verbose), or none (turns off logging), fatal, critical, error, warning, notice, information, debug, trace"default="@COOLWSD_LOGLEVEL@">@COOLWSD_LOGLEVEL@</level>
<level_startuptype="string"desc="As for level - but for the initial startup phase which is most problematic, logging reverts to level configured above when startup is complete"default="trace">trace</level_startup>
<most_verbose_level_settable_from_clienttype="string"desc="A loggingleveloverride message from the client can not set a more verbose log level than this"default="notice">notice</most_verbose_level_settable_from_client>
<least_verbose_level_settable_from_clienttype="string"desc="A loggingleveloverride message from a client can not set a less verbose log level than this"default="fatal">fatal</least_verbose_level_settable_from_client>
<protocoltype="bool"desc="Enable minimal client-site JS protocol logging from the start">@ENABLE_DEBUG_PROTOCOL@</protocol>
<!-- lokit_sal_log example: Log WebDAV-related messages, that is interesting for debugging Insert - Image operation: "+TIMESTAMP+INFO.ucb.ucp.webdav+WARN.ucb.ucp.webdav"
See also: https://docs.libreoffice.org/sal/html/sal_log.html -->
<lokit_sal_logtype="string"desc="Fine tune log messages from LOKit. Default is to suppress log messages from LOKit."default="-INFO-WARN">-INFO-WARN</lokit_sal_log>
<!-- If you use other path than /var/log and you run coolwsd from systemd, make sure that you enable that path in coolwsd.service (ReadWritePaths). -->
<propertyname="flush"desc="Enable/disable flushing after logging each line. May harm performance. Note that without flushing after each line, the log lines from the different processes will not appear in chronological order.">false</property>
<anonymize_user_datatype="bool"desc="Enable to anonymize/obfuscate of user-data in logs. If default is true, it was forced at compile-time and cannot be disabled."default="@COOLWSD_ANONYMIZE_USER_DATA@">@COOLWSD_ANONYMIZE_USER_DATA@</anonymize_user_data>
<anonymization_salttype="uint"desc="The salt used to anonymize/obfuscate user-data in logs. Use a secret 64-bit random number."default="82589933">82589933</anonymization_salt>
<pathdesc="Output path for the Trace Event file, to which they will be written if turned on at run-time"type="string"default="@COOLWSD_TRACEEVENTFILE@">@COOLWSD_TRACEEVENTFILE@</path>
<pathdesc="Output path to hold trace file and docs. Use '%' for timestamp to avoid overwriting. For example: /some/path/to/cooltrace-%.gz"compress="true"snapshot="false"></path>
<!-- On systems where localhost resolves to IPv6 [::1] address first, when net.proto is all and net.listen is loopback, coolwsd unexpectedly listens on [::1] only.
<lok_allowdesc="Allowed hosts as an external data source inside edited files. All allowed post_allow.host and storage.wopi entries are also considered to be allowed as a data source. Used for example in: PostMessage Action_InsertGraphics, =WEBSERVICE() function, external reference in the cell.">
<content_security_policydesc="Customize the CSP header by specifying one or more policy-directive, separated by semicolons. See w3.org/TR/CSP2"></content_security_policy>
<frame_ancestorsdesc="OBSOLETE: Use content_security_policy. Specify who is allowed to embed the Collabora Online iframe (coolwsd and WOPI host are always allowed). Separate multiple hosts by space."></frame_ancestors>
<connection_timeout_secsdesc="Specifies the connection, send, recv timeout in seconds for connections initiated by coolwsd (such as WOPI connections)."type="int"default="30"></connection_timeout_secs>
<enabletype="bool"desc="Controls whether SSL encryption between coolwsd and the network is enabled (do not disable for production deployment). If default is false, must first be compiled with SSL support to enable."default="@ENABLE_SSL@">@ENABLE_SSL@</enable>
<stsdesc="Strict-Transport-Security settings, per rfc6797. Subdomains are always included.">
<enableddesc="Whether or not Strict-Transport-Security is enabled. Enable only when ready for production. Cannot be disabled without resetting the browsers."type="bool"default="false">false</enabled>
<max_agedesc="Strict-Transport-Security max-age directive, in seconds. 0 is allowed; please see rfc6797 for details. Defaults to 1 year."type="int"default="31536000">31536000</max_age>
<enable_macros_executiondesc="Specifies whether the macro execution is enabled in general. This will enable Basic and Python scripts to execute both installed and from documents. If it is set to false, the macro_security_level is ignored. If it is set to true, the mentioned entry specified the level of macro security."type="bool"default="false">false</enable_macros_execution>
<macro_security_leveldesc="Level of Macro security. 1 (Medium) Confirmation required before executing macros from untrusted sources. 0 (Low, not recommended) All macros will be executed without confirmation."type="int"default="1">1</macro_security_level>
<enable_websocket_urpdesc="Should we enable URP (UNO remote protocol) communication over the websocket. This allows full control of the Kit child server to anyone with access to the websocket including executing macros without confirmation or running arbitrary shell commands in the jail."type="bool"default="false">false</enable_websocket_urp>
<enable_metrics_unauthenticateddesc="When enabled, the /cool/getMetrics endpoint will not require authentication."type="bool"default="false">false</enable_metrics_unauthenticated>
<modetype="string"desc="Controls the user interface style. The 'default' means: Take the value from ui_defaults, or decide for one of compact or tabbed (default|compact|tabbed)"default="default">default</mode>
<refreshdesc="How frequently we should re-acquire a lock with the storage server, in seconds (default 15 mins) or 0 for no refresh"type="int"default="900">900</refresh>
<alias_groupsdesc="default mode is 'first' it allows only the first host when groups are not defined. set mode to 'groups' and define group to allow multiple host and its aliases"mode="first">
<!-- If you need to use multiple wopi hosts, please change the mode to "groups" and
add the hosts below. If one host is accessible under multiple ip addresses
or names, add them as aliases. -->
<!--<group>
<hostdesc="hostname to allow or deny."allow="true">scheme://hostname:port</host>
<enabletype="bool"desc="If as_scheme is false or not set, this can be set to force SSL encryption between storage and coolwsd. When empty this defaults to following the ssl.enable setting"></enable>
<ca_file_pathdesc="Path to the ca file. If this is not empty, then SSL verification will be strict, otherwise cert of storage (WOPI-like host) will not be verified."relative="false"></ca_file_path>
<cipher_listdesc="List of OpenSSL ciphers to accept. If empty the defaults are used. These can be overridden only if absolutely needed."></cipher_list>
<passworddesc="The password of the admin console. Deprecated on most platforms. Instead, use PAM or coolconfig to set up a secure password."></password>
<loggingdesc="Log admin activities irrespective of logging.level">
<admin_logindesc="log when an admin logged into the console"type="bool"default="true">true</admin_login>
<metrics_fetchdesc="log when metrics endpoint is accessed and metrics endpoint authentication is enabled"type="bool"default="true">true</metrics_fetch>
<monitor_connectdesc="log when external monitor gets connected"type="bool"default="true">true</monitor_connect>
<admin_actiondesc="log when admin does some action for example killing a process"type="bool"default="true">true</admin_action>
<!-- <monitor desc="Address of the monitor and interval after which it should try reconnting after disconnect" retryInterval="20">wss://foobar:234/ws</monitor> -->
<limit_dir_size_mbdesc="Maximum directory size. On exceeding the specified limit, older files will be deleted."default="250"type="uint"></limit_dir_size_mb>
<max_versions_to_maintaindesc="How many versions of the same file to keep."default="2"type="uint"></max_versions_to_maintain>