Used standard DESTDIR variable for make install

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

diff --git a/README.md b/README.md
index 677ada2..06a076d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,11 +42,17 @@ 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:
+And to install xds-server (by default in `/usr/local/bin`):
 ```bash
 make install
 ```
 
+>**NOTE:** Used `DESTDIR` to specify another install directory
+>```bash
+>make install DESTDIR=$HOME/opt/xds-server
+>```
+
+
 ## How to run
 
 ## Configuration
@@ -65,10 +71,12 @@ Supported fields in configuration file are:
     "webAppDir": "location of client dashboard (default: webapp/dist)",
     "shareRootDir": "root directory where projects will be copied",
     "logsDir": "directory to store logs (eg. syncthing output)",
+    "sdkRootDir": "root directory where cross SDKs are installed",
     "syncthing": {
         "binDir": "syncthing binaries directory (default: executable directory)",
         "home": "syncthing home directory (usually .../syncthing-config)",
-        "gui-address": "syncthing gui url (default http://localhost:8384)"
+        "gui-address": "syncthing gui url (default http://localhost:8384)",
+        "gui-apikey": "syncthing api-key to use (default auto-generated)"
     }
 }
 ```
@@ -77,14 +85,90 @@ Supported fields in configuration file are:
 
 ## Start-up
 
-Use `xds-start-server.sh` script to start all requested tools
+Use `xds-server-start.sh` script to start all requested tools
 ```bash
-/usr/local/bin/xds-start-server.sh
+/usr/local/bin/xds-server-start.sh
 ```
 
 >**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.
+See head section of `xds-server-start.sh` file to see all configurable variables.
+
+## Install XDS-server in AGL SDK docker container
+
+XDS-server has been designed to easily cross compile
+[AGL](https://www.automotivelinux.org/) applications. That's why XDS-server is
+integrated in AGL SDK docker container.
+
+>**NOTE** For more info about AGL SDK docker container, please refer to
+[AGL SDK Quick Setup](http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/setup-sdk-environment.html)
+
+### Create XDS AGL docker worker container
+
+You can either load a pre-build docker image or rebuild this image with latest
+source code.
+
+* load pre-build docker image:
+```bash
+wget http://iot.bzh/download/public/2017/XDS/docker/docker_agl_worker-xds-3.2.tar.xz | docker load
+```
+
+*  OR execute following commands to rebuild docker image:
+```bash
+git clone https://git.automotivelinux.org/AGL/docker-worker-generator
+cd docker-worker-generator
+make build FLAVOUR=xds
+```
+
+You should get `docker.automotivelinux.org/agl/worker-xds:X.Y` image
+
+```bash
+docker images
+REPOSITORY                                      TAG                 IMAGE ID            CREATED             SIZE
+docker.automotivelinux.org/agl/worker-xds       3.2                 786d65b2792c        6 days ago          602MB
+```
+
+### Start XDS AGL docker worker container
+
+Use provided script to create a new docker image and start a new container:
+```bash
+> ./docker-worker-generator/contrib/create_container 0 docker.automotivelinux.org/agl/worker-xds:3.2
+
+> docker ps
+CONTAINER ID        IMAGE                                               COMMAND                  CREATED              STATUS              PORTS                                                                                         NAMES
+b985d81af40c        docker.automotivelinux.org/agl/worker-xds:3.2       "/usr/bin/wait_for..."   6 days ago           Up 4 hours          0.0.0.0:8000->8000/tcp, 0.0.0.0:69->69/udp, 0.0.0.0:10809->10809/tcp, 0.0.0.0:2222->22/tcp    agl-worker-seb-laptop-0-seb
+```
+
+This container exposes following ports:
+  - 8000 : XDS-server to serve XDS Dashboard
+  - 69   : TFTP
+  - 2222 : ssh
+
+Now start xds-server inside this container:
+```bash
+> ssh -p 2222 devel@localhost
+[15:59:58] devel@agl-worker-seb-laptop-0-seb:~$ /usr/local/bin/xds-server-start.sh
+### Configuration in config.json:
+{
+    "webAppDir": "/usr/local/bin/www-xds-server",
+    "shareRootDir": "/home/devel/.xds/share",
+    "logsDir": "/tmp/xds-server/logs",
+    "sdkRootDir": "/xdt/sdk",
+    "syncthing": {
+        "binDir": "/usr/local/bin",
+        "home": "/home/devel/.xds/syncthing-config",
+        "gui-address": "http://localhost:8384",
+        "gui-apikey": "1234abcezam"
+    }
+}
+
+### Start XDS server
+nohup /usr/local/bin/xds-server --config /home/devel/.xds/config.json -log warn > /tmp/xds-server/logs/xds-server.log 2>&1
+pid=22379
+```
+
+You can now connect your browser to XDS-server (running by default on port 8000):
+[http://localhost:8000](http://localhost:8000)
 
 
 ## Debugging
@@ -126,3 +210,5 @@ Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
 - replace makefile by build.go to make Windows build support easier
 - add more tests
 - add more documentation
+- add authentication / login (oauth) + HTTPS
+- enable syncthing user/password + HTTPS