Auto start Syncthing and Syncthing-inotify.

[src/xds/xds-server.git] / README.md

diff --git a/README.md b/README.md
index 1fb42df..677ada2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# XDS - X(cross) Development System
+# XDS - X(cross) Development System Server
 
 XDS-server is a web server that allows user to remotely cross build applications.
 
@@ -11,7 +11,7 @@ This powerful webserver (written in [Go](https://golang.org)) exposes a REST
 interface over HTTP and also provides a Web dashboard to configure projects and execute only _(for now)_ basics commands.
 
 XDS-server also uses [Syncthing](https://syncthing.net/) tool to synchronize
-projects files from user machine to build server machine.
+projects files from user machine to build server machine or container.
 
 > **NOTE**: For now, only Syncthing sharing method is supported to synchronize
 projects files.
@@ -28,7 +28,7 @@ xds-server.
 - Install and setup [Go](https://golang.org/doc/install) version 1.7 or
 higher to compile this tool.
 - Install [npm](https://www.npmjs.com/) : `sudo apt install npm`
-- Install [gulp](http://gulpjs.com/) : `sudo npm install -g gulp`
+- Install [gulp](http://gulpjs.com/) : `sudo npm install -g gulp-cli`
 
 
 ### Building
@@ -42,6 +42,11 @@ Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Make
  make all
 ```
 
+And to install xds-server in /usr/local/bin:
+```bash
+make install
+```
+
 ## How to run
 
 ## Configuration
@@ -51,14 +56,17 @@ xds-server configuration is driven by a JSON config file (`config.json`).
 Here is the logic to determine which `config.json` file will be used:
 1. from command line option: `--config myConfig.json`
 2. `$HOME/.xds/config.json` file
-3. `<xds-server executable dir>/config.json` file
+3. `<current dir>/config.json` file
+4. `<xds-server executable dir>/config.json` file
 
 Supported fields in configuration file are:
 ```json
 {
     "webAppDir": "location of client dashboard (default: webapp/dist)",
     "shareRootDir": "root directory where projects will be copied",
+    "logsDir": "directory to store logs (eg. syncthing output)",
     "syncthing": {
+        "binDir": "syncthing binaries directory (default: executable directory)",
         "home": "syncthing home directory (usually .../syncthing-config)",
         "gui-address": "syncthing gui url (default http://localhost:8384)"
     }
@@ -69,11 +77,14 @@ Supported fields in configuration file are:
 
 ## Start-up
 
+Use `xds-start-server.sh` script to start all requested tools
 ```bash
-./bin/xds-server -c config.json
+/usr/local/bin/xds-start-server.sh
 ```
 
-**TODO**: add notes about Syncthing setup and startup
+>**NOTE** you can define some environment variables to setup for example
+config file `XDS_CONFFILE` or change logs directory `LOGDIR`.
+See head section of `xds-start-server.sh` file to see all configurable variables.
 
 
 ## Debugging
@@ -99,6 +110,8 @@ The server part is written in *Go* and web app / dashboard (client part) in
 |
 +-- README.md           this readme
 |
++-- scripts/            hold various scripts used for installation or startup
+|
 +-- tools/              temporary directory to hold development tools (like glide)
 |
 +-- vendor/             temporary directory to hold Go dependencies packages
@@ -106,7 +119,7 @@ The server part is written in *Go* and web app / dashboard (client part) in
 +-- webapp/             source client dashboard (Angular2 app)
 ```
 
-VSCode launcher settings can be found into `.vscode/launch.json`.
+Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
 
 
 ## TODO: