-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.html
113 lines (98 loc) · 3.75 KB
/
config.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
<title>HectoDNS | server configuration</title>
</meta>
<link rel="stylesheet" href="style.css"/>
</head>
<body>
<div class="main">
<h2>HectoDNS | server configuration</h2>
<nav>
<a href="/index.html">Readme</a> |
<a href="/config.html">Configuration</a> |
<a href="/signals.html">Signals</a> |
<a href="/design.html">Design</a>
</nav>
<h3>The simplest configuration</h3>
<p>
This configuration allows to start a server listening UDP port <code>53</code>
that resonds with <code>SERVFAIL</code> on each submitted request.
</p>
<pre>
server {
listen = ":53"
proto = "udp"
}
</pre>
<h3>Core configuration</h3>
<div class="config">
<p>Syntax: <code><strong>server_shutdown_timeout</strong> = <i>"duration"</i></code></p>
<p>Default: <code>server_shutdown_timeout = "0s"</code></p>
</div>
<p>
Configures a timeout for a graceful shutdown of server. When the <i>duration</i>
expires, hectodns will close connections to facilitate shutdown.
</p>
<div class="config">
<p>Syntax: <code><strong>server</strong> { ... }</code></p>
<p>Default: <code>—</code></p>
</div>
<p>
Sets configuration for a server.
</p>
<h3>Server configuration</h3>
<div class="config">
<p>Syntax: <code><strong>listen</strong> = <i>"address:port"</i></code>
<p>Default: <code>listen = ":53"</code></p>
</div>
<p>
Sets <i>address</i> and <i>port</i> for IP for a on with server will accept requests.
An <i>address</i> may also be a hostname, for example:
</p>
<blockquote class="example">
<pre>
listen = ":53"
listen = "127.0.0.1:53"
listen = ":5353"
listen = "localhost:5353"
</pre>
</blockquote>
<div class="config">
<p>Syntax: <code><strong>max_conns</strong> = <i>number</i></code></p>
<p>Default: <code>max_conns = 0</code></p>
</div>
<p>Sets the maximum number of simultaneous connections that can be opened by a single server. By default, there is no limit on maximum connections.</p>
<div class="config">
<p>Syntax: <code><strong>proto</strong> = <i>"udp"</i>|<i>"tcp"</i>|<i>"http"</i></code></p>
<p>Default: <code>proto = "udp"</code></p>
</div>
<p>Sets the communication protocol of the server.</p>
<p>When <i>"http"</i> is set, the DNS queries over HTTP will be used.</p>
<div class="config">
<p>Syntax: <code><strong>request_timeout</strong> = <i>"duration"</i></code></p>
<p>Default: <code>request_timeout = "0s"</code></p>
</div>
<p>Sets the maximum duration for processing the request. A timeout of zero means to timeout.</p>
<div class="config">
<p>Syntax: <code><strong>resolver</strong> <i>"name"</i> { ... }</code></p>
<p>Default: <code>—</code></p>
</div>
<p>
Sets configuration for a resolver plugin. Resolvers is a sequence of
resolution plugins that are sequentially polled in order to retrieve
a response on the processing request.
</p>
<div class="config">
<p>Sytax: <code><strong>resolver_directory</strong> = <i>"path"</i></code></p>
<p>Default: <code>resolver_director = <i>"$cwd"</i></code></p>
</div>
<p>
Sets the working directory for resolvers, when specified server searches
the executable in the given path, otherwise a current working directory
will be used
</p>
</body>
</html>