You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-14
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
An nginx module to resolve domain names inside upstreams and keep them up to date.
4
4
5
-
By default, servers defined in nginx upstreams are only resolved when nginx starts. This module provides an alternative `dynamic_server` directive that can be used to asyncronously resolve upstream domain names. This keeps the upstream definition up to date according to the DNS TTL of each domain names. This can be useful if you want to use upstreams for dynamic types of domain names that may frequently change IP addresses.
5
+
By default, servers defined in nginx upstreams are only resolved when nginx starts. This module provides an additional `resolve` parameter for `server` definitions that can be used to asynchronously resolve upstream domain names. This keeps the upstream definition up to date according to the DNS TTL of each domain names. This can be useful if you want to use upstreams for dynamic types of domain names that may frequently change IP addresses.
6
6
7
7
This module also allows nginx to start if an upstream contains a defunct domain name that no longer resolves. By default, nginx will fail to start if an upstream server contains an unresolvable domain name. With this module, nginx is still allowed to start with invalid domain names, but an error will be logged and the unresolvable domain names will be marked as down.
8
8
@@ -15,9 +15,9 @@ make && make install
15
15
16
16
## Usage
17
17
18
-
Use the `dynamic_server` definition inside your upstreams instead of the built-in `server` (`dyamic_server` should be a drop-in replacement).
18
+
Use the `server` definition inside your upstreams and specify the `resolve` parameter.
19
19
20
-
*Note:* A `resolver` must be defined at the `http` level of nginx's config for `dynamic_server` to work.
20
+
*Note:* A `resolver` must be defined at the `http` level of nginx's config for `resolve` to work.
21
21
22
22
```
23
23
http {
@@ -31,28 +31,28 @@ http {
31
31
32
32
## Directives
33
33
34
-
### dynamic_server
34
+
### server
35
35
36
-
**Syntax:***server address [parameters]*;
37
-
**Context***upstream*
36
+
**Syntax:**`server address [parameters];`
37
+
**Context**`upstream`
38
38
39
-
Defines a server for an upstream. The differences between the default `server` and `dynamic_server` implementation:
39
+
Defines a server for an upstream. The module adds the ability to specify a `resolve` parameter. When specified:
40
40
41
41
- Domain names will be resolved on an ongoing basis and kept up to date according to the TTL of each domain name.
42
42
- Unresolvable domain names are considered non-fatal errors (but logged). nginx is allowed to startup if a domain name can't be resolved, but the server is marked as down.
43
43
44
44
The following parameters can be used (see nginx's [server documentation](http://nginx.org/en/docs/http/ngx_http_upstream_module.html#server) for details):
0 commit comments