X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=3d48ad6f373475d94d3398cb3fd454aeb62cf355;hb=c4759d17cafda0d6b870fa5e8d71103a9f768220;hp=06d0725f1d27d216e88a47cf5838ab245a546ed1;hpb=03ea9e0e7107d59f207b3842f9fc3f74d036ac91;p=src%2Fxds%2Fxds-agent.git diff --git a/README.md b/README.md index 06d0725..3d48ad6 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,80 @@ # XDS - X(cross) Development System Agent -XDS-agent is an agent that should run on your local machine when you use XDS. - -This agent takes care of starting [Syncthing](https://syncthing.net/) tool to -synchronize your projects files from your local machine to build server machine -or container. +XDS-agent is an agent that should run on your local host when you use XDS. +This agent takes care, among others, of starting [Syncthing](https://syncthing.net/) +tool to synchronize your project files from your local host to XDS build server +machine or container (where `xds-server` is running). > **SEE ALSO**: [xds-server](https://github.com/iotbzh/xds-server), a web server used to remotely cross build applications. +## How to install xds-agent -## How to build - -### Dependencies +### Install package for debian distro type -- Install and setup [Go](https://golang.org/doc/install) version 1.8 or -higher to compile this tool. +```bash +export DISTRO="Debian_8.0" +wget -O - http://download.opensuse.org/repositories/isv:/LinuxAutomotive:/app-Development/${DISTRO}/Release.key | sudo apt-key add - +sudo bash -c "cat >/etc/apt/sources.list.d/AGL.list<**NOTE:** Used `DESTDIR` to specify another install directory ->```bash ->make install DESTDIR=$HOME/opt/xds-agent ->``` +The value 'DISTRO' can be set to {openSUSE_Leap_42.2, openSUSE_Leap_42.3, openSUSE_Tumbleweed} +Update the package +```bash +sudo zypper ref +sudo zypper install --force agl-xds-agent +``` -#### Cross build -For example on a Linux machine to cross-build for Windows, just execute: +The files are install here: ```bash -export GOOS=windows -export GOARCH=amd64 -make all -make package +/opt/AGL/agl-xds-agent ``` -## How to run +## How to install on other platform + +You need to download `xds-agent` tarballs from xds dashboard by clicking +on download icon ![download icon](./resources/images/download_icon.jpg) of +configuration page. + +> **NOTE** : you can also download released tarballs from github [releases page](https://github.com/iotbzh/xds-agent/releases). + +Then unzip this tarball any where into your local disk. ## Configuration -xds-agent configuration is driven by a JSON config file (`agent-config.json`). +xds-agent configuration is driven by a JSON config file (named `agent-config.json`). +The tarball mentioned in previous section includes this file with default settings. Here is the logic to determine which `agent-config.json` file will be used: 1. from command line option: `--config myConfig.json` @@ -62,16 +82,17 @@ Here is the logic to determine which `agent-config.json` file will be used: 3. `/agent-config.json` file 4. `/agent-config.json` file -Supported fields in configuration file are: -```json +Supported fields in configuration file are (all fields are optional and listed +values are the default values): +``` { - "httpPort": "http port of agent REST interface", - "logsDir": "directory to store logs (eg. syncthing output)", + "httpPort": "8010", # http port of agent REST interface + "logsDir": "/tmp/logs", # directory to store logs (eg. syncthing output) "syncthing": { - "binDir": "syncthing binaries directory (use xds-agent executable dir when not set)", - "home": "syncthing home directory (usually .../syncthing-config)", - "gui-address": "syncthing gui url (default http://localhost:8384)", - "gui-apikey": "syncthing api-key to use (default auto-generated)" + "binDir": ".", # syncthing binaries directory (default: executable directory) + "home": "${HOME}/.xds/syncthing-config", # syncthing home directory (usually .../syncthing-config) + "gui-address": "http://localhost:8384", # syncthing gui url (default http://localhost:8384) + "gui-apikey": "123456789", # syncthing api-key to use (default auto-generated) } } ``` @@ -80,13 +101,51 @@ Supported fields in configuration file are: ## Start-up +Simply to start `xds-agent` executable ```bash -./bin/xds-agent.sh +./xds-agent & +``` -# OR if you have install agent +>**NOTE** if need be, you can increase log level by setting option +`--log `, supported *level* are: panic, fatal, error, warn, info, debug. -/usr/local/bin/xds-agent.sh +You can now use XDS dashboard and check that connection with `xds-agent` is up. +(see also [xds-server README](https://github.com/iotbzh/xds-server/blob/master/README.md#xds-dashboard)) + + +## Build xds-agent from scratch + +### Dependencies + +- Install and setup [Go](https://golang.org/doc/install) version 1.8 or +higher to compile this tool. + +### Building + +Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Makefile: +```bash + mkdir -p $GOPATH/src/github.com/iotbzh + cd $GOPATH/src/github.com/iotbzh + git clone https://github.com/iotbzh/xds-agent.git + cd xds-agent + make all ``` ->**NOTE** you can define some environment variables to setup for example -config file `XDS_CONFIGFILE` or change logs level `LOG_LEVEL`. +And to install xds-agent (by default in `/usr/local/bin`): +```bash +make install +``` + +>**NOTE:** Used `DESTDIR` to specify another install directory +>```bash +>make install DESTDIR=$HOME/opt/xds-agent +>``` + +#### Cross build +For example on a Linux machine to cross-build for Windows, just execute: +```bash +export GOOS=windows +export GOARCH=amd64 +make all +make package +```