From 16b98b986cc3159a25c569ab202bafdb94de0a20 Mon Sep 17 00:00:00 2001 From: MagicalCodeMonkey Date: Sat, 9 May 2020 01:49:40 -0400 Subject: [PATCH] Update settings.md (#23) --- docs/self-hosted/settings.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/self-hosted/settings.md b/docs/self-hosted/settings.md index 73799bb..3f52266 100644 --- a/docs/self-hosted/settings.md +++ b/docs/self-hosted/settings.md @@ -1,9 +1,20 @@ # Settings -The following can be used to change some of the settings in the application. Arguments are passed to the application by using `--=` when running the application. ENV variables are mostly for Docker but can be set locally on your system. +The following can be used to change some of the settings in the application via command-line arguments, environment variables (ENV), or the settings.json file. +Arguments are passed to the application by using `--=` when running the application. +ENV variables are mostly for Docker but can be set locally on your system. +The settings.json file is used by both the Server and Webapp. NOTE: Argument and ENV should be able to be used interchangeably. If you have issues with the ENV, use the argument value in its place. +## Server + +| Argument | ENV | Description | +| ------ | ------ | ------ | +| servers | SERVERS | Set your own servers list. See below for more information.
Optional | +| serverroot | SERVER_ROOT | Change the base URL of the server app.
Ex - `/server`.
Defaults to `/slserver` | +| server_port | SERVER_PORT | Change the port the server app uses.
Defaults to `8089` | + ## Webapp | Argument | ENV | Description | @@ -131,11 +142,3 @@ The entire servers list can be modified with your own list of servers. If this s ``` ![Custom Server List Example](https://user-images.githubusercontent.com/1524443/76433958-6daed600-638b-11ea-9cf6-41ea79182dbc.png) - -## Server - -| Argument | ENV | Description | -| ------ | ------ | ------ | -| servers | SERVERS | Set your own servers list. See below for more information.
Optional | -| serverroot | SERVER_ROOT | Change the base URL of the server app.
Ex - `/server`.
Defaults to `/slserver` | -| server_port | SERVER_PORT | Change the port the server app uses.
Defaults to `8089` |