| Filip Krzywka | 4bb79b7 | 2018-09-25 10:57:17 +0200 | [diff] [blame] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| 3 | |
| 4 | Installation |
| 5 | ============ |
| 6 | |
| 7 | To run HV-VES Collector container you need to specify required parameters: |
| 8 | |
| 9 | - listen-port - the port on which HV-VES will listen internally |
| 10 | - config-url - URL of HV-VES configuration on consul |
| 11 | |
| 12 | There are also optional configuration parameters: |
| 13 | |
| 14 | - health-check-api-port - Health check rest api listen port |
| 15 | - first-request-delay - Delay of first request to consul in seconds |
| 16 | - request-interval - Interval of consul configuration requests in seconds |
| 17 | - ssl-disable - Disable SSL encryption |
| 18 | - key-store - Key store in PKCS12 format path |
| 19 | - key-store-password - Key store password |
| 20 | - trust-store - File with trusted certificate bundle in PKCS12 format path |
| 21 | - trust-store-password - Trust store password |
| 22 | - idle-timeout-sec - Idle timeout for remote hosts. After given time without any data exchange the connection might be closed |
| 23 | |
| 24 | |
| 25 | These parameters can be configured either by passing command line option during `docker run` call or |
| 26 | by specifying environment variables named after command line option name |
| 27 | rewritten using `UPPER_SNAKE_CASE` and prepended with `VESHV_` prefix e.g. `VESHV_LISTEN_PORT`. |