From 5fad8a2baa7ae9be16111ba5440c174f55c09b27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jordi=20Guti=C3=A9rrez=20Hermoso?= Date: Tue, 23 Apr 2024 11:42:58 -0400 Subject: [PATCH] (docs) README.md: reformat envvars table This is just a source-level reformatting to realign it. --- README.md | 130 +++++++++++++++++++++++++++--------------------------- 1 file changed, 65 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 774b1205..c950d741 100644 --- a/README.md +++ b/README.md @@ -233,72 +233,72 @@ For more on Grist Labs' history and principles, see our [About Us](https://www.g Grist can be configured in many ways. Here are the main environment variables it is sensitive to: -Variable | Purpose --------- | ------- -ALLOWED_WEBHOOK_DOMAINS | comma-separated list of permitted domains to use in webhooks (e.g. webhook.site,zapier.com). You can set this to `*` to allow all domains, but if doing so, we recommend using a carefully locked-down proxy (see `GRIST_HTTPS_PROXY`) if you do not entirely trust users. Otherwise services on your internal network may become vulnerable to manipulation. -APP_DOC_URL | doc worker url, set when starting an individual doc worker (other servers will find doc worker urls via redis) -APP_DOC_INTERNAL_URL | like `APP_DOC_URL` but used by the home server to reach the server using an internal domain name resolution (like in a docker environment). Defaults to `APP_DOC_URL` -APP_HOME_URL | url prefix for home api (home and doc servers need this) -APP_STATIC_URL | url prefix for static resources -APP_STATIC_INCLUDE_CUSTOM_CSS | set to "true" to include custom.css (from APP_STATIC_URL) in static pages -APP_UNTRUSTED_URL | URL at which to serve/expect plugin content. -GRIST_ADAPT_DOMAIN | set to "true" to support multiple base domains (careful, host header should be trustworthy) -GRIST_APP_ROOT | directory containing Grist sandbox and assets (specifically the sandbox and static subdirectories). -GRIST_BACKUP_DELAY_SECS | wait this long after a doc change before making a backup -GRIST_BOOT_KEY | if set, offer diagnostics at /boot/GRIST_BOOT_KEY -GRIST_DEFAULT_EMAIL | if set, login as this user if no other credentials presented -GRIST_DEFAULT_PRODUCT | if set, this controls enabled features and limits of new sites. See names of PRODUCTS in Product.ts. -GRIST_DEFAULT_LOCALE | Locale to use as fallback when Grist cannot honour the browser locale. -GRIST_DOMAIN | in hosted Grist, Grist is served from subdomains of this domain. Defaults to "getgrist.com". -GRIST_EXPERIMENTAL_PLUGINS | enables experimental plugins -GRIST_ENABLE_REQUEST_FUNCTION | enables the REQUEST function. This function performs HTTP requests in a similar way to `requests.request`. This function presents a significant security risk, since it can let users call internal endpoints when Grist is available publicly. This function can also cause performance issues. Unset by default. -GRIST_HIDE_UI_ELEMENTS | comma-separated list of UI features to disable. Allowed names of parts: `helpCenter,billing,templates,createSite,multiSite,multiAccounts,sendToDrive,tutorials,supportGrist`. If a part also exists in GRIST_UI_FEATURES, it will still be disabled. -GRIST_HOST | hostname to use when listening on a port. -GRIST_HTTPS_PROXY | if set, use this proxy for webhook payload delivery. -GRIST_ID_PREFIX | for subdomains of form o-*, expect or produce o-${GRIST_ID_PREFIX}*. -GRIST_IGNORE_SESSION | if set, Grist will not use a session for authentication. -GRIST_INCLUDE_CUSTOM_SCRIPT_URL | if set, will load the referenced URL in a `