Skip to content

Commit d3d40cf

Browse files
rwaffenrwaffen
committed
docs: update environment variables section in README.md for clarity and completeness
1 parent 6703d4c commit d3d40cf

File tree

1 file changed

+29
-30
lines changed

1 file changed

+29
-30
lines changed

‎README.md

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -81,39 +81,38 @@ podman run --name openvox --hostname openvox -v ./code:/etc/puppetlabs/code/ ghc
8181

8282
The following environment variables are supported:
8383

84-
| Name | Usage / Default |
85-
|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
86-
| __OPENVOXSERVER_HOSTNAME__ | The DNS name used on the servers SSL certificate - sets the `server` in puppet.conf<br><br>Defaults to unset. |
87-
| __CERTNAME__ | The DNS name used on the servers SSL certificate - sets the `certname` in puppet.conf<br><br>Defaults to unset. |
88-
| __DNS_ALT_NAMES__ | Additional DNS names to add to the servers SSL certificate<br>__Note__ only effective on initial run when certificates are generated |
89-
| __OPENVOXSERVER_PORT__ | The port of the openvoxserver<br><br>Defaults to `8140` |
90-
| __AUTOSIGN__ | Whether or not to enable autosigning on the openvoxserver instance. Valid values are `true`, `false`, and `/path/to/autosign.conf`.<br><br>Defaults to `true`. |
91-
| __CA_ENABLED__ | Whether or not this openvoxserver instance has a running CA (Certificate Authority)<br><br>Defaults to `true` |
92-
| __CA_TTL__ | CA expire date (in seconds or with suffix `s`, `m`, `h`, `d`, `y`)<br><br>Defaults to `157680000` |
93-
| __CA_HOSTNAME__ | The DNS hostname for the openvoxserver running the CA. Does nothing unless `CA_ENABLED=false`<br><br>Defaults to `puppet` |
94-
| __CA_PORT__ | The listening port of the CA. Does nothing unless `CA_ENABLED=false`<br><br>Defaults to `8140` |
95-
| __CA_ALLOW_SUBJECT_ALT_NAMES__ | Whether or not SSL certificates containing Subject Alternative Names should be signed by the CA. Does nothing unless `CA_ENABLED=true`.<br><br>Defaults to `false` |
96-
| __INTERMEDIATE_CA__ | Allows to import an existing intermediate CA. Needs `INTERMEDIATE_CA_BUNDLE`, `INTERMEDIATE_CA_CHAIN` and `INTERMEDIATE_CA_KEY`. See [Puppet Intermediat CA](https://www.puppet.com/docs/puppet/latest/server/intermediate_ca.html) |
97-
| __INTERMEDIATE_CA_BUNDLE__ | File path and name to the complete CA bundle (signing CA + Intermediate CA) |
98-
| __INTERMEDIATE_CRL_CHAIN__ | File path and name to the complete CA CRL chain |
99-
| __INTERMEDIATE_CA_KEY__ | File path and name to the private CA key |
100-
| __OPENVOX_REPORTS__ | Sets `reports` in puppet.conf<br><br>Defaults to `puppetdb` |
101-
| __OPENVOX_STORECONFIGS__ | Sets `storeconfigs` in puppet.conf<br><br>Defaults to `true` |
102-
| __OPENVOX_STORECONFIGS_BACKEND__ | Sets `storeconfigs_backend` in puppet.conf<br><br>Defaults to `puppetdb` |
103-
| __OPENVOXSERVER_MAX_ACTIVE_INSTANCES__ | The maximum number of JRuby instances allowed<br><br>Defaults to `1` |
104-
| __OPENVOXSERVER_MAX_REQUESTS_PER_INSTANCE__ | The maximum HTTP requests a JRuby instance will handle in its lifetime (disable instance flushing)<br><br>Defaults to `0` |
105-
| __OPENVOXSERVER_JAVA_ARGS__ | Arguments passed directly to the JVM when starting the service<br><br>Defaults to `-Xms1024m -Xmx1024m` |
106-
| __PUPPETDB_HOSTNAME__ | The DNS name of the puppetdb <br><br> Defaults to `puppetdb` |
107-
| __PUPPETDB_SSL_PORT__ | The TLS port of the puppetdb <br><br> Defaults to `8081` |
108-
| __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ | Activate the graphite exporter. Also needs __OPENVOXSERVER_GRAPHITE_HOST__ and __OPENVOXSERVER_GRAPHITE_PORT__<br><br> Defaults to `false` |
84+
| Name | Usage / Default |
85+
|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
86+
| __AUTOSIGN__ | Whether or not to enable autosigning on the openvoxserver instance. Valid values are `true`, `false`, and `/path/to/autosign.conf`.<br><br>Defaults to `true`. |
87+
| __CA_ALLOW_SUBJECT_ALT_NAMES__ | Whether or not SSL certificates containing Subject Alternative Names should be signed by the CA. Does nothing unless `CA_ENABLED=true`.<br><br>Defaults to `false` |
88+
| __CA_ENABLED__ | Whether or not this openvoxserver instance has a running CA (Certificate Authority)<br><br>Defaults to `true` |
89+
| __CA_HOSTNAME__ | The DNS hostname for the openvoxserver running the CA. Does nothing unless `CA_ENABLED=false`<br><br>Defaults to `puppet` |
90+
| __CA_PORT__ | The listening port of the CA. Does nothing unless `CA_ENABLED=false`<br><br>Defaults to `8140` |
91+
| __CA_TTL__ | CA expire date (in seconds or with suffix `s`, `m`, `h`, `d`, `y`)<br><br>Defaults to `157680000` |
92+
| __CERTNAME__ | The DNS name used on the servers SSL certificate - sets the `certname` in puppet.conf<br><br>Defaults to unset. |
93+
| __CSR_ATTRIBUTES__ | Provide a JSON string of the csr_attributes.yaml content. e.g. `CSR_ATTRIBUTES='{"custom_attributes": { "challengePassword": "foobar" }, "extension_requests": { "pp_project": "foo" } }'`<br><br> Defaults to empty JSON object `{}`<br> Please note that within a compose file, you must provide all environment variables as Hash and not as Array!<br> environment:<br> `CSR_ATTRIBUTES: '{"extension_request": {...}}'` |
94+
| __DNS_ALT_NAMES__ | Additional DNS names to add to the servers SSL certificate<br>__Note__ only effective on initial run when certificates are generated |
95+
| __ENVIRONMENTPATH__ | Set an environmentpath<br><br> Defaults to `/etc/puppetlabs/code/environments` |
96+
| __HIERACONFIG__ | Set a hiera_config entry in puppet.conf file<br><br> Defaults to `$confdir/hiera.yaml` |
97+
| __INTERMEDIATE_CA__ | Allows to import an existing intermediate CA. Needs `INTERMEDIATE_CA_BUNDLE`, `INTERMEDIATE_CA_CHAIN` and `INTERMEDIATE_CA_KEY`. See [Puppet Intermediat CA](https://www.puppet.com/docs/puppet/latest/server/intermediate_ca.html) |
98+
| __INTERMEDIATE_CA_BUNDLE__ | File path and name to the complete CA bundle (signing CA + Intermediate CA) |
99+
| __INTERMEDIATE_CA_KEY__ | File path and name to the private CA key |
100+
| __INTERMEDIATE_CRL_CHAIN__ | File path and name to the complete CA CRL chain |
101+
| __OPENVOX_REPORTS__ | Sets `reports` in puppet.conf<br><br>Defaults to `puppetdb` |
102+
| __OPENVOX_STORECONFIGS__ | Sets `storeconfigs` in puppet.conf<br><br>Defaults to `true` |
103+
| __OPENVOX_STORECONFIGS_BACKEND__ | Sets `storeconfigs_backend` in puppet.conf<br><br>Defaults to `puppetdb` |
104+
| __OPENVOXDB_SERVER_URLS__ | The URL of the OpenVoxDB servers. This is used to connect to the OpenVoxDB server. <br><br> Defaults to `https://openvoxdb:8081`<br> Please note that within a compose file, you must provide all environment variables as Hash and not as Array!<br> environment:<br> `OPENVOXDB_SERVER_URLS: 'https://openvoxdb:8081'` |
105+
| __OPENVOXSERVER_ENABLE_ENV_CACHE_DEL_API__ | Enable the puppet admin api endpoint via certificates to allow clearing environment caches<br><br> Defaults to `true` |
106+
| __OPENVOXSERVER_ENVIRONMENT_TIMEOUT__ | Configure the environment timeout<br><br> Defaults to `unlimited` |
107+
| __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ | Activate the graphite exporter. Also needs __OPENVOXSERVER_GRAPHITE_HOST__ and __OPENVOXSERVER_GRAPHITE_PORT__<br><br> Defaults to `false` |
109108
| __OPENVOXSERVER_GRAPHITE_HOST__ | Only used if __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ is set to `true`. FQDN or Hostname of the graphite server where puppet should push metrics to. <br><br> Defaults to `exporter` |
110109
| __OPENVOXSERVER_GRAPHITE_PORT__ | Only used if __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ is set to `true`. Port of the graphite server where puppet should push metrics to. <br><br> Default to `9109` |
111-
| __OPENVOXSERVER_ENVIRONMENT_TIMEOUT__ | Configure the environment timeout<br><br> Defaults to `unlimited` |
112-
| __OPENVOXSERVER_ENABLE_ENV_CACHE_DEL_API__ | Enable the puppet admin api endpoint via certificates to allow clearing environment caches<br><br> Defaults to `true` |
110+
| __OPENVOXSERVER_HOSTNAME__ | The DNS name used on the servers SSL certificate - sets the `server` in puppet.conf<br><br>Defaults to unset. |
111+
| __OPENVOXSERVER_JAVA_ARGS__ | Arguments passed directly to the JVM when starting the service<br><br>Defaults to `-Xms1024m -Xmx1024m` |
112+
| __OPENVOXSERVER_MAX_ACTIVE_INSTANCES__ | The maximum number of JRuby instances allowed<br><br>Defaults to `1` |
113+
| __OPENVOXSERVER_MAX_REQUESTS_PER_INSTANCE__ | The maximum HTTP requests a JRuby instance will handle in its lifetime (disable instance flushing)<br><br>Defaults to `0` |
114+
| __OPENVOXSERVER_PORT__ | The port of the openvoxserver<br><br>Defaults to `8140` |
113115
| __USE_OPENVOXDB__ | Whether to connect to puppetdb <br>Sets `OPENVOX_REPORTS` to `log` and `OPENVOX_STORECONFIGS` to `false` if `OPENVOX_STORECONFIGS_BACKEND` is `puppetdb`. <br><br>Defaults to `true`|
114-
| __ENVIRONMENTPATH__ | Set an environmentpath<br><br> Defaults to `/etc/puppetlabs/code/environments` |
115-
| __HIERACONFIG__ | Set a hiera_config entry in puppet.conf file<br><br> Defaults to `$confdir/hiera.yaml` |
116-
| __CSR_ATTRIBUTES__ | Provide a JSON string of the csr_attributes.yaml content. e.g. `CSR_ATTRIBUTES='{"custom_attributes": { "challengePassword": "foobar" }, "extension_requests": { "pp_project": "foo" } }'`<br><br> Defaults to empty JSON object `{}`<br> Please note that within a compose file, you must provide all environment variables as Hash and not as Array!<br> environment:<br> `CSR_ATTRIBUTES: '{"extension_request": {...}}'` |
117116

118117
## Initialization Scripts
119118

0 commit comments

Comments
 (0)