Skip to content

chore(docs): correct typos and formatting in README.md #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 20, 2025
Merged

chore(docs): correct typos and formatting in README.md #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- [How to contribute](#how-to-contribute)

---

This project hosts the Containerfile and the required scripts to build a OpenVoxDB container image.

For compose file see: [CRAFTY](https://github.com/voxpupuli/crafty/tree/main/puppet/oss)
Expand Down Expand Up @@ -50,24 +51,26 @@ Example usage:
podman pull ghcr.io/openvoxproject/openvoxdb:8.9.0-v1.2.3
```

| Name | Description |
| --- | --- |
| openvox.major | Describes the contained major OpenVox version |
| openvox.minor | Describes the contained minor OpenVox version |
| openvox.patch | Describes the contained patchlevel OpenVox version |
| Name | Description |
| --------------- | ----------------------------------------------------------------------------------------- |
| openvox.major | Describes the contained major OpenVox version |
| openvox.minor | Describes the contained minor OpenVox version |
| openvox.patch | Describes the contained patchlevel OpenVox version |
| container.major | Describes the major version of the base container (Ubunutu 24.04) or incompatible changes |
| container.minor | Describes new features or refactoring with backward compatibility |
| container.patch | Describes if minor changes or bugfixes have been implemented |
| container.minor | Describes new features or refactoring with backward compatibility |
| container.patch | Describes if minor changes or bugfixes have been implemented |

## Configuration

| Name | Usage / Default |
|---------------------------------------|-----------------------------------------------------------------------|
<!-- markdownlint-disable table-column-style -->
<!-- markdownlint-disable line-length -->
| Name | Usage / Default |
| ------------------------------------- | --------------- |
| **CERTNAME** | The DNS name used on this services SSL certificate<br><br>`openvoxdb` |
| **DNS_ALT_NAMES** | Additional DNS names to add to the services SSL certificate<br><br>Unset |
| **LOGDIR** | Path of the log directory<br><br>`/opt/puppetlabs/server/data/puppetdb/logs` |
| **OPENVOXDB_CERTIFICATE_ALLOWLIST** | Set to a comma seaprated list of allowed certnames.<br><br>`""` |
| **OPENVOXDB_JAVA_ARGS** | Arguments passed directly to the JVM when starting the service<br><br>`-Djava.net.preferIPv4Stack=true -Xms256m -Xmx256m -XX:+UseParallelGC -Xlog:gc*:file=$LOGDIR/openvoxdb_gc.log -Djdk.tls.ephemeralDHKeySize=2048` | <!-- markdownlint-disable-line -->
| **OPENVOXDB_JAVA_ARGS** | Arguments passed directly to the JVM when starting the service<br><br>`-Djava.net.preferIPv4Stack=true -Xms256m -Xmx256m -XX:+UseParallelGC -Xlog:gc*:file=$LOGDIR/openvoxdb_gc.log -Djdk.tls.ephemeralDHKeySize=2048` |
| **OPENVOXDB_NODE_PURGE_TTL** | Automatically delete nodes that have been deactivated or expired for the specified amount of time<br><br>`14d` |
| **OPENVOXDB_NODE_TTL** | Mark as ‘expired’ nodes that haven’t seen any activity (no new catalogs, facts, or reports) in the specified amount of time<br><br>`7d` |
| **OPENVOXDB_POSTGRES_DATABASE** | The name of the openvoxdb database in postgres<br><br>`openvoxdb` |
Expand All @@ -84,10 +87,12 @@ podman pull ghcr.io/openvoxproject/openvoxdb:8.9.0-v1.2.3
| **SSLDIR** | Path of the SSL directory<br><br>`/opt/puppetlabs/server/data/puppetdb/certs` |
| **USE_OPENVOXSERVER** | Set to `false` to skip acquiring SSL certificates from a OpenVox Server.<br><br>`true` |
| **WAITFORCERT** | Number of seconds to wait for certificate to be signed<br><br>`120` |
<!-- markdownlint-enable line-length -->
<!-- markdownlint-enable table-column-style -->

### Cert File Locations

The directory structure follows the following conventions. The full path is always available inside the container as the environment variable `$SSLDIR`
The directory structure follows the following conventions. The full path is always available inside the container as the environment variable `$SSLDIR`

- 'ssl-ca-cert'
`/opt/puppetlabs/server/data/puppetdb/certs/certs/ca.pem`
Expand Down
Loading