Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

docs(cert-agent): generic full-chain example

bernie-g036d260df194
diff --git a/docs/documentation/platform/pki/reference/infisical-agent.mdx b/docs/documentation/platform/pki/reference/infisical-agent.mdx
index a4bb7d6473..efae6672a8 100644
--- a/docs/documentation/platform/pki/reference/infisical-agent.mdx
+++ b/docs/documentation/platform/pki/reference/infisical-agent.mdx
@@ -173,7 +173,7 @@ Each entry in the `certificates` list accepts the following parameters:
| `file-output.chain.path` | Optional | The path to store the certificate chain |
| `file-output.chain.permission` | Optional (defaults to `0600`) | The octal file permissions for the chain file (e.g. `0644`) |
| `file-output.chain.omit-root` | Optional (defaults to `true`) | Whether to exclude the root CA certificate from the written chain |
-| `file-output.combine-certificate-chain` | Optional (defaults to `false`) | Whether to write the certificate followed by its chain to `certificate.path` as a single full-chain file. When `true`, `chain.path` is ignored and `chain.omit-root` still applies. See [Full-chain file for NGINX](#full-chain-file-for-nginx) |
+| `file-output.combine-certificate-chain` | Optional (defaults to `false`) | Whether to write the certificate followed by its chain to `certificate.path` as a single full-chain file. When `true`, `chain.path` is ignored and `chain.omit-root` still applies. See [Full-chain certificate file](#full-chain-certificate-file) |
| `lifecycle.renew-before-expiry` | Optional (auto-renewal is disabled if not set) | How long before expiration the agent should renew the certificate (e.g. `14d`). Must be shorter than the certificate's TTL |
| `lifecycle.replace-on-renewals` | Optional (defaults to `false`) | Only valid with `certificate-id`. Whether the agent should deliver the most recent renewal of that certificate instead of the certificate itself |
| `lifecycle.status-check-interval` | Optional (defaults to `10s`) | How frequently the agent checks certificate status and renewal needs |
@@ -353,11 +353,11 @@ certificates:
timeout: 30
```
-### Full-chain file for NGINX
+### Full-chain certificate file
-NGINX expects the certificate and its intermediate chain in one file. With `combine-certificate-chain: true`, the agent writes the certificate followed by the chain to `certificate.path` on issuance and on every renewal. No concatenation script is needed.
+Many web servers and proxies expect the certificate and its intermediate chain in one file. Examples include NGINX, Envoy, Traefik and Caddy. With `combine-certificate-chain: true`, the agent writes the certificate followed by the chain to `certificate.path` on issuance and on every renewal. No concatenation script is needed.
-```yaml
+```yaml expandable
version: v2
infisical:
@@ -386,21 +386,9 @@ certificates:
certificate:
path: "/etc/ssl/certs/api.example.com.fullchain.pem"
permission: "0644"
- post-hooks:
- on-issuance:
- command: "systemctl reload nginx"
- timeout: 30
- on-renewal:
- command: "systemctl reload nginx"
- timeout: 30
```
-Configure NGINX with the combined file and the private key:
-
-```nginx
-ssl_certificate /etc/ssl/certs/api.example.com.fullchain.pem;
-ssl_certificate_key /etc/ssl/private/api.example.com.key;
-```
+Point the server's certificate setting at the combined file and its key setting at the private key. In NGINX, these are `ssl_certificate` and `ssl_certificate_key`. Add [post-event hooks](#post-event-hooks) to reload the server after issuance and renewal.
The root CA is left out of the file by default. Set `file-output.chain.omit-root: false` to include it.