Release 2.4.25 - See CHANGELOG.md

tiredofit · Mar 23, 2023 · 8a51d89 · 8a51d89
1 parent 102f18c
commit 8a51d89
Show file tree

Hide file tree

Showing 4 changed files with 228 additions and 99 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,20 @@
+## 2.4.25 2023-03-23 <dave at tiredofit dot ca>
+
+   ### Added
+      - Add DeepL Translation Support
+      - Add Zotero Citation Support
+      - Add support for Fonts Missing
+      - Add more options for Language Tool
+      - Add UI option to Group Download As items
+      - Add performance settings for minimum time between saves/uploads
+      - Add PDF Resolution DPI settings
+
+   ### Reverted
+      - Remove MEMORY_DATA_LIMIT
+      - Remove LOLEAFLET_HTML
+      - Rework config to be better legible
+
+
 ## 2.4.24 2023-03-23 <dave at tiredofit dot ca>
 
    ### Added

diff --git a/README.md b/README.md
@@ -45,7 +45,9 @@ This will build a Docker image for [Collabora Online](https://www.collaboraoffic
     - [TLS Settings](#tls-settings)
     - [Performance and Limits](#performance-and-limits)
     - [Files Quarantine](#files-quarantine)
+    - [DeepL Translation](#deepl-translation)
     - [Language Tool](#language-tool)
+    - [Zotero](#zotero)
     - [Cleanup](#cleanup)
     - [Other Settings](#other-settings)
     - [Adding Custom Fonts](#adding-custom-fonts)
@@ -134,6 +136,7 @@ Be sure to view the following repositories to understand all the customizable op
 | `ALLOWED_HOSTS`                  | Set which domains which can access service Seperate Multiple with `,` - Example: `https://www.example\.org` (no wildcards) | ``            |
 | `EXTRA_OPTIONS`                  | If you want to pass additional arguments upon startup, add it here                                                         | ``            |
 | `INTERFACE`                      | Web interface type `classic` or `notebookbar`                                                                              | `notebookbar` |
+| `GROUP_DOWNLOAD_AS` | Group Download as Icons into dropdown in notebookbar view | `TRUE` |
 | `WATERMARK_OPACITY`              | Watermark Opacity                                                                                                          | `0.2`         |
 | `WATERMARK_TEXT`                 | Text to display for watermark                                                                                              | ``            |
 | `ENABLE_MACROS`                  | Enable Macros                                                                                                              | `FALSE`       |
@@ -242,11 +245,12 @@ The image comes with English (US, GB, Canada variants) baked into the image, how
 | `FILE_SIZE_LIMIT`           | The maximum file size allowed to each document process to write                                                                       | `0` (unlimited) |
 | `IDLE_SAVE`                 | The number of idle seconds after which document, if modified, should be saved                                                         | `30`            |
 | `IDLE_UNLOAD_TIMEOUT`       | The maximum number of seconds before unloading an idle documen                                                                        | `3600`          |
+| `MIN_TIME_BETWEEN_SAVES` | Minimum number of milliseconds between saving document on disk | `500` |
+| `MIN_TIME_BETWEEN_UPLOADS` | Minimum number of milliseconds between uploading document to storage | `5000` |
 | `MAX_CONVERT_LIMIT`         | Maximum time in seconds to wait for a convert process to complete                                                                     | `30`            |
 | `MAX_FILE_LOAD_LIMIT`       | Maximum number of seconds to wait for a document load to succeed                                                                      | `100`           |
 | `MAX_OPEN_FILES`            | The maximum number of files allowed to each document process to open                                                                  | `0` (unlimited) |
 | `MAX_THREADS_DOCUMENT`      | How many threads to use when opening a document                                                                                       | `4`             |
-| `MEMORY_DATA_LIMIT`         | The maximum memory data segment allowed to each document process                                                                      | `0` (unlimited) |
 | `MEMORY_STACK_LIMIT`        | The maximum stack size allowed to each document process                                                                               | `0` (unlimited) |
 | `MEMORY_USAGE_MAX`          | Maximum percentage of system memory to be used                                                                                        | `80.0`          |
 | `MEMORY_VIRT_LIMIT`         | Maximum virtual memory allowed to each document process                                                                               | `0`             |
@@ -263,13 +267,26 @@ The image comes with English (US, GB, Canada variants) baked into the image, how
 | `FILES_QUARANTINE_PATH`                 | Relative path for storing files                        | `quarantine` |
 | `FILES_QUARANTINE_EXPIRY`               | Files expiry in minutes                                | `30`         |
 
+#### DeepL Translation
+| Parameter                     | Description                                                              | Default |
+| ----------------------------- | ------------------------------------------------------------------------ | ------- |
+| `ENABLE_DEEPL`        | Enable DeepL Translation Support                       | `FALSE` |
+| `DEEPL_API_URL` | DeepL API URL | `` |
+| `DEEPL_AUTH_KEY` | DeepL Auth Key | `` |
 #### Language Tool
-| Parameter                 | Description                                        | Default |
-| ------------------------- | -------------------------------------------------- | ------- |
-| `ENABLE_LANGUAGE_TOOL`    | Enable Language Tool  Grammar checking integration | `FALSE` |
-| `LANGUAGE_TOOL_BASE_URL`  | Base URL for Language Tool                         |         |
-| `LANGUAGE_TOOL_USER_NAME` | Language Tool User Name                            |         |
-| `LANGUAGE_TOOL_API_KEY`   | Language Tool provided API Key                     |         |
+| Parameter                     | Description                                                              | Default |
+| ----------------------------- | ------------------------------------------------------------------------ | ------- |
+| `ENABLE_LANGUAGE_TOOL`        | Enable Language Tool  Grammar checking integration                       | `FALSE` |
+| `LANGUAGE_TOOL_BASE_URL`      | Base URL for Language Tool                                               |         |
+| `LANGUAGE_TOOL_USER_NAME`     | Language Tool User Name                                                  |         |
+| `LANGUAGE_TOOL_API_KEY`       | Language Tool provided API Key                                           |         |
+| `LANGUAGE_TOOL_REST_PROTOCOL` | REST protocol. blank for Language Tool `duden` for Duden Korrekturserver |         |
+| `LANGUAGE_TOOL_SSL_VERIFY`    | SSL Verify                                                               | `TRUE`  |
+
+#### Zotero
+| Parameter                     | Description                                                              | Default |
+| ----------------------------- | ------------------------------------------------------------------------ | ------- |
+| `ENABLE_ZOTERO` | Enable Zotero Citations | `TRUE` |
 
 #### Cleanup
 | Parameter                    | Description                                                                     | Default |
@@ -291,14 +308,14 @@ The image comes with English (US, GB, Canada variants) baked into the image, how
 | `ENABLE_EXPERIMENTAL_FEATURES` | Enable experimental features                                                                                      | `FALSE`         |
 | `ENABLE_MOUNT_JAIL`            | Enable mounting jails                                                                                             | `true`          |
 | `ENABLE_SECCOMP`               | Enable Seccomp                                                                                                    | `TRUE`          |
-| `ENABLE_WEBDAV`                | Enable WebDav Storage                                                                                             | `FALSE`         |
 | `FILE_SERVER_ROOT_PATH`        | Path to directory considered as root                                                                              | `browser/../`   |
 | `FRAME_ANCESTORS`              | Hosts where interface can be hosted in Iframe                                                                     | ``              |
 | `HEXIFY_EMBEDDED_URLS`         | Hexify Embedded URLS (useful for Azure deployments)                                                               | `FALSE`         |
-| `LOLEAFLET_HTML`               | Name of browser.html to use                                                                                       | `loleafet.html` |
+| `INDIRECTION_ENDPOINT` | URL endpoint to server which zervers routeToken in json format | |
 | `NETWORK_PROTOCOL`             | Network Protocol `ipv4` `ipv6` `all`                                                                              | `ipv4`          |
+| `PDF_RESOLUTION_DPI` | PDF Resolution DPI when rendering PDF documents as image | `96` |
 | `REDLINING_AS_COMMENTS`        | Show red-lines as comments                                                                                        | `false`         |
-| `REMOTE_FONT_URL`              | URL to json font lists to load                                                                                    |                 |
+| `REMOTE_URL` | Remote server to send request to get remote config | |
 | `SYS_TEMPLATE_PATH`            | System Template Path                                                                                              | `systemplate`   |
 | `USE_INTEGRATOR_THEME`         | Use the remote integrators theme                                                                                  | `TRUE`          |
 | `VERSION_SUFFIX`               | Append this value onto version to break cache when developing. Generates random uuid when using value of `random` |                 |
@@ -307,6 +324,13 @@ The image comes with English (US, GB, Canada variants) baked into the image, how
 #### Adding Custom Fonts
 This image comes with some highly opninionated default fonts by the LibreOffice team, and also includes the Microsoft TTF fonts from the late 90s. To add custom fonts into this image, cxport a volume and place them in `/assets/custom-fonts` and they will be inserted upon next container restart.
 
+You can also configure this inside the container with a compatible application.
+
+| Parameter                      | Description                                                                                                       | Default         |
+| ------------------------------ | ----------------------------------------------------------------------------------------------------------------- | --------------- |
+| `REMOTE_FONT_URL`              | URL to json font lists to load                                                                                    |                 |
+| `FONTS_MISSING_ACTION` | How to handle fonts missing in a document `report` `log` `both` `ignore` | `log` |
+
 ### Networking
 
 The following ports are exposed.

diff --git a/install/assets/defaults/10-coolwsd b/install/assets/defaults/10-coolwsd
@@ -11,10 +11,13 @@ CLEANUP_INTERVAL=${CLEANUP_INTERVAL:-"10000"}
 CLEANUP_LIMIT_CPU_PER=${CLEANUP_LIMIT_CPU_PER:-85}
 CLEANUP_LIMIT_DIRTY_MEMORY=${CLEANUP_LIMIT_DIRTY_MEMORY:-3072}
 CONNECTION_TIMEOUT=${CONNECTION_TIMEOUT:-30}
+DEEPL_API_URL=${DEEPL_API_URL:-""}
+DEEPL_AUTH_KEY=${DEEPL_AUTH_KEY:-""}
 ENABLE_ADMIN_CONSOLE=${ENABLE_ADMIN_CONSOLE:-"TRUE"}
 ENABLE_CAPABILITIES=${ENABLE_CAPABILITIES:-"true"}
 ENABLE_CLEANUP=${ENABLE_CLEANUP:-"false"}
 ENABLE_CONFIG_RELOAD=${ENABLE_CONFIG_RELOAD:-"TRUE"}
+ENABLE_DEEPL=${ENABLE_DEEPL:-"FALSE"}
 ENABLE_DOCUMENT_STATISTICS=${ENABLE_DOCUMENT_STATISTICS:-"FALSE"}
 ENABLE_EXPERIMENTAL_FEATURES=${ENABLE_EXPERIMENTAL_FEATURES:-"false"}
 ENABLE_FILES_QUARANTINE=${ENABLE_FILES_QUARANTINE:-"FALSE"}
@@ -29,21 +32,26 @@ ENABLE_TLS=${ENABLE_TLS:-"FALSE"}
 ENABLE_TLS_CERT_GENERATE=${ENABLE_TLS_CERT_GENERATE:-"TRUE"}
 ENABLE_TLS_REVERSE_PROXY=${ENABLE_TLS_REVERSE_PROXY:-"TRUE"}
 ENABLE_USER_STATISTICS=${ENABLE_USER_STATISTICS:-"FALSE"}
-ENABLE_WEBDAV=${ENABLE_WEBDAV:-"FALSE"}
+ENABLE_ZOTERO=${ENABLE_ZOTERO:-"TRUE"}
 FILES_QUARANTINE_DIRECTORY_SIZE_LIMIT=${FILES_QUARANTINE_DIRECTORY_SIZE_LIMIT:-"250"}
 FILES_QUARANTINE_EXPIRY=${FILES_QUARANTINE_EXPIRY:-"30"}
 FILES_QUARANTINE_MAX_VERSIONS=${FILES_QUARANTINE_MAX_VERSIONS:-"2"}
 FILES_QUARANTINE_PATH=${FILES_QUARANTINE_PATH:-"quarantine"}
 FILE_SERVER_ROOT_PATH=${FILE_SERVER_ROOT_PATH:-"browser/../"}
 FILE_SIZE_LIMIT=${FILE_SIZE_LIMIT:-0}
+FONTS_MISSING_ACTION=${FONTS_MISSING_ACTION:-"log"}
+GROUP_DOWNLOAD_AS=${GROUP_DOWNLOAD_AS:-"TRUE"}
 HEXIFY_EMBEDDED_URLS=${HEXIFY_EMBEDDED_URLS:-"FALSE"}
 IDLE_SAVE=${IDLE_SAVE:-30}
 IDLE_UNLOAD_TIMEOUT=${IDLE_UNLOAD_TIMEOUT:-3600}
+INDIRECTION_ENDPOINT=${INDIRECTION_ENDPOINT:-""}
 INTERFACE=${INTERFACE:-"notebookbar"}
 LANGUAGE=${LANGUAGE:-'en_GB en_US'}
 LANGUAGE_TOOL_API_KEY=${LANGUAGE_TOOL_API_KEY:-""}
 LANGUAGE_TOOL_BASE_URL=${LANGUAGE_TOOL_BASE_URL:-""}
 LANGUAGE_TOOL_USER_NAME=${LANGUAGE_TOOL_USER_NAME:-""}
+LANGUAGE_TOOL_REST_PROTOCOL=${LANGUAGE_TOOL_REST_PROTOCOL:-""}
+LANGUAGE_TOOL_SSL_VERIFY=${LANGUAGE_TOOL_SSL_VERIFY:-"TRUE"}
 LOG_ANONYMIZE=${LOG_ANONYMIZE:-"FALSE"}
 LOG_ANONYMIZE_SALT=${LOG_ANONYMIZE_SALT:-"$(date +%s%N | cut -b12-19)"}
 LOG_CLIENT_CONSOLE=${LOG_CLIENT_CONSOLE:-"false"}
@@ -56,18 +64,19 @@ LOG_LEVEL_CLIENT_MOST_VERBOSE=${LOG_LEVEL_CLIENT_MOST_VERBOSE:-"NOTICE"}
 LOG_LIBREOFFICE=${LOG_LIBREOFFICE:-"-INFO-WARN"}
 LOG_PATH=${LOG_PATH:-"/logs/"}
 LOG_TYPE=${LOG_TYPE:-"CONSOLE"}
-LOLEAFLET_HTML=${LOLEAFLET_HTML:-"browser.html"}
 MACRO_SECURITY_LEVEL=${MACRO_SECURITY_LEVEL:-"1"}
 MAX_CONVERT_LIMIT=${MAX_CONVERT_LIMIT:-100}
 MAX_FILE_LOAD_LIMIT=${MAX_FILE_LOAD_LIMIT:-100}
 MAX_OPEN_FILES=${MAX_OPEN_FILES:-0}
 MAX_THREADS_DOCUMENT=${MAX_THREADS_DOCUMENT:-4}
-MEMORY_DATA_LIMIT=${MEMORY_DATA_LIMIT:-0}
+MIN_TIME_BETWEEN_SAVES=${MIN_TIME_BETWEEN_SAVES:-"500"}
+MIN_TIME_BETWEEN_UPLOADS=${MIN_TIME_BETWEEN_UPLOADS:-"5000"}
 MEMORY_STACK_LIMIT=${MEMORY_STACK_LIMIT:-8000}
 MEMORY_USAGE_MAX=${MEMORY_USAGE_MAX:-"80.0"}
 MEMORY_VIRT_LIMIT=${MEMORY_VIRT_LIMIT:-0}
 NETWORK_PROTOCOL=${NETWORK_PROTOCOL:-"ipv4"}
 PATH_PREFIX=${PATH_PREFIX:-"/opt/cool/"}
+PDF_RESOLUTION_DPI=${PDF_RESOLUTION_DPI:-"96"}
 PRESPAWN_CHILD_PROCESSES=${PRESPAWN_CHILD_PROCESSES:-1}
 REDLINING_AS_COMMENTS=${REDLINING_AS_COMMENTS:-"false"}
 REMOTE_FONT_URL=${REMOTE_FONT_URL:-""}