diff options
| -rw-r--r-- | docs/part-1/2_install-xds-server.md | 41 | ||||
| -rw-r--r-- | docs/part-2/1_xds-server.md | 29 |
2 files changed, 35 insertions, 35 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 diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md index adc0012..b4022b2 100644 --- a/docs/part-2/1_xds-server.md +++ b/docs/part-2/1_xds-server.md @@ -95,7 +95,7 @@ bash ./xds-docker-create-container.sh --volume /my-workspace:$HOME/my-workspace You can change docker used port with `-id` option ```bash -# Create new XDS worker container with different port +# Create new XDS worker container with a different port number bash ./xds-docker-create-container.sh -id ${ID} # Check that new container is running @@ -529,9 +529,32 @@ All fields are optional and example below corresponds to the default values. } ``` ->**Note:** +>**Notes:** +> +>Environment variables are supported by using `${MY_VAR}` syntax. +> -Environment variables are supported by using `${MY_VAR}` syntax. +#### Disable syncthing + +`CloudSync` synchronization type based on `syncthing` tool can be disabled by +simply removing (or renaming) `"syncthing"` key in configuration file. +Here is a JSON configuration file example where syncthing key as been renamed: + +```json +{ + "httpPort": 8000, + "webAppDir": "webapp/dist", + "shareRootDir": "${HOME}/.xds/server/projects", + "logsDir": "/tmp/logs", + "sdkScriptsDir": "${EXEPATH}/scripts/sdks", + "syncthing_DISABLE": { + "binDir": "./bin", + "home": "${HOME}/.xds/server/syncthing-config", + } +} +``` + +On benefit to do that is to increase XDS-Server startup time. ## Debugging |