Browse Source

update docs

master
Brett Langdon 10 years ago
parent
commit
7ef790e82e
2 changed files with 12 additions and 4 deletions
  1. +7
    -0
      README.md
  2. +5
    -4
      doc.go

+ 7
- 0
README.md View File

@ -52,9 +52,16 @@ realm --zone ./domain.zone
By default `realm` binds to port `53`, which usually requires root, so you may need to run `sudo realm --zone ./domain.zone`. By default `realm` binds to port `53`, which usually requires root, so you may need to run `sudo realm --zone ./domain.zone`.
You can also specify any number of zone files by providing `--zone` multiple times:
```
realm --zone ./first.domain.zone --zone ./second.domain.zone
```
### Options ### Options
* `--zone, -z` - the file file to load (e.g. `./domain.zone`), this argument is required * `--zone, -z` - the file file to load (e.g. `./domain.zone`), this argument is required
* You may instead specify the environment variable `REALM_ZONE="./domain.zone"` * You may instead specify the environment variable `REALM_ZONE="./domain.zone"`
* You may specify `--zone` and `REALM_ZONE` multiple times
* `--bind, -b` - the `[<host>]:<port>` to bind the server to (e.g. `0.0.0.0:53`), default is `:53` * `--bind, -b` - the `[<host>]:<port>` to bind the server to (e.g. `0.0.0.0:53`), default is `:53`
* You may instead specify the environment variable `REALM_BIND=":53"` * You may instead specify the environment variable `REALM_BIND=":53"`
* `--help, -h` - show help message * `--help, -h` - show help message


+ 5
- 4
doc.go View File

@ -14,6 +14,7 @@ Realm will parse your server configuration from a DNS zone file see https://en.w
To start a server: To start a server:
realm --zone ./domain.zone realm --zone ./domain.zone
realm --zone ./first.domain.zone --zone ./second.domain.zone --bind "127.0.0.1:1053"
Full command usage: Full command usage:
@ -30,9 +31,9 @@ Full command usage:
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
GLOBAL OPTIONS: GLOBAL OPTIONS:
--zone, -z location to DNS zone file [required] [$REALM_ZONE]
--bind, -b ':53' '[<host>]:<port>' to bind too [$REALM_BIND]
--help, -h show help
--version, -v print the version
--zone, -z '--zone option --zone option' location to DNS zone file [required] [$REALM_ZONE]
--bind, -b ':53' '[<host>]:<port>' to bind too [$REALM_BIND]
--help, -h show help
--version, -v print the version
*/ */
package realm package realm

Loading…
Cancel
Save