aboutsummaryrefslogtreecommitdiffstats
path: root/docs/part-1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/part-1')
-rw-r--r--docs/part-1/2_install-xds-server.md41
1 files changed, 9 insertions, 32 deletions
diff --git a/docs/part-1/2_install-xds-server.md b/docs/part-1/2_install-xds-server.md
index 6c9dad7..3609bd7 100644
--- a/docs/part-1/2_install-xds-server.md
+++ b/docs/part-1/2_install-xds-server.md
@@ -219,41 +219,18 @@ are set into `/etc/default/xds-server` file.
and default JSON config is `/etc/xds/server/server-config.json`.
<!-- note -->
-**Note:** you can use your own JSON config by settings `APP_CONFIG` variable of
+**Note:**
+
+- You can use your own JSON config by settings `APP_CONFIG` variable of
`/etc/default/xds-server` file to your file, for example `/home/MYUSER/.xds/server/server-config.json`
-<!-- endnote -->
-Supported fields in JSON configuration file are :
-
-- **httpPort** : HTTP port of client webapp/REST API
-- **webAppDir** : location of client web application (default: webapp/dist)
-- **shareRootDir** : root directory where projects will be copied
-- **logsDir** : directory to store logs (eg. syncthing output)
-- **sdkScriptsDir** : directory where scripts, used to managed SDKs, are installed
-- **syncthing.binDir** : syncthing binaries directory (default: executable directory)
-- **syncthing.home"** : syncthing home directory (usually .../syncthing-config)
-- **syncthing.gui-address** : syncthing gui url (default <http://localhost:8385>)
-- **syncthing.gui-apikey** : syncthing api-key to use (default auto-generated)
-
-All fields are optional and example below corresponds to the default values:
-
-```json
-{
- "httpPort": 8000,
- "webAppDir": "webapp/dist",
- "shareRootDir": "${HOME}/.xds/server/projects",
- "logsDir": "/tmp/logs",
- "sdkScriptsDir": "${EXEPATH}/scripts/sdks",
- "syncthing": {
- "binDir": "./bin",
- "home": "${HOME}/.xds/server/syncthing-config",
- "gui-address": "http://localhost:8385",
- "gui-apikey": "123456789",
- }
-}
-```
+- `CloudSync` (AKA syncthing) synchronzation type can also be disabled when
+`"syncthing"` key is not defined in JSON configuration file.
+
+<!-- endnote -->
->**Note:** environment variables are supported by using `${MY_VAR}` syntax.
+Please refer to [Configuration chapter of xds-server](../part-2/1_xds-server.html#configuration)
+documentation for more details about JSON configuration file.
### Start/Stop xds-server