docs: renew_interval global option

This commit is contained in:
Francis Lavoie 2022-03-09 01:36:23 -05:00
parent 6051f8a779
commit ab4f4d0342
No known key found for this signature in database
GPG key ID: E73DB3ECE64E7885

View file

@ -49,6 +49,7 @@ Possible options are:
<options...> <options...>
} }
storage_clean_interval <duration> storage_clean_interval <duration>
renew_interval <duration>
admin off|<addr> { admin off|<addr> {
origins <origins...> origins <origins...>
enforce_origin enforce_origin
@ -144,11 +145,15 @@ Customizing the storage module is typically needed when syncing Caddy's storage
##### `storage_clean_interval` ##### `storage_clean_interval`
How often to scan storage units for old or expired assets and remove them. These scans exert lots of reads (and list operations) on the storage module, so choose a longer interval for large deployments. The value is a [duration value](/docs/conventions#durations). Default: 24h. How often to scan storage units for old or expired assets and remove them. These scans exert lots of reads (and list operations) on the storage module, so choose a longer interval for large deployments. The value is a [duration value](/docs/conventions#durations). Default: `24h`.
Storage will always be cleaned when the process first starts. Then, a new cleaning will be started this duration after the previous cleaning started if the previous cleaning finished in less than half the time of this interval (otherwise next start will be skipped). Storage will always be cleaned when the process first starts. Then, a new cleaning will be started this duration after the previous cleaning started if the previous cleaning finished in less than half the time of this interval (otherwise next start will be skipped).
##### `renew_interval`
How often to scan all loaded, managed certificates for expiration, and trigger renewal if expired. Default: `10m`.
##### `admin` ##### `admin`
Customizes the [admin API endpoint](/docs/api). If `off`, then the admin endpoint will be disabled. If disabled, config changes will be impossible without stopping and starting the server. Customizes the [admin API endpoint](/docs/api). If `off`, then the admin endpoint will be disabled. If disabled, config changes will be impossible without stopping and starting the server.