From 5b0e7b915f077ddcda641998a63c67b0183584c7 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Mon, 11 Dec 2017 11:43:34 +0100 Subject: Standardized config file name and location. config file name : xxx-config.json config file directory: $HOME/.xds/xxx or /etc/xds/xxx with xxx equals to "agent" or "server" --- docs/part-1/2_install-xds-server.md | 10 +++++----- docs/part-2/1_xds-server.md | 16 +++++++--------- docs/part-2/2_xds-agent.md | 2 +- 3 files changed, 13 insertions(+), 15 deletions(-) (limited to 'docs') diff --git a/docs/part-1/2_install-xds-server.md b/docs/part-1/2_install-xds-server.md index 143e028..2a47fa8 100644 --- a/docs/part-1/2_install-xds-server.md +++ b/docs/part-1/2_install-xds-server.md @@ -149,12 +149,12 @@ seb@laptop ~$ sudo zypper install agl-xds-server When `xds-server` is started as a systemd service, default environment variables are set into `/etc/default/xds-server` file. -`xds-server` configuration is also driven by a JSON config file (`config.json`), -and default JSON config is `/etc/xds-server/config.json`. +`xds-server` configuration is also driven by a JSON config file (`server-config.json`), +and default JSON config is `/etc/xds/server/server-config.json`. **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/config.json` +`/etc/default/xds-server` file to your file, for example `/home/MYUSER/.xds/server/server-config.json` Supported fields in JSON configuration file are : @@ -175,12 +175,12 @@ All fields are optional and example below corresponds to the default values: { "httpPort": 8000, "webAppDir": "webapp/dist", - "shareRootDir": "${HOME}/.xds-server/projects", + "shareRootDir": "${HOME}/.xds/server/projects", "logsDir": "/tmp/logs", "sdkRootDir": "/xdt/sdk", "syncthing": { "binDir": "./bin", - "home": "${HOME}/.xds-server/syncthing-config", + "home": "${HOME}/.xds/server/syncthing-config", "gui-address": "http://localhost:8385", "gui-apikey": "123456789", } diff --git a/docs/part-2/1_xds-server.md b/docs/part-2/1_xds-server.md index e07d9d3..8303a2c 100644 --- a/docs/part-2/1_xds-server.md +++ b/docs/part-2/1_xds-server.md @@ -305,14 +305,14 @@ make build FLAVOUR=xds ### Configuration -`xds-server` configuration is driven by a JSON config file (`config.json`). +`xds-server` configuration is driven by a JSON config file (`server-config.json`). -Here is the logic to determine which `config.json` file will be used: +Here is the logic to determine which `server-config.json` file will be used: 1. from command line option: `--config myConfig.json` -1. `$HOME/.xds-server/config.json` file -1. `/etc/xds-server/config.json` file -1. `/config.json` file +1. `$HOME/.xds/server/server-config.json` file +1. `/etc/xds/server/server-config.json` file +1. `/server-config.json` file Supported fields in configuration file are (all fields are optional and example below corresponds to the default values): @@ -331,12 +331,12 @@ below corresponds to the default values): { "httpPort": 8000, "webAppDir": "webapp/dist", - "shareRootDir": "${HOME}/.xds-server/projects", + "shareRootDir": "${HOME}/.xds/server/projects", "logsDir": "/tmp/logs", "sdkRootDir": "/xdt/sdk", "syncthing": { "binDir": "./bin", - "home": "${HOME}/.xds-server/syncthing-config", + "home": "${HOME}/.xds/server/syncthing-config", "gui-address": "http://localhost:8385", "gui-apikey": "123456789", } @@ -357,8 +357,6 @@ The server part is written in *Go* and web app (basic HTML) in *Angular4*. | +-- conf.d Linux configuration and startup files (systemd user service) | -+-- config.json.in example of config.json file -| +-- glide.yaml Go package dependency file | +-- lib/ sources of server part (Go) diff --git a/docs/part-2/2_xds-agent.md b/docs/part-2/2_xds-agent.md index 7ff271d..abe3d15 100644 --- a/docs/part-2/2_xds-agent.md +++ b/docs/part-2/2_xds-agent.md @@ -18,7 +18,7 @@ Here is the logic to determine which conf file will be used: 1. from command line option: `--config myConfig.json` 1. `$HOME/.xds/agent/agent-config.json` file -1. `/etc/xds-agent/config.json` file +1. `/etc/xds/agent/agent-config.json` file Supported fields in configuration file are (all fields are optional and example below corresponds to the default values): -- cgit 1.2.3-korg