pangolin_mirror/docs-v2
1
0
Fork 0
mirror of https://github.com/fosrl/docs-v2.git synced 2026-08-31 03:01:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Move the acme cert sync

Browse Source
This commit is contained in:
Owen
2026-08-18 10:51:00 -04:00
parent b2b4cae681
commit 45baf08dc4
2 changed files with 61 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
self-host/advanced/config-file.mdx
View File

@@ -712,6 +712,15 @@ This section contains the complete reference for all configuration options in `c
</Warning>
</ResponseField>
<ResponseField name="enable_acme_cert_sync" type="boolean" default="true">
Enable automatic synchronization of ACME certificates for TLS termination on private resources.
```yaml
flags:
enable_acme_cert_sync: true
```
</ResponseField>
<ResponseField name="disable_signup_without_invite" type="boolean">
Whether to disable public user registration.
@@ -864,6 +873,58 @@ This section contains the complete reference for all configuration options in `c
</Expandable>
</ResponseField>
### ACME Configuration
<Note>
The ACME config for syncing the certs used to be in the private config file but has moved to the public config file here. Please update config accordingly.
</Note>
<ResponseField name="acme" type="object">
Configuration for ACME certificate synchronization. Used in conjunction with `flags.enable_acme_cert_sync` to synchronize TLS certificates issued by Traefik (or another ACME client) into Pangolin for use on private resources.
<Expandable title="properties">
<ResponseField name="acme_json_path" type="string" default="config/letsencrypt/acme.json">
Path to the `acme.json` file or a directory containing more than one acme json file produced by Traefik (or another ACME client). Pangolin reads this file to extract certificates for synchronization and will look for all files in the specified directory if a directory is provided. The file must be in the format produced by Traefik's ACME integration. This file is typically mounted as a volume from your ACME client container.
```yaml
acme:
acme_json_path: "config/letsencrypt/acme.json"
```
</ResponseField>
<ResponseField name="sync_interval_ms" type="number" default="5000">
Interval in milliseconds at which Pangolin polls the `acme.json` file for certificate changes.
```yaml
acme:
sync_interval_ms: 5000
```
</ResponseField>
<ResponseField name="acme_http_endpoint" type="string" default="">
HTTP endpoint where Pangolin can pull SSL certificates from to load into the database. Provided in the following format:
```json
[
{
"wildcard": false,
"altName": "subdomain.example.com",
"certName": "subdomain.example.com",
"commonName": "subdomain.example.com",
"certFile": "",
"keyFile": ""
}
]
```
```yaml
acme:
acme_http_endpoint: "http://controller-api.pangolin.svc.cluster.local/api/v1/certificates"
```
</ResponseField>
</Expandable>
</ResponseField>
## Environment Variables
Some configuration values can be set using environment variables for enhanced security:

57
self-host/advanced/private-config-file.mdx
View File

@@ -202,15 +202,6 @@ This section contains the complete reference for all configuration options in `p
```
</ResponseField>
<ResponseField name="enable_acme_cert_sync" type="boolean" default="true">
Enable automatic synchronization of ACME certificates for TLS termination on private resources.
```yaml
flags:
enable_acme_cert_sync: true
```
</ResponseField>
<ResponseField name="enable_redis" type="boolean" default="false">
Enable Redis for caching and session management. Requires `redis` configuration.
@@ -231,54 +222,6 @@ This section contains the complete reference for all configuration options in `p
</Expandable>
</ResponseField>
### ACME Configuration
<ResponseField name="acme" type="object">
Configuration for ACME certificate synchronization. Used in conjunction with `flags.enable_acme_cert_sync` to synchronize TLS certificates issued by Traefik (or another ACME client) into Pangolin for use on private resources.
<Expandable title="properties">
<ResponseField name="acme_json_path" type="string" default="config/letsencrypt/acme.json">
Path to the `acme.json` file or a directory containing more than one acme json file produced by Traefik (or another ACME client). Pangolin reads this file to extract certificates for synchronization and will look for all files in the specified directory if a directory is provided. The file must be in the format produced by Traefik's ACME integration. This file is typically mounted as a volume from your ACME client container.
```yaml
acme:
acme_json_path: "config/letsencrypt/acme.json"
```
</ResponseField>
<ResponseField name="sync_interval_ms" type="number" default="5000">
Interval in milliseconds at which Pangolin polls the `acme.json` file for certificate changes.
```yaml
acme:
sync_interval_ms: 5000
```
</ResponseField>
<ResponseField name="acme_http_endpoint" type="string" default="">
HTTP endpoint where Pangolin can pull SSL certificates from to load into the database. Provided in the following format:
```json
[
{
"wildcard": false,
"altName": "subdomain.example.com",
"certName": "subdomain.example.com",
"commonName": "subdomain.example.com",
"certFile": "",
"keyFile": ""
}
]
```
```yaml
acme:
acme_http_endpoint: "http://controller-api.pangolin.svc.cluster.local/api/v1/certificates"
```
</ResponseField>
</Expandable>
</ResponseField>
### Branding Configuration
Please refer to the [branding configuration documentation](/manage/branding).