Commit 7328d3e8 authored by Miek Gieben's avatar Miek Gieben Committed by GitHub

plugin/reload: reflow documentation (#3313)

* plugin/reload: reflow documentation

For some reason these we're all bullets points, which made for awkward
reading.
Signed-off-by: default avatarMiek Gieben <miek@miek.nl>

* typo
Signed-off-by: default avatarMiek Gieben <miek@miek.nl>

* Update plugin/reload/README.md
Co-Authored-By: default avatarMichael Grosser <development@stp-ip.net>
parent 8af46855
......@@ -38,11 +38,12 @@ This plugin can only be used once per Server Block.
reload [INTERVAL] [JITTER]
~~~
* The plugin will check for changes every **INTERVAL**, subject to +/- the **JITTER** duration
* **INTERVAL** and **JITTER** are Golang (durations)[https://golang.org/pkg/time/#ParseDuration]
* Default **INTERVAL** is 30s, default **JITTER** is 15s
* Minimal value for **INTERVAL** is 2s, and for **JITTER** is 1s
* If **JITTER** is more than half of **INTERVAL**, it will be set to half of **INTERVAL**
The plugin will check for changes every **INTERVAL**, subject to +/- the **JITTER** duration.
* **INTERVAL** and **JITTER** are Golang (durations)[[https://golang.org/pkg/time/#ParseDuration](https://golang.org/pkg/time/#ParseDuration)].
The default **INTERVAL** is 30s, default **JITTER** is 15s, the minimal value for **INTERVAL**
is 2s, and for **JITTER** it is 1s. If **JITTER** is more than half of **INTERVAL**, it will be
set to half of **INTERVAL**
## Examples
......
// Package reload periodically checks if the Corefile has changed, and reloads if so.
package reload
import (
......@@ -11,7 +12,6 @@ import (
"github.com/caddyserver/caddy/caddyfile"
)
// reload periodically checks if the Corefile has changed, and reloads if so
const (
unused = 0
maybeUsed = 1
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment