Skip to content

Commit 2dbb293

Browse files
rwaffenrwaffen
authored
Merge pull request #94 from OpenVoxProject/fix_readme
chore(docs): correct typos and formatting in README.md
2 parents 8e9940c + 867a0ae commit 2dbb293

1 file changed

Lines changed: 19 additions & 15 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -78,29 +78,31 @@ Example usage:
7878
podman run --name openvox --hostname openvox -v ./code:/etc/puppetlabs/code/ ghcr.io/openvoxproject/openvoxserver:8.8.0-v1.0.0
7979
```
8080

81-
| Name | Description |
82-
| --- | --- |
83-
| openvox.major | Describes the contained major OpenVox version |
84-
| openvox.minor | Describes the contained minor OpenVox version |
85-
| openvox.patch | Describes the contained patchlevel OpenVox version |
81+
| Name | Description |
82+
| --------------- | ----------------------------------------------------------------------------------------- |
83+
| openvox.major | Describes the contained major OpenVox version |
84+
| openvox.minor | Describes the contained minor OpenVox version |
85+
| openvox.patch | Describes the contained patchlevel OpenVox version |
8686
| container.major | Describes the major version of the base container (Ubunutu 24.04) or incompatible changes |
87-
| container.minor | Describes new features or refactoring with backward compatibility |
88-
| container.patch | Describes if minor changes or bugfixes have been implemented |
87+
| container.minor | Describes new features or refactoring with backward compatibility |
88+
| container.patch | Describes if minor changes or bugfixes have been implemented |
8989

9090
## Configuration
9191

9292
The following environment variables are supported:
9393

94-
| Name | Usage / Default |
95-
|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
94+
<!-- markdownlint-disable table-column-style -->
95+
<!-- markdownlint-disable line-length -->
96+
| Name | Usage / Default |
97+
|---------------------------------------------| --------------- |
9698
| __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`. |
97-
| __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` | <!-- markdownlint-disable-line -->
99+
| __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` |
98100
| __CA_ENABLED__ | Whether or not this openvoxserver instance has a running CA (Certificate Authority)<br><br>Defaults to `true` |
99101
| __CA_HOSTNAME__ | The DNS hostname for the openvoxserver running the CA. Does nothing unless `CA_ENABLED=false`<br><br>Defaults to `puppet` |
100102
| __CA_PORT__ | The listening port of the CA. Does nothing unless `CA_ENABLED=false`<br><br>Defaults to `8140` |
101103
| __CA_TTL__ | CA expire date (in seconds or with suffix `s`, `m`, `h`, `d`, `y`)<br><br>Defaults to `157680000` |
102104
| __CERTNAME__ | The DNS name used on the servers SSL certificate - sets the `certname` in puppet.conf<br><br>Defaults to unset. |
103-
| __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": {...}}'` | <!-- markdownlint-disable-line -->
105+
| __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": {...}}'` |
104106
| __DNS_ALT_NAMES__ | Additional DNS names to add to the servers SSL certificate<br>__Note__ only effective on initial run when certificates are generated |
105107
| __ENVIRONMENTPATH__ | Set an environmentpath<br><br> Defaults to `/etc/puppetlabs/code/environments` |
106108
| __HIERACONFIG__ | Set a hiera_config entry in puppet.conf file<br><br> Defaults to `$confdir/hiera.yaml` |
@@ -111,18 +113,20 @@ The following environment variables are supported:
111113
| __OPENVOX_REPORTS__ | Sets `reports` in puppet.conf<br><br>Defaults to `puppetdb` |
112114
| __OPENVOX_STORECONFIGS__ | Sets `storeconfigs` in puppet.conf<br><br>Defaults to `true` |
113115
| __OPENVOX_STORECONFIGS_BACKEND__ | Sets `storeconfigs_backend` in puppet.conf<br><br>Defaults to `puppetdb` |
114-
| __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'` | <!-- markdownlint-disable-line -->
116+
| __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'` |
115117
| __OPENVOXSERVER_ENABLE_ENV_CACHE_DEL_API__ | Enable the puppet admin api endpoint via certificates to allow clearing environment caches<br><br> Defaults to `true` |
116118
| __OPENVOXSERVER_ENVIRONMENT_TIMEOUT__ | Configure the environment timeout<br><br> Defaults to `unlimited` |
117119
| __OPENVOXSERVER_GRAPHITE_EXPORTER_ENABLED__ | Activate the graphite exporter. Also needs __OPENVOXSERVER_GRAPHITE_HOST__ and __OPENVOXSERVER_GRAPHITE_PORT__<br><br> Defaults to `false` |
118-
| __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` | <!-- markdownlint-disable-line -->
119-
| __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` | <!-- markdownlint-disable-line -->
120+
| __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` |
121+
| __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` |
120122
| __OPENVOXSERVER_HOSTNAME__ | The DNS name used on the servers SSL certificate - sets the `server` in puppet.conf<br><br>Defaults to unset. |
121123
| __OPENVOXSERVER_JAVA_ARGS__ | Arguments passed directly to the JVM when starting the service<br><br>Defaults to `-Xms1024m -Xmx1024m` |
122124
| __OPENVOXSERVER_MAX_ACTIVE_INSTANCES__ | The maximum number of JRuby instances allowed<br><br>Defaults to `1` |
123125
| __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` |
124126
| __OPENVOXSERVER_PORT__ | The port of the openvoxserver<br><br>Defaults to `8140` |
125-
| __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`| <!-- markdownlint-disable-line -->
127+
| __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` |
128+
<!-- markdownlint-enable line-length -->
129+
<!-- markdownlint-enable table-column-style -->
126130

127131
## Initialization Scripts
128132

0 commit comments

Comments
 (0)