mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2025-05-02 13:19:14 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

doc: rephrase settings.json.template and Settings.js

Browse source 
Better document current behaviour.
In this revision, ENV_VAR are supported, default values are not.
This commit is contained in:
muxator 2019-03-21 22:18:59 +01:00 • committed by muxator
parent 346d823279
commit 21ac37170e
2 changed files with 36 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

30
settings.json.template
View file

@ -11,7 +11,7 @@
* =================================
*
* All the configuration values can be read from environment variables using the
* syntax "${ENV_VAR_NAME}".
* syntax "${ENV_VAR}".
* This is useful, for example, when running in a Docker container.
*
* EXAMPLE:
@ -23,21 +23,23 @@
* variables PORT, MINIFY and SKIN_NAME.
*
* REMARKS:
* Please note that a variable substitution always needs to be quoted.
* "port": 9001, <-- Literal values. When not using substitution,
* "minify": false only strings must be quoted: booleans and
* "skin": "colibris" numbers must not.
* Please note that variable substitution always needs to be quoted.
*
* "port": ${PORT} <-- ERROR: this is not valid json
* "minify": ${MINIFY}
* "skin": ${SKIN_NAME}
* "port": 9001, <-- Literal values. When not using
* "minify": false substitution, only strings must be quoted.
* "skinName": "colibris" Booleans and numbers must not.
*
* "port": "${PORT}" <-- CORRECT: if you want to use a variable
* "minify": "${MINIFY}" substitution, put quotes around its name,
* "skinName": "${SKIN_NAME}" even if the required value is a number or a
* boolean.
* Etherpad will take care of rewriting it to
* the proper type if necessary.
*
* "port": ${PORT} <-- ERROR: this is not valid json. Quotes
* "minify": ${MINIFY} around variable names are missing.
* "skinName": ${SKIN_NAME}
*
* "port": "${PORT}" <-- CORRECT: if you want to use a variable
* "minify": "${MINIFY}" substitution, put quotes around its name,
* "skin": "${SKIN_NAME}" even if the required value is a number or a
* boolean.
* Etherpad will take care of rewriting it to
* the proper type if necessary.
*/
{
/*