diff --git a/src/docs/markdown/conventions.md b/src/docs/markdown/conventions.md index 19babcd..b010f0d 100644 --- a/src/docs/markdown/conventions.md +++ b/src/docs/markdown/conventions.md @@ -39,6 +39,7 @@ The address part may be any of these forms: - `host:port` - `:port` - `/path/to/unix/socket` +- `/path/to/unix/socket|0660` The host may be any hostname, resolvable domain name, or IP address. @@ -46,6 +47,8 @@ The port may be a single value (`:8080`) or an inclusive range (`:8080-8085`). A A unix socket path is only acceptable when using a `unix*` network type. The forward slash that separates the network and address is not considered part of the path. +When a unix socket is used as a bind address, you may optionally specify a file permission mode after the path, separated by a pipe `|`. The default is `0660` (octal), i.e. `u=rw,g=rw,o=`. The leading `0` is optional. + Valid examples: ``` @@ -57,6 +60,7 @@ tcp/localhost:8080 tcp/localhost:8080-8085 udp/localhost:9005 unix//path/to/socket +unix//path/to/socket|0660 ``` + + ## Placeholders Caddy's configuration supports the use of _placeholders_ (variables). Using placeholders is a simple way to inject dynamic values into a static configuration. @@ -101,6 +107,8 @@ Placeholder | Description Not all config fields support placeholders, but most do where you would expect it. + + ## File locations This section contains information about where to find various files. File and directory paths described here are defaults at best; some can be overridden.