The whole Suite consists of three parts that are installed seperately. This README provides Installation instructions for a debian-based linux distribution. Deployment on other UNIX Systems may differ.
1. skylax infrastructure
2. skylax-client
3. skylax-api
The skylax infrastructure consists of several different external programs and libraries
nodeJS + pm2:
1. https://nodejs.org/en/download/package-manager/
2. sudo apt-get install npm
3. npm install pm2 -g // cluster management
nginx proxy:
1. sudo apt-get install nginx
2. sudo nano /etc/nginx/sites-enabled
3. TODO(specki): add config
Run the following commands in the desired location.
1. git clone https://github.com/ling-js/skylax.git
2. cd skylax
3. npm install
If Process Manager 2 is used the Cluster is started with:
1. pm2 start app.js -i 4
If only a single Instance is used the Server is started with:
1. npm start
The Client is then reachable under Port 3000.
The skylax-client uses following external libraries:
| used packages | License |
|---|---|
| spin.js | MIT |
| bootpag | MIT - see file jquery.bootpag.min.js |
| jquery | MIT |
| leaflet | BSD-2Clause |
| leaflet-sidebar-v2 | MIT |
| fontawesome | multiple licenses |
| leaflet-draw | MIT |
| bootstrap | MIT |
| moment.js | MIT |
| bootstrap-datepicker | MIT |
The skylax-api depends on the following libraries to be installed in the host operating system. Please refer to the their Websites for installation instructions:
- GEOS released under LGPL
- proj.4 released under MIT License
- GDAL with python and OpenJPEG bindings released under X11/MIT
- OpenJPEG released under 2-Clause BSD
1. Download the latest binary from the [Github Releases Page](https://github.com/ling-js/skylax-api/releases)
2. Extract the archive to the desired location
3. Run skylax-api
Installing from source depends on a valid go install. Refer to the official site for documentation:
Run following commands in the desired install directory
1. git clone https://github.com/ling-js/skylax-api
2. cd skylax-api
3. go build
Run following commands in the install directory
./skylax-api
The following command line parameters are available. If they are not explicitly specified the default is used.
| flag | default | description |
|---|---|---|
-v |
false | toggle verbose output |
-src= |
'/opt/sentinel2/' | specify data directory |
The source directory may only contain valid datasets in SAFE Format (denoted by .SAFE file extension)
The skylax-api has the following external dependencies:
| Dependency | License |
|---|---|
| go-gdal | License |
| geos | MIT License |
| gorilla | BSD-3-Clause |
| ksuid | MIT License |
| httprouter | License |
| cors | MIT License |
| gdal2tiles.py | (see file) |
The skylax-api is released under the MIT License
The skylax client (referred to as skylax) is released under the MIT License
The go-gdal library is released under a custom License