From ae15b61ee01e22a461644e1067f8f16cbe713946 Mon Sep 17 00:00:00 2001 From: Madeline <46743919+MaddyUnderStars@users.noreply.github.com> Date: Sat, 21 Jan 2023 13:59:31 +1100 Subject: [PATCH] docs for fosscord/fosscord-server#962 --- docs/setup/server/configuration/env.md | 33 +++++++++++++------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/docs/setup/server/configuration/env.md b/docs/setup/server/configuration/env.md index 7ffa082..63f8a45 100644 --- a/docs/setup/server/configuration/env.md +++ b/docs/setup/server/configuration/env.md @@ -4,19 +4,20 @@ Below is a list of environment variables used by Fosscord. You can set environment variables easily by creating an `.env` file in the `fosscord-server` folder, with the format `NAME=VALUE` with each on new lines. -| Name | Value | Description | -| ---------------- | -------------- | -------------------------------------------------------------------------------------------------------------------- | -| THREADS | number | Number of threads to run Fosscord on when using bundle. Make sure you've enabled RabbitMQ if using more than one | -| PORT | number | Port to listen on. Used by all components, including bundle. If using bundle, all components run under the same port | -| DATABASE | string | Database connection string. Defaults to SQlite3 at project root | -| CONFIG_PATH | string | File path for JSON config, if not using `config` db table | -| WS_LOGEVENTS | boolean | If set, log websocket events except messages from gateway | -| WS_VERBOSE | boolean | If set, log websocket messages sent/received by gateway | -| WS_DUMP | boolean | If set, dump websocket messages sent/received to disk | -| CDN | string | Lowest priority value for public CDN annoucements | -| GATEWAY | string | Lowest priority value for public gateway annoucements | -| STORAGE_LOCATION | string | CDN storage location. File path or S3 bucktet | -| STORAGE_PROVIDER | "s3" or "file" | CDN storage provider | -| STORAGE_BUCKET | string | S3 bucket name | -| STORAGE_REGION | string | S3 storage region | -| ONLY_CACHE_JS | any | If set, [`npm run generate:client`](../npmScripts.md#generateclient) will only cache JS files. | +| Name | Value | Description | +| -------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------- | +| THREADS | number | Number of threads to run Fosscord on when using bundle. Make sure you've enabled RabbitMQ if using more than one | +| PORT | number | Port to listen on. Used by all components, including bundle. If using bundle, all components run under the same port | +| DATABASE | string | Database connection string. Defaults to SQlite3 at project root | +| CONFIG_PATH | string | File path for JSON config, if not using `config` db table | +| WS_LOGEVENTS | boolean | If set, log websocket events except messages from gateway | +| WS_VERBOSE | boolean | If set, log websocket messages sent/received by gateway | +| WS_DUMP | boolean | If set, dump websocket messages sent/received to disk | +| CDN | string | Lowest priority value for public CDN annoucements | +| GATEWAY | string | Lowest priority value for public gateway annoucements | +| STORAGE_LOCATION | string | CDN storage location. File path or S3 bucktet | +| STORAGE_PROVIDER | "s3" or "file" | CDN storage provider | +| STORAGE_BUCKET | string | S3 bucket name | +| STORAGE_REGION | string | S3 storage region | +| ONLY_CACHE_JS | any | If set, [`npm run generate:client`](../npmScripts.md#generateclient) will only cache JS files. | +| CLIENT_PATCH_INSTANCE_NAME | string | If set, [`npm run generate:client`](../npmScripts.md#generateclient) will use this as instance name. |