-
-
Notifications
You must be signed in to change notification settings - Fork 153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs for PR caddyserver/caddy#6573 #424
base: 2.9
Are you sure you want to change the base?
Changes from 16 commits
e590d29
bc8db1d
3c8bd2a
fe713a3
f0e45f6
83c0376
1e98c7d
bcb697a
5604b50
a0eb8cf
22a1f3e
f9cf7ef
17c9c59
5bc75dd
3292caf
ed85759
ed889b6
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,6 +32,7 @@ The network can be any of the following; ones suffixed with `4` or `6` are IPv4 | |
- UDP: `udp`, `udp4`, `udp6` | ||
- IP: `ip`, `ip4`, `ip6` | ||
- Unix: `unix`, `unixgram`, `unixpacket` | ||
- File descriptors: `fd`, `fdgram` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think a short paragraph to explain what a "file descriptor" means in this context would help |
||
|
||
The address part may be any of these forms: | ||
|
||
|
@@ -42,10 +43,12 @@ The address part may be any of these forms: | |
- `/path/to/unix/socket` | ||
- `/path/to/unix/socket|0200` | ||
|
||
The host may be any hostname, resolvable domain name, or IP address. | ||
The host may be any hostname, resolvable domain name, IP address, or file descriptor number. | ||
|
||
In the case of IPv6 addresses, the address must be enclosed in square brackets `[]`. The zone identifier (starting with `%`) is optional (often used for link-local addresses). | ||
|
||
In the case of file descriptors, the host must be an unsigned [integer literal](https://go.dev/ref/spec#Integer_literals). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could we explain here a bit how this works? Like what does the number actually represent? I don't have a good understanding of how file descriptors are useful, and I assume most users wouldn't understand the point of it either. In all these docs, I only see examples with |
||
|
||
The port may be a single value (`:8080`) or an inclusive range (`:8080-8085`). A port range will be multiplied into singular addresses. Not all config fields accept port ranges. The special port `:0` means any available port. | ||
|
||
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. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should explain a bit why you'd want to use file descriptors. As a reader, I think "but why?"