Skip to content

Commit fd28a30

Browse files
authored
Merge pull request #39 from btschwertfeger/main
Resolve "Missing documentation of `USE_OPENVOXDB`"
2 parents 779ad99 + aa693d8 commit fd28a30

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -86,30 +86,31 @@ The following environment variables are supported:
8686
| __OPENVOXSERVER_HOSTNAME__ | The DNS name used on the servers SSL certificate - sets the `server` in puppet.conf<br><br>Defaults to unset. |
8787
| __CERTNAME__ | The DNS name used on the servers SSL certificate - sets the `certname` in puppet.conf<br><br>Defaults to unset. |
8888
| __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>`8140` |
89+
| __OPENVOXSERVER_PORT__ | The port of the openvoxserver<br><br>Defaults to `8140` |
9090
| __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>`true` |
92-
| __CA_TTL__ | CA expire date (in seconds or with suffix `s`, `m`, `h`, `d`, `y`)<br><br>`157680000` |
93-
| __CA_HOSTNAME__ | The DNS hostname for the openvoxserver running the CA. Does nothing unless `CA_ENABLED=false`<br><br>`puppet` |
94-
| __CA_PORT__ | The listening port of the CA. Does nothing unless `CA_ENABLED=false`<br><br>`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>`false` |
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` |
9696
| __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) |
9797
| __INTERMEDIATE_CA_BUNDLE__ | File path and name to the complete CA bundle (signing CA + Intermediate CA) |
9898
| __INTERMEDIATE_CRL_CHAIN__ | File path and name to the complete CA CRL chain |
9999
| __INTERMEDIATE_CA_KEY__ | File path and name to the private CA key |
100-
| __OPENVOX_REPORTS__ | Sets `reports` in puppet.conf<br><br>`puppetdb` |
101-
| __OPENVOX_STORECONFIGS__ | Sets `storeconfigs` in puppet.conf<br><br>`true` |
102-
| __OPENVOX_STORECONFIGS_BACKEND__ | Sets `storeconfigs_backend` in puppet.conf<br><br>`puppetdb` |
103-
| __OPENVOXSERVER_MAX_ACTIVE_INSTANCES__ | The maximum number of JRuby instances allowed<br><br>`1` |
104-
| __OPENVOXSERVER_MAX_REQUESTS_PER_INSTANCE__ | The maximum HTTP requests a JRuby instance will handle in its lifetime (disable instance flushing)<br><br>`0` |
105-
| __OPENVOXSERVER_JAVA_ARGS__ | Arguments passed directly to the JVM when starting the service<br><br>`-Xms1024m -Xmx1024m` |
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` |
106106
| __PUPPETDB_HOSTNAME__ | The DNS name of the puppetdb <br><br> Defaults to `puppetdb` |
107107
| __PUPPETDB_SSL_PORT__ | The TLS port of the puppetdb <br><br> Defaults to `8081` |
108108
| __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ | Activate the graphite exporter. Also needs __OPENVOXSERVER_GRAPHITE_HOST__ and __OPENVOXSERVER_GRAPHITE_PORT__<br><br> Defaults to `false` |
109109
| __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` |
110110
| __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` |
111111
| __OPENVOXSERVER_ENVIRONMENT_TIMEOUT__ | Configure the environment timeout<br><br> Defaults to `unlimited` |
112112
| __OPENVOXSERVER_ENABLE_ENV_CACHE_DEL_API__ | Enable the puppet admin api endpoint via certificates to allow clearing environment caches<br><br> Defaults to `true` |
113+
| __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`|
113114
| __ENVIRONMENTPATH__ | Set an environmentpath<br><br> Defaults to `/etc/puppetlabs/code/environments` |
114115
| __HIERACONFIG__ | Set a hiera_config entry in puppet.conf file<br><br> Defaults to `$confdir/hiera.yaml` |
115116
| __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": {...}}'` |

0 commit comments

Comments
 (0)