blob: 2f068cf01a4cdf300e03cc8975879ed4a095fddc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
# XDS - X(cross) Development System
XDS-server is a web server that allows user to remotely cross build applications.
The first goal is to provide a multi-platform cross development tool with
near-zero installation.
The second goals is to keep application sources locally (on user's machine) to
make it compatible with existing IT policies (e.g. corporate backup or SCM).
This powerful webserver (written in [Go](https://golang.org)) exposes a REST
interface over HTTP and also provides a Web dashboard to configure projects and execute only _(for now)_ basics commands.
XDS-server also uses [Syncthing](https://syncthing.net/) tool to synchronize
projects files from user machine to build server machine or container.
> **NOTE**: For now, only Syncthing sharing method is supported to synchronize
projects files.
> **SEE ALSO**: [xds-make](https://github.com/iotbzh/xds-make), a wrapper on `make`
command that allows you to build your application from command-line through
xds-server.
## How to build
### Dependencies
- Install and setup [Go](https://golang.org/doc/install) version 1.7 or
higher to compile this tool.
- Install [npm](https://www.npmjs.com/) : `sudo apt install npm`
- Install [gulp](http://gulpjs.com/) : `sudo npm install -g gulp-cli`
### 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-server.git
cd xds-server
make all
```
And to install xds-server in /usr/local/bin:
```bash
make install
```
## How to run
## Configuration
xds-server configuration is driven by a JSON config file (`config.json`).
Here is the logic to determine which `config.json` file will be used:
1. from command line option: `--config myConfig.json`
2. `$HOME/.xds/config.json` file
3. `<xds-server executable dir>/config.json` file
Supported fields in configuration file are:
```json
{
"webAppDir": "location of client dashboard (default: webapp/dist)",
"shareRootDir": "root directory where projects will be copied",
"syncthing": {
"home": "syncthing home directory (usually .../syncthing-config)",
"gui-address": "syncthing gui url (default http://localhost:8384)"
}
}
```
>**NOTE:** environment variables are supported by using `${MY_VAR}` syntax.
## Start-up
Use `xds-start-server.sh` script to start all requested tools
```bash
/usr/local/bin/xds-start-server.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.
## Debugging
### XDS server architecture
The server part is written in *Go* and web app / dashboard (client part) in
*Angular2*.
```
|
+-- bin/ where xds-server binary file will be built
|
+-- config.json.in example of config.json file
|
+-- glide.yaml Go package dependency file
|
+-- lib/ sources of server part (Go)
|
+-- main.go main entry point of of Web server (Go)
|
+-- Makefile makefile including
|
+-- README.md this readme
|
+-- tools/ temporary directory to hold development tools (like glide)
|
+-- vendor/ temporary directory to hold Go dependencies packages
|
+-- webapp/ source client dashboard (Angular2 app)
```
Visual Studio Code launcher settings can be found into `.vscode/launch.json`.
## TODO:
- replace makefile by build.go to make Windows build support easier
- add more tests
- add more documentation
|
