~mdw
/
hippotat
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
rename "password" to "secret" everywhere
[hippotat]
/
README.config
diff --git
a/README.config
b/README.config
index
881694f
..
a9d36d7
100644
(file)
--- a/
README.config
+++ b/
README.config
@@
-4,8
+4,8
@@
Sections
[<servername> - <client>]
[<client>]
[<servername> - <client>]
[<client>]
- [<servername>]
usually
[SERVER]
- [
DEFAULT
]
+ [<servername>]
often
[SERVER]
+ [
COMMON
]
Keys are looked up in that order, unless otherwise specified.
<client> is the client's virtual address.
Keys are looked up in that order, unless otherwise specified.
<client> is the client's virtual address.
@@
-15,13
+15,13
@@
Exceptional settings:
server
Specifies <servername>.
server
Specifies <servername>.
- Is looked up in [SERVER] and [
DEFAULT
] only.
+ Is looked up in [SERVER] and [
COMMON
] only.
If not specified there, it is SERVER.
Used by server to select the appropriate parts of the
rest of the configuration. Ignored by the client.
If not specified there, it is SERVER.
Used by server to select the appropriate parts of the
rest of the configuration. Ignored by the client.
- password
+ secret
Looked up in the usual way, but used by client and server to
determine which possible peerings to try to set up, and which to
ignore.
Looked up in the usual way, but used by client and server to
determine which possible peerings to try to set up, and which to
ignore.
@@
-32,19
+32,19
@@
Exceptional settings:
(LIMIT sections do not count.)
The server queue packets for, and accept requests from, each
(LIMIT sections do not count.)
The server queue packets for, and accept requests from, each
- putative client for which the config search yields a
password
.
+ putative client for which the config search yields a
secret
.
Each client will create a local interface, and try to communicate
with the server, for each possible pair (putative server,
Each client will create a local interface, and try to communicate
with the server, for each possible pair (putative server,
- putative client) for which the config search yields a
password
.
+ putative client) for which the config search yields a
secret
.
ipif
Command to run to create and communicate with local network
interface. Passed to sh -c. Must speak SLIP on stdin/stdout.
The following additional interpolations aare substituted:
ipif
Command to run to create and communicate with local network
interface. Passed to sh -c. Must speak SLIP on stdin/stdout.
The following additional interpolations aare substituted:
- %(local)s
%(peer)s %(rnet
)s
- on server <vaddr>
<vrelay> <vnetwork
>
- on client <client>
<vaddr> <vroutes
>
+ %(local)s
%(peer)s %(rnet)s %(ifname
)s
+ on server <vaddr>
<vrelay> <vnetwork> <ifname_server
>
+ on client <client>
<vaddr> <vroutes> <ifname_client
>
["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
On server: applies to all clients; not looked up in
["userv root ipif %(local)s,%(peer)s,%(mtu)s,slip %(rnets)s"]
On server: applies to all clients; not looked up in
@@
-54,14
+54,19
@@
Exceptional settings:
Capped settings:
Values in [<server> LIMIT] and [LIMIT] are a cap (maximum) on
Capped settings:
Values in [<server> LIMIT] and [LIMIT] are a cap (maximum) on
- those from the other sections (including
DEFAULT
).
+ those from the other sections (including
COMMON
).
max_batch_down
Size limit for response payloads (used by server only)
[65536 bytes; LIMIT: 262144 bytes]
max_queue_time
max_batch_down
Size limit for response payloads (used by server only)
[65536 bytes; LIMIT: 262144 bytes]
max_queue_time
- Discard downwards packets after this long (used by server only)
+ Discard packets after they have been queued this long waiting
+ for http.
+ On server: setting applies to downward packets, and is capped
+ by LIMIT values.
+ On client: setting applies to upward packets, and is
+ not affected by LIMIT values.
[10 s; LIMIT: 121 s]
http_timeout
[10 s; LIMIT: 121 s]
http_timeout
@@
-109,7
+114,13
@@
Ordinary settings, used by both, not client-specific:
On client: used only to construct default url.
mtu
On client: used only to construct default url.
mtu
- Must match exactly. (checked) [1500 bytes]
+ Must match exactly. (UNCHECKED) [1500 bytes]
+
+ ifname_server
+ Virtual interface name on the server. [shippo%d]
+ ifname_client
+ Virtual interface name on the client. [hippo%d]
+ Any %d is interpolated (by the kernel).
Ordinary settings, used by client only:
Ordinary settings, used by client only: