Code Review
/
src
/
xds
/
xds-server.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Document script directory
[src/xds/xds-server.git]
/
README.md
diff --git
a/README.md
b/README.md
index
16d0946
..
92be1c8
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-42,6
+42,11
@@
Clone this repo into your `$GOPATH/src/github.com/iotbzh` and use delivered Make
make all
```
make all
```
+And to install xds-server in /usr/local/bin:
+```bash
+make install
+```
+
## How to run
## Configuration
## How to run
## Configuration
@@
-69,11
+74,14
@@
Supported fields in configuration file are:
## Start-up
## Start-up
+Use `xds-start-server.sh` script to start all requested tools
```bash
```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
## Debugging
@@
-99,6
+107,8
@@
The server part is written in *Go* and web app / dashboard (client part) in
|
+-- README.md this readme
|
|
+-- 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
+-- tools/ temporary directory to hold development tools (like glide)
|
+-- vendor/ temporary directory to hold Go dependencies packages