github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: add settable properties tables to plugin docs

Browse Source 
Renames the existing `## Internal properties` umbrella section to `## Properties` across all plugin docs and adds a new `### Settable properties` subsection enumerating every property accepted by each plugin's `:set` command. Each row lists scope, default, the actual `:report` flag shapes that surface the value, and a one-line description. The buildpacks plugin is included even though it uses `:set-property`, with a note in the subsection clarifying the legacy command name. Property lists, scopes, and report flags were verified against plugin source and the live dokku binary.
This commit is contained in:
Jose Diaz-Gonzalez
2026-05-23 22:45:20 -04:00
parent 3d3c95545c
commit 8742f688e3
31 changed files with 466 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/configuration/environment-variables.md
View File

@@ -130,10 +130,12 @@ The following config variables have special meanings and can be set in a variety
| `DOKKU_SYSTEM_GROUP` | `dokku` | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*` | System group to chown files as. |
| `DOKKU_SYSTEM_USER` | `dokku` | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*` | System user to chown files as. |
## Internal properties
## Properties
### Internal properties
The following property is recorded internally by the config plugin and is not exposed via `config:report`:
| Property | Kind | Description | Source |
|---|---|---|---|
| `env-migrated` | internal | Migration sentinel that records the per-app or global `DOKKU_*` env-var → property migration completed for 0.38.0 | `plugins/config/triggers.go` writes `"true"` after the upgrade-time pass |
| Property | Description | Source |
|---|---|---|
| `env-migrated` | Migration sentinel that records the per-app or global `DOKKU_*` env-var → property migration completed for 0.38.0 | `plugins/config/triggers.go` writes `"true"` after the upgrade-time pass |

26
docs/configuration/ssl.md
View File

@@ -151,17 +151,19 @@ If an `https:443:*` port mapping already exists when a certificate is installed
See the [running behind another proxy documentation](/docs/networking/proxies/nginx.md#running-behind-another-proxy--configuring-x-forwarded--headers) for more information on how to configure your Nginx config when your server is running behind a proxy (e.g. load balancer, etc.).
## Internal properties
## Properties
The following properties surface in `certs:report` but are not managed by `certs:set` - they are derived from the on-disk certificate:
### Read-only flags
| Property | Kind | Description | Source |
|---|---|---|---|
| `--ssl-enabled` | read-only | `true` when an SSL certificate is installed for the app | `plugins/certs/internal-functions` checks `$DOKKU_ROOT/$APP/tls` |
| `--ssl-dir` | read-only | Absolute path to the per-app certificate directory | derived from `$DOKKU_ROOT/$APP/tls` |
| `--ssl-hostnames` | read-only | Hostnames the certificate covers (CN plus Subject Alternative Names) | `openssl x509` parse of `server.crt` |
| `--ssl-issuer` | read-only | Certificate issuer DN | `openssl x509 ... Issuer:` parse |
| `--ssl-subject` | read-only | Certificate subject DN | `openssl x509 ... Subject:` parse |
| `--ssl-verified` | read-only | `true` if the certificate chain verifies against the system CA bundle | `openssl verify` |
| `--ssl-expires-at` | read-only | Certificate `notAfter` timestamp | `openssl x509 ... Not After :` parse |
| `--ssl-starts-at` | read-only | Certificate `notBefore` timestamp | `openssl x509 ... Not Before:` parse |
The following flags surface in `certs:report` but are not managed by `certs:set` - they are derived from the on-disk certificate:
| Flag | Description |
|---|---|
| `--ssl-enabled` | `true` when an SSL certificate is installed for the app |
| `--ssl-dir` | Absolute path to the per-app certificate directory |
| `--ssl-hostnames` | Hostnames the certificate covers (CN plus Subject Alternative Names) |
| `--ssl-issuer` | Certificate issuer DN |
| `--ssl-subject` | Certificate subject DN |
| `--ssl-verified` | `true` if the certificate chain verifies against the system CA bundle |
| `--ssl-expires-at` | Certificate `notAfter` timestamp |
| `--ssl-starts-at` | Certificate `notBefore` timestamp |