X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=ad8e6bb75fc9cfde88603c642950debaef664f8d;hb=a50baa7c309f7eb55fe87c71f4c688ace325b6ac;hp=d72ed9575cf7385724fbc00831f72712ccb511f7;hpb=bfeab33538d50ee52750de4dd4c0e72b64f674f6;p=src%2Fxds%2Fxds-agent.git diff --git a/README.md b/README.md index d72ed95..ad8e6bb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # XDS - X(cross) Development System Agent -XDS-agent is a agent that should be run on your local machine when you use XDS. +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 +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. @@ -50,10 +51,12 @@ Supported fields in configuration file are: ```json { "httpPort": "http port of agent REST interface", + "logsDir": "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-address": "syncthing gui url (default http://localhost:8384)", + "gui-apikey": "syncthing api-key to use (default auto-generated)" } } ```