diff --git a/self-host/advanced/config-file.mdx b/self-host/advanced/config-file.mdx index 236d177..b774802 100644 --- a/self-host/advanced/config-file.mdx +++ b/self-host/advanced/config-file.mdx @@ -712,6 +712,15 @@ This section contains the complete reference for all configuration options in `c + + Enable automatic synchronization of ACME certificates for TLS termination on private resources. + + ```yaml + flags: + enable_acme_cert_sync: true + ``` + + Whether to disable public user registration. @@ -864,6 +873,58 @@ This section contains the complete reference for all configuration options in `c +### ACME Configuration + + + 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. + + + + 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. + + + + 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" + ``` + + + + Interval in milliseconds at which Pangolin polls the `acme.json` file for certificate changes. + + ```yaml + acme: + sync_interval_ms: 5000 + ``` + + + + 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" + ``` + + + + ## Environment Variables Some configuration values can be set using environment variables for enhanced security: diff --git a/self-host/advanced/private-config-file.mdx b/self-host/advanced/private-config-file.mdx index 10cf6b3..09c5021 100644 --- a/self-host/advanced/private-config-file.mdx +++ b/self-host/advanced/private-config-file.mdx @@ -202,15 +202,6 @@ This section contains the complete reference for all configuration options in `p ``` - - Enable automatic synchronization of ACME certificates for TLS termination on private resources. - - ```yaml - flags: - enable_acme_cert_sync: true - ``` - - 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 -### ACME Configuration - - - 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. - - - - 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" - ``` - - - - Interval in milliseconds at which Pangolin polls the `acme.json` file for certificate changes. - - ```yaml - acme: - sync_interval_ms: 5000 - ``` - - - - 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" - ``` - - - - ### Branding Configuration Please refer to the [branding configuration documentation](/manage/branding). \ No newline at end of file