From 452537adea1f553a0d809008a7906eb4aa7b472c Mon Sep 17 00:00:00 2001 From: Francis Lavoie Date: Sun, 2 May 2021 14:19:05 -0400 Subject: [PATCH] docs: Add `stoage_clean_interval` global option (#158) Docs for https://github.com/caddyserver/caddy/pull/4134 --- src/docs/markdown/caddyfile/options.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/docs/markdown/caddyfile/options.md b/src/docs/markdown/caddyfile/options.md index 6bc44e6..4288c58 100644 --- a/src/docs/markdown/caddyfile/options.md +++ b/src/docs/markdown/caddyfile/options.md @@ -28,6 +28,7 @@ Possible options are: storage { } + storage_clean_interval admin off| { origins enforce_origin @@ -96,6 +97,11 @@ Sets or changes the standard order of HTTP handler directive(s). Can set directi ##### `storage` Configures Caddy's storage mechanism. The default is [`file_system`](/docs/json/storage/file_system/). There are many other available [storage modules](/docs/json/storage/) provided as plugins. +##### `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. + +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). + ##### `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.