summaryrefslogtreecommitdiffstats
path: root/docs/part-2
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2017-12-11 11:43:34 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2017-12-11 11:43:34 +0100
commit5b0e7b915f077ddcda641998a63c67b0183584c7 (patch)
tree5a1b561ddd43b7e8f53abb9ee691195c6e632bbb /docs/part-2
parentb59c92c6b565e703de30463dd4b1c007961097cf (diff)
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"
Diffstat (limited to 'docs/part-2')
-rw-r--r--docs/part-2/1_xds-server.md16
-rw-r--r--docs/part-2/2_xds-agent.md2
2 files changed, 8 insertions, 10 deletions
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. `<xds-server executable dir>/config.json` file
+1. `$HOME/.xds/server/server-config.json` file
+1. `/etc/xds/server/server-config.json` file
+1. `<xds-server executable dir>/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):