mirror of
https://github.com/YunoHost-Apps/collabora_ynh.git
synced 2024-09-03 18:16:25 +02:00
Update coolwsd.xml
This commit is contained in:
ericgaspar
parent
636dcb55e0
commit
a7a8dbd655
1 changed files with 57 additions and 35 deletions
|
|
@ -7,22 +7,24 @@
|
|||
<!-- Note: 'default' attributes are used to document a setting's default value as well as to use as fallback. -->
|
||||
<!-- Note: When adding a new entry, a default must be set in WSD in case the entry is missing upon deployment. -->
|
||||
|
||||
<allowed_languages desc="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">de_DE en_GB en_US es_ES fr_FR it nl pt_BR pt_PT ru</allowed_languages>
|
||||
<allowed_languages desc="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>
|
||||
|
||||
<sys_template_path desc="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_path desc="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_tree desc="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_name desc="External hostname:port of the server running coolwsd. If empty, it's derived from the request (please set it if this doesn't work). Must be specified when behind a reverse-proxy or when the hostname is not reachable directly." type="string" default=""></server_name>
|
||||
<server_name desc="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_path desc="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_urls desc="Enable to protect encoded URLs from getting decoded by intermediate hops. Particularly useful on Azure deployments" type="bool" default="false"></hexify_embedded_urls>
|
||||
<experimental_features desc="Enable/Disable experimental features" type="bool" default="@ENABLE_EXPERIMENTAL@">@ENABLE_EXPERIMENTAL@</experimental_features>
|
||||
|
||||
<memproportion desc="The maximum percentage of system memory consumed by all of the Collabora Online Development Edition, after which we start cleaning up idle documents" type="double" default="80.0"></memproportion>
|
||||
<memproportion desc="The maximum percentage of system memory consumed by all of the @APP_NAME@, after which we start cleaning up idle documents" type="double" default="80.0"></memproportion>
|
||||
<num_prespawn_children desc="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> -->
|
||||
<per_document desc="Document-specific settings, including LO Core settings.">
|
||||
<max_concurrency desc="The maximum number of threads to use while processing a document." type="uint" default="4">4</max_concurrency>
|
||||
<batch_priority desc="A (lower) priority for use by batch eg. convert-to processes to avoid starving interactive ones" type="uint" default="5">5</batch_priority>
|
||||
<document_signing_url desc="The endpoint URL of signing server, if empty the document signing is disabled" type="string" default=""></document_signing_url>
|
||||
<document_signing_url desc="The endpoint URL of signing server, if empty the document signing is disabled" type="string" default="@VEREIGN_URL@">@VEREIGN_URL@</document_signing_url>
|
||||
<redlining_as_comments desc="If true show red-lines as comments" type="bool" default="false">false</redlining_as_comments>
|
||||
<pdf_resolution_dpi desc="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_secs desc="The maximum number of seconds before unloading an idle document. Defaults to 1 hour." type="uint" default="3600">3600</idle_timeout_secs>
|
||||
|
|
@ -36,6 +38,7 @@
|
|||
<limit_file_size_mb desc="The maximum file size allowed to each document process to write. 0 for unlimited." type="uint">0</limit_file_size_mb>
|
||||
<limit_num_open_files desc="The maximum number of files allowed to each document process to open. 0 for unlimited." type="uint">0</limit_num_open_files>
|
||||
<limit_load_secs desc="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_failures desc="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_secs desc="Maximum number of seconds to wait for a document conversion to succeed. 0 for unlimited." type="uint" default="100">100</limit_convert_secs>
|
||||
<cleanup desc="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_ms desc="Interval between two checks" type="uint" default="10000">10000</cleanup_interval_ms>
|
||||
|
|
@ -48,13 +51,13 @@
|
|||
</per_document>
|
||||
|
||||
<per_view desc="View-specific settings.">
|
||||
<group_download_as desc="If set to true, groups download as icons into a dropdown for the notebookbar view." type="bool" default="false">false</group_download_as>
|
||||
<out_of_focus_timeout_secs desc="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_secs desc="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>
|
||||
</per_view>
|
||||
|
||||
<ver_suffix desc="Appended to etags to allow easy refresh of changed files during development" type="string" default=""></ver_suffix>
|
||||
|
||||
|
||||
<logging>
|
||||
<color type="bool">true</color>
|
||||
<!--
|
||||
|
|
@ -62,16 +65,16 @@
|
|||
coolwsd command line, so if you want to change it for your testing, do it in
|
||||
Makefile.am, not here.
|
||||
-->
|
||||
<level type="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="warning">warning</level>
|
||||
<level type="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>
|
||||
<most_verbose_level_settable_from_client type="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_client type="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>
|
||||
<protocol type="bool" desc="Enable minimal client-site JS protocol logging from the start">false</protocol>
|
||||
<protocol type="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_log type="string" desc="Fine tune log messages from LOKit. Default is to suppress log messages from LOKit." default="-INFO-WARN">-INFO-WARN</lokit_sal_log>
|
||||
<file enable="false">
|
||||
<file enable="@COOLWSD_LOG_TO_FILE@">
|
||||
<!-- 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). -->
|
||||
<property name="path" desc="Log file path.">/var/log/coolwsd.log</property>
|
||||
<property name="path" desc="Log file path.">@COOLWSD_LOGFILE@</property>
|
||||
<property name="rotation" desc="Log file rotation strategy. See Poco FileChannel.">never</property>
|
||||
<property name="archive" desc="Append either timestamp or number to the archived log filename.">timestamp</property>
|
||||
<property name="compress" desc="Enable/disable log file compression.">true</property>
|
||||
|
|
@ -81,9 +84,10 @@
|
|||
<property name="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>
|
||||
</file>
|
||||
<anonymize>
|
||||
<anonymize_user_data type="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="false">false</anonymize_user_data>
|
||||
<anonymize_user_data type="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_salt type="uint" desc="The salt used to anonymize/obfuscate user-data in logs. Use a secret 64-bit random number." default="82589933">82589933</anonymization_salt>
|
||||
</anonymize>
|
||||
<docstats type="bool" desc="Enable to see document handling information in logs." default="false">false</docstats>
|
||||
</logging>
|
||||
|
||||
<!--
|
||||
|
|
@ -92,13 +96,13 @@
|
|||
not here.
|
||||
-->
|
||||
<trace_event desc="The possibility to turn on generation of a Chrome Trace Event file" enable="false">
|
||||
<path desc="Output path for the Trace Event file, to which they will be written if turned on at run-time" type="string" default="/var/log/coolwsd.trace.json">/var/log/coolwsd.trace.json</path>
|
||||
<path desc="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>
|
||||
</trace_event>
|
||||
|
||||
<browser_logging desc="Logging in the browser console" default="false">false</browser_logging>
|
||||
<browser_logging desc="Logging in the browser console" default="@BROWSER_LOGGING@">@BROWSER_LOGGING@</browser_logging>
|
||||
|
||||
<trace desc="Dump commands and notifications for replay. When 'snapshot' is true, the source file is copied to the path first." enable="false">
|
||||
<path desc="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">/tmp/cooltrace-%.gz</path>
|
||||
<path desc="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>
|
||||
<filter>
|
||||
<message desc="Regex pattern of messages to exclude"></message>
|
||||
</filter>
|
||||
|
|
@ -115,19 +119,22 @@
|
|||
<!-- this allows you to shift all of our URLs into a sub-path from
|
||||
https://my.com/browser/a123... to https://my.com/my/sub/path/browser/a123... -->
|
||||
<service_root type="path" default="" desc="Prefix all the pages, websockets, etc. with this path."></service_root>
|
||||
|
||||
<post_allow desc="Allow/deny client IP address for POST(REST)." allow="true">
|
||||
<host desc="The IPv4 private 192.168 block as plain IPv4 dotted decimal addresses.">192\.168\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Ditto, but as IPv4-mapped IPv6 addresses">::ffff:192\.168\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="The IPv4 loopback (localhost) address.">127\.0\.0\.1</host>
|
||||
<host desc="Ditto, but as IPv4-mapped IPv6 address">::ffff:127\.0\.0\.1</host>
|
||||
<host desc="The IPv6 loopback (localhost) address.">::1</host>
|
||||
<host desc="The IPv4 private 172.17.0.0/16 subnet (Docker).">172\.17\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Ditto, but as IPv4-mapped IPv6 addresses">::ffff:172\.17\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="The IPv4 private 172.16.0.0/12 subnet part 1.">172\.1[6789]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Ditto, but as IPv4-mapped IPv6 addresses">::ffff:172\.1[6789]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="The IPv4 private 172.16.0.0/12 subnet part 2.">172\.2[0-9]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Ditto, but as IPv4-mapped IPv6 addresses">::ffff:172\.2[0-9]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="The IPv4 private 172.16.0.0/12 subnet part 3.">172\.3[01]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Ditto, but as IPv4-mapped IPv6 addresses">::ffff:172\.3[01]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="The IPv4 private 10.0.0.0/8 subnet (Podman).">10\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Ditto, but as IPv4-mapped IPv6 addresses">::ffff:10\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
</post_allow>
|
||||
<frame_ancestors desc="Specify who is allowed to embed the LO Online iframe (coolwsd and WOPI host are always allowed). Separate multiple hosts by space."></frame_ancestors>
|
||||
<frame_ancestors desc="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_secs desc="Specifies the connection, send, recv timeout in seconds for connections initiated by coolwsd (such as WOPI connections)." type="int" default="30"></connection_timeout_secs>
|
||||
|
||||
<!-- this setting radically changes how online works, it should not be used in a production environment -->
|
||||
|
|
@ -136,7 +143,7 @@
|
|||
|
||||
<ssl desc="SSL settings">
|
||||
<!-- switches from https:// + wss:// to http:// + ws:// -->
|
||||
<enable type="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="true">false</enable>
|
||||
<enable type="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>
|
||||
<!-- SSL off-load can be done in a proxy, if so disable SSL, and enable termination below in production -->
|
||||
<termination desc="Connection via proxy where coolwsd acts as working via https, but actually uses http." type="bool" default="true">true</termination>
|
||||
<cert_file_path desc="Path to the cert file" relative="false">/etc/coolwsd/cert.pem</cert_file_path>
|
||||
|
|
@ -150,6 +157,10 @@
|
|||
<pin></pin>
|
||||
</pins>
|
||||
</hpkp>
|
||||
<sts desc="Strict-Transport-Security settings, per rfc6797. Subdomains are always included.">
|
||||
<enabled desc="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_age desc="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>
|
||||
</sts>
|
||||
</ssl>
|
||||
|
||||
<security desc="Altering these defaults potentially opens you to significant risk">
|
||||
|
|
@ -170,35 +181,34 @@
|
|||
<text desc="Watermark text to be displayed on the document if entered" type="string"></text>
|
||||
</watermark>
|
||||
|
||||
<welcome>
|
||||
<enable type="bool" desc="Controls whether the welcome screen should be shown to the users on new install and updates." default="true">true</enable>
|
||||
<enable_button type="bool" desc="Controls whether the welcome screen should have an explanatory button instead of an X button to close the dialog." default="false">false</enable_button>
|
||||
<path desc="Path to 'welcome-$lang.html' files served on first start or when the version changes. When empty, defaults to the Release notes." type="path" relative="true" default="browser/welcome"></path>
|
||||
</welcome>
|
||||
@WELCOME_CONFIG_FRAGMENT@
|
||||
|
||||
<user_interface>
|
||||
<mode type="string" desc="Controls the user interface style. The 'default' means: Take the value from ui_defaults, or decide for one of classic or notebookbar (default|classic|notebookbar)" default="default">default</mode>
|
||||
<mode type="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>
|
||||
<use_integration_theme desc="Use theme from the integrator" type="bool" default="true">true</use_integration_theme>
|
||||
</user_interface>
|
||||
|
||||
<storage desc="Backend storage">
|
||||
<filesystem allow="false" />
|
||||
<wopi desc="Allow/deny wopi storage." allow="true">
|
||||
<host desc="Regex pattern of hostname to allow or deny." allow="true">__NEXTCLOUD_DOMAIN__</host>
|
||||
<host desc="Regex pattern of hostname to allow or deny." allow="true">10\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Regex pattern of hostname to allow or deny." allow="true">172\.1[6789]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Regex pattern of hostname to allow or deny." allow="true">172\.2[0-9]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Regex pattern of hostname to allow or deny." allow="true">172\.3[01]\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Regex pattern of hostname to allow or deny." allow="true">192\.168\.[0-9]{1,3}\.[0-9]{1,3}</host>
|
||||
<host desc="Regex pattern of hostname to allow or deny." allow="false">192\.168\.1\.1</host>
|
||||
|
||||
|
||||
<max_file_size desc="Maximum document size in bytes to load. 0 for unlimited." type="uint">0</max_file_size>
|
||||
|
||||
<locking desc="Locking settings">
|
||||
<refresh desc="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>
|
||||
</locking>
|
||||
</wopi>
|
||||
|
||||
<alias_groups desc="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>
|
||||
<host desc="hostname to allow or deny." allow="true">scheme://hostname:port</host>
|
||||
<alias desc="regex pattern of aliasname">scheme://aliasname1:port</alias>
|
||||
<alias desc="regex pattern of aliasname">scheme://aliasname2:port</alias>
|
||||
</group>-->
|
||||
<!-- More "group"s possible here -->
|
||||
</alias_groups>
|
||||
|
||||
</wopi>
|
||||
<ssl desc="SSL settings">
|
||||
<as_scheme type="bool" default="true" desc="When set we exclusively use the WOPI URI's scheme to enable SSL for storage">true</as_scheme>
|
||||
<enable type="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>
|
||||
|
|
@ -228,4 +238,16 @@
|
|||
<expiry_min desc="Time in mins after quarantined files will be deleted." type="int" default="30"></expiry_min>
|
||||
</quarantine_files>
|
||||
|
||||
<remote_config>
|
||||
<remote_url desc="remote server to which you will send resquest to get remote config in response" type="string" default=""></remote_url>
|
||||
</remote_config>
|
||||
|
||||
<remote_font_config>
|
||||
<url desc="URL of optional JSON file that lists fonts to be included in Online" type="string" default=""></url>
|
||||
</remote_font_config>
|
||||
|
||||
@LOCK_CONFIGURATION@
|
||||
|
||||
@FEATURE_RESTRICTION_CONFIGURATION@
|
||||
|
||||
</config>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue