| 19 | |
| 20 | == Download == #download |
| 21 | |
| 22 | The latest version of the cloud native Renew plugin (shown in bold font in the figure) can be downloaded here. |
| 23 | |
| 24 | == Startup instructions == #start |
| 25 | This section describes the usage in an isolated context, meaning a simple start of a Renew instance along with the cloud native plugin, but not the entire deployment outlined in the figure above. |
| 26 | |
| 27 | * Make sure to you have Java 11+ and any HTTP enabled tool, such as `curl` installed on the machine, you want to run Renew on. The feature usages described later use curl for the example command line statements. |
| 28 | * Download the package [#download above] and unzip it. |
| 29 | * (optional) ''If port 8085 is in use'' on your machine, open the file `application.properties` and change the entry `server.port` to an unused port. For the remainder of this guide, it is assumed, that port 8085 is used. If it was changed in the application.properties, it also needs to be changed in the following command line invocations. |
| 30 | * To start use the following command: |
| 31 | * !Linux/Unix: `java -p .:libs -m de.renew.loader gui` (depending on your shell you might need to escape the colon character: `java -p .\:libs -m de.renew.loader gui`) |
| 32 | * Windows: `java -p .;libs -m de.renew.loader gui` (depending on your shell you might need to escape the semicolon character: `java -p .\;libs -m de.renew.loader gui`) |
| 33 | |
| 34 | * Open a command shell and execute `curl localhost:8085/log` (or use the port you specified earlier in the `application.properties` file). The log files of the simulator will be returned from the moment onward the cloud native plugin was initialized. |
| 35 | * Open a web browser and navigate to `http://localhost:8085/swagger-ui.html` to see an API documentation of the service endpoints with their required parameters. Note, that this overview does not cover the /health endpoints, that indicate state of the application and its parts. |
| 36 | |
| 37 | |
105 | | == Download == #download |
106 | | |
107 | | The latest version of the cloud native Renew plugin (shown in bold font in the figure) can be downloaded here. |
108 | | |
109 | | == Installation instructions == #install |
110 | | This section describes the usage in an isolated context, meaning a simple start of a Renew instance along with the cloud native plugin, but not the entire deployment outlined in the figure above. |
111 | | Information on the full deployment will be shown later. |
112 | | |
113 | | * Make sure to you have Java 11+ and any HTTP enabled tool, such as `curl` installed on the machine, you want to run Renew on. |
114 | | * Download the package above and unzip it. |
115 | | * (optional) ''If port 8085 is in use'' on your machine, open the file `application.properties` and change the entry `server.port` to an unused port. For the remainder of this guide, it is assumed, that port 8085 is used. If it was changed in the application.properties, it also needs to be changed in the following command line invocations. |
116 | | * Navigate to the main directory and run `./gradlew build` (or `.\gradlew build` on Windows CMD) |
117 | | * To start use the following command: |
118 | | * !Linux/Unix: `java -p .:libs -m de.renew.loader gui` (depending on your shell you might need to escape the colon character: `java -p .\:libs -m de.renew.loader gui` |
119 | | * Windows: `java -p .;libs -m de.renew.loader gui` |
120 | | |
121 | | * Open a command shell and execute `curl localhost:8085/log` (or use the port you specified earlier in the `application.properties` file). The log files of the simulator will be returned from the moment onward the cloud native plugin was initialized. |
122 | | * Open a web browser and navigate to `http://localhost:8085/swagger-ui.html` to see an API documentation of the service endpoints with their required parameters. Note, that this overview does not cover the /health endpoints, that indicate state of the application and its parts. |