From bf9539386adb6129e1e08d4ce2dfac06c23a4cbe Mon Sep 17 00:00:00 2001 From: Alex Vandiver Date: Fri, 7 Jun 2024 02:07:50 +0000 Subject: [PATCH] katex: Default the server on. The memory costs are low (~60MB), and likely worth the stability. --- docs/production/system-configuration.md | 12 ++++++------ puppet/zulip/manifests/app_frontend_base.pp | 2 +- zproject/computed_settings.py | 2 +- zproject/test_extra_settings.py | 2 ++ 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/production/system-configuration.md b/docs/production/system-configuration.md index af35e2619c..8750d5f2ab 100644 --- a/docs/production/system-configuration.md +++ b/docs/production/system-configuration.md @@ -193,15 +193,15 @@ Defaults to 14 days. #### `katex_server` -Set to a true value to run a separate service for [rendering math with -LaTeX](https://zulip.com/help/latex). This is not necessary except on servers -with users who send several math blocks in a single message; it will address -issues with such messages occasionally failing to send, at cost of a small -amount of increased memory usage. +Set to a false value to disable the separate service for [rendering math with +LaTeX](https://zulip.com/help/latex). Disabling this service will save a small +amount of memory, at the cost of making math blocks significantly slower to +render, to the point that using dozens of them in a single message may cause +the message to fail to send. #### `katex_server_port` -Set to the port number for the KaTeX server, if enabled; defaults to port 9700. +Set to the port number for the KaTeX server; defaults to port 9700. ### `[postfix]` diff --git a/puppet/zulip/manifests/app_frontend_base.pp b/puppet/zulip/manifests/app_frontend_base.pp index a02e373b5f..0ffedf67d6 100644 --- a/puppet/zulip/manifests/app_frontend_base.pp +++ b/puppet/zulip/manifests/app_frontend_base.pp @@ -167,7 +167,7 @@ class zulip::app_frontend_base { include zulip::smokescreen } - $katex_server = zulipconf('application_server', 'katex_server', false) + $katex_server = zulipconf('application_server', 'katex_server', true) $katex_server_port = zulipconf('application_server', 'katex_server_port', '9700') if $proxy_host != '' and $proxy_port != '' { diff --git a/zproject/computed_settings.py b/zproject/computed_settings.py index 17b198a42f..f8811836da 100644 --- a/zproject/computed_settings.py +++ b/zproject/computed_settings.py @@ -522,7 +522,7 @@ CAMO_KEY = get_secret("camo_key") if CAMO_URI != "" else None # KATEX SERVER SETTINGS ######################################################################## -KATEX_SERVER = get_config("application_server", "katex_server", False) +KATEX_SERVER = get_config("application_server", "katex_server", True) KATEX_SERVER_PORT = get_config("application_server", "katex_server_port", "9700") diff --git a/zproject/test_extra_settings.py b/zproject/test_extra_settings.py index 01c31fa9a1..6a83b58ee3 100644 --- a/zproject/test_extra_settings.py +++ b/zproject/test_extra_settings.py @@ -275,3 +275,5 @@ ALLOW_GROUP_VALUED_SETTINGS = True # This allows tests to not worry about the special behavior during the grace period. # Otherwise they would have to do lots of mocking of the timer to work around this. RESOLVE_TOPIC_UNDO_GRACE_PERIOD_SECONDS = 0 + +KATEX_SERVER = False