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
+20-4Lines changed: 20 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ ZeroNS provides names that are a part of [ZeroTier Central's](https://my.zerotie
5
5
- Listens on the local interface joined to that network -- you will want to start one ZeroNS per ZeroTier network.
6
6
- Provides general DNS by forwarding all queries to `/etc/resolv.conf` resolvers that do not match the TLD, similar to `dnsmasq`.
7
7
- Tells Central to point all clients that have the "Manage DNS" settings turned **on** to resolve to it.
8
-
- Finally, sets a provided TLD (`.domain` is the default), as well as configuring `A` (IPv4) and `AAAA` (IPv6) records for:
8
+
- Finally, sets a provided TLD (`.home.arpa` is the default; recommended by IANA), as well as configuring `A` (IPv4) and `AAAA` (IPv6) records for:
9
9
- Member IDs: `zt-<memberid>.<tld>` will resolve to the IPv4 & IPv6 addresses for them.
10
10
- Names: _if_ the names are compatible with DNS names, they will be converted as such: to `<name>.<tld>`.
11
11
- Please note that **collisions are possible** and that it's _up to the admin to prevent them_.
@@ -18,7 +18,7 @@ Before continuing, be reminded that zeronsd is **beta software**. That said, if
18
18
19
19
Packages:
20
20
21
-
- Linux/Windows: [releases](https://github.com/zerotier/zeronsd/releases) contain packages for `*.deb`, `*.rpm` for Linux, and MSI format for Windows.
21
+
- Linux/Windows: [releases](https://github.com/zerotier/zeronsd/releases) contain packages for `*.deb`, `*.rpm` for Linux, and MSI format for Windows.**NOTE**: the Windows MSI will install a firewall exception for port 53 so zeronsd can communicate.
22
22
-[Arch Linux](https://aur.archlinux.org/packages/zeronsd/) packages provided by [@devvick](https://github.com/devvick)!
23
23
- Mac OS X: `brew tap zerotier/homebrew-tap && brew install zerotier/homebrew-tap/zeronsd`
24
24
- Docker: `docker pull zerotier/zeronsd` (see below for more on docker)
@@ -33,7 +33,7 @@ Please obtain a working [rust environment](https://rustup.rs/) first.
33
33
cargo install zeronsd
34
34
```
35
35
36
-
### From Git
36
+
### From Git (via Cargo)
37
37
38
38
```
39
39
cargo install --git https://github.com/zerotier/zeronsd --branch main
Once built, the image automatically runs `zeronsd` for you. The default subcommand is `help`.
61
61
62
+
### Docker (alpine edition)
63
+
64
+
See [Dockerfile.alpine](Dockerfile.alpine).
65
+
62
66
## Usage
63
67
64
68
Setting `ZEROTIER_CENTRAL_TOKEN` in the environment (or providing the `-t` flag, which points at a file containing this value) is required. You must be able to administer the ZeroTier network to use `zeronsd` with it. Also, running as `root` is required as _many client resolvers do not work over anything but port 53_. Your `zeronsd` instance will listen on both `udp` and `tcp`, port `53`.
@@ -71,6 +75,18 @@ Setting `ZEROTIER_CENTRAL_TOKEN` in the environment (or providing the `-t` flag,
71
75
zeronsd start <network id>
72
76
```
73
77
78
+
#### Configuration
79
+
80
+
zeronsd as of v0.3 takes a configuration file via the `-c` flag which correlates to all of the command-line options. `--config-type` corresponds to the format of the configuration file: `yaml` is the default, and `json` and `toml` are also supported.
81
+
82
+
The configuration directives are as follows:
83
+
84
+
- domain: (string) will set a TLD for your records; the default is `home.arpa`.
85
+
- hosts: (string) will parse a file in `/etc/hosts` format and append it to your records.
86
+
- secret: (string) path to `authtoken.secret` which is needed to talk to ZeroTier on localhost. You can provide this file with this argument, but it is auto-detected on multiple platforms including Linux, OS X and Windows.
87
+
- token: (string) path to file containing your [ZeroTier Central token](https://my.zerotier.com/account).
88
+
- wildcard: (bool) Enables wildcard mode, where all member names get a wildcard in this format: `*.<name>.<tld>`; this points at the member's IP address(es).
89
+
74
90
### Running as a service
75
91
76
92
_This behavior is currently only supported on Linux and Mac OS X; we will accept patches for other platforms._
@@ -114,7 +130,7 @@ It should print some diagnostics after it has talked to your `zerotier-one` inst
114
130
115
131
### Flags for the `start` and `supervise` subcommands:
116
132
117
-
-`-d <tld>` will set a TLD for your records; the default is `domain`.
133
+
-`-d <tld>` will set a TLD for your records; the default is `home.arpa`.
118
134
-`-f <hosts file>` will parse a file in `/etc/hosts` format and append it to your records.
119
135
-`-s <secret file>` path to `authtoken.secret` which is needed to talk to ZeroTier on localhost. You can provide this file with this argument, but it is auto-detected on multiple platforms including Linux, OS X and Windows.
120
136
-`-t <central token file>` path to file containing your [ZeroTier Central token](https://my.zerotier.com/account).
0 commit comments