From 2384bfa0a0c1196e5a7bcbf2e1b93005a33572a9 Mon Sep 17 00:00:00 2001 From: Robert Waffen Date: Thu, 20 Nov 2025 11:00:09 +0100 Subject: [PATCH] chore(docs): correct typos and formatting in README.md --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 83060e0..79219b4 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 | -|---------------------------------------|-----------------------------------------------------------------------| + + +| Name | Usage / Default | +| ------------------------------------- | --------------- | | **CERTNAME** | The DNS name used on this services SSL certificate

`openvoxdb` | | **DNS_ALT_NAMES** | Additional DNS names to add to the services SSL certificate

Unset | | **LOGDIR** | Path of the log directory

`/opt/puppetlabs/server/data/puppetdb/logs` | | **OPENVOXDB_CERTIFICATE_ALLOWLIST** | Set to a comma seaprated list of allowed certnames.

`""` | -| **OPENVOXDB_JAVA_ARGS** | Arguments passed directly to the JVM when starting the service

`-Djava.net.preferIPv4Stack=true -Xms256m -Xmx256m -XX:+UseParallelGC -Xlog:gc*:file=$LOGDIR/openvoxdb_gc.log -Djdk.tls.ephemeralDHKeySize=2048` | +| **OPENVOXDB_JAVA_ARGS** | Arguments passed directly to the JVM when starting the service

`-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

`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

`7d` | | **OPENVOXDB_POSTGRES_DATABASE** | The name of the openvoxdb database in postgres

`openvoxdb` | @@ -84,10 +87,12 @@ podman pull ghcr.io/openvoxproject/openvoxdb:8.9.0-v1.2.3 | **SSLDIR** | Path of the SSL directory

`/opt/puppetlabs/server/data/puppetdb/certs` | | **USE_OPENVOXSERVER** | Set to `false` to skip acquiring SSL certificates from a OpenVox Server.

`true` | | **WAITFORCERT** | Number of seconds to wait for certificate to be signed

`120` | + + ### 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`