Mercurial > hg > thermostat-ng > web-gateway
view README.md @ 303:ec8316f2d020 default tip master
Fail build on YAML lint error
Fail the build on bad swagger files, but "-Dmaven.test.skip=true" will
skip the YAML check.
Reviewed-by: neugens
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-October/025574.html
author | Simon Tooke <stooke@redhat.com> |
---|---|
date | Tue, 31 Oct 2017 09:53:02 -0400 |
parents | 36a5f2fed6d3 |
children |
line wrap: on
line source
# Thermostat Web Gateway This is a HTTP API server for [Thermostat](http://icedtea.classpath.org/thermostat). # Build Dependencies * JDK 7+ * Maven # Runtime Dependencies * JRE 7+ * Mongodb 3.x+ # How to Build ``` $ mvn clean verify ``` # How to Run ## How to Start ``` $ ./distribution/target/image/bin/thermostat-mongodb.sh start $ ./distribution/target/image/bin/thermostat-web-gateway.sh ``` This will run the Web Gateway with default configuration, listening on http://127.0.0.1:30000 Additional Java options can be passed to the Java command that launches the Web Gateway using the `THERMOSTAT_GATEWAY_EXT_JAVA_OPTS` environment variable. ## How to Stop `Ctrl-C` to stop `thermostat-web-gateway.sh` ``` $ ./distribution/target/image/bin/thermostat-mongodb.sh stop ``` # API: For API see the Swagger YAML specifications in `./services/*/src/main/resources` Alternatively, visit the Swagger UI hosted by the Web Gateway at `https://127.0.0.1:30000/doc/index.html` and load specifications provided by the services. For example: `https://127.0.0.1:30000/doc/index.html?url=https://127.0.0.1:30000/jvm-gc/0.0.2/doc/jvm-gc-swagger.yaml` # How to debug after building ## Run debug script This runs Thermostat Web Gateway listening on socket 5005 for a debugger to connect. ``` $ ./distribution/target/image/bin/thermostat-web-gateway-debug.sh ``` ## Run IdeLauncher class This class is meant to run from IDE (Eclipse, Intellij, etc.) with configuration setting the environment variable `THERMOSTAT_GATEWAY_HOME` to `distribution/target/image` ```