README.md

   1 # XDS - X(cross) Development System Agent
   2
   3 XDS-agent is an agent that should run on your local machine when you use XDS.
   4
   5 This agent takes care of starting [Syncthing](https://syncthing.net/) tool to
   6 synchronize your projects files from your local machine to build server machine
   7 or container.
   8
   9
  10 > **SEE ALSO**: [xds-server](https://github.com/iotbzh/xds-server), a web server
  11 used to remotely cross build applications.
  12
  13
  14 ## How to build
  15
  16 ### Dependencies
  17
  18 - Install and setup [Go](https://golang.org/doc/install) version 1.8 or
  19 higher to compile this tool.
  20
  21
  22 ### Building
  23
  24 Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile:
  25 ```bash
  26  mkdir -p $GOPATH/src/github.com/iotbzh
  27  cd $GOPATH/src/github.com/iotbzh
  28  git clone https://github.com/iotbzh/xds-agent.git
  29  cd xds-agent
  30  make all
  31 ```
  32
  33 And to install xds-agent in /usr/local/bin:
  34 ```bash
  35 make install
  36 ```
  37
  38 > **NOTE**: To cross build for example for Windows, just execute:
  39 ```bash
  40 export GOOS=windows
  41 export GOARCH=amd64
  42 make all
  43 make package
  44 ```
  45
  46 ## How to run
  47
  48 ## Configuration
  49
  50 xds-agent configuration is driven by a JSON config file (`agent-config.json`).
  51
  52 Here is the logic to determine which `agent-config.json` file will be used:
  53 1. from command line option: `--config myConfig.json`
  54 2. `$HOME/.xds/agent-config.json` file
  55 3. `<current dir>/agent-config.json` file
  56 4. `<xds-agent executable dir>/agent-config.json` file
  57
  58 Supported fields in configuration file are:
  59 ```json
  60 {
  61     "httpPort": "http port of agent REST interface",
  62     "logsDir": "directory to store logs (eg. syncthing output)",
  63     "syncthing": {
  64         "binDir": "syncthing binaries directory (use xds-agent executable dir when not set)",
  65         "home": "syncthing home directory (usually .../syncthing-config)",
  66         "gui-address": "syncthing gui url (default http://localhost:8384)",
  67         "gui-apikey": "syncthing api-key to use (default auto-generated)"
  68     }
  69 }
  70 ```
  71
  72 >**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
  73
  74 ## Start-up
  75
  76 ```bash
  77 ./bin/xds-agent.sh
  78
  79 # OR if you have install agent
  80
  81 /usr/local/bin/xds-agent.sh
  82 ```
  83
  84 >**NOTE** you can define some environment variables to setup for example
  85 config file `XDS_CONFIGFILE` or change logs level `LOG_LEVEL`.