README: add usage

master
Justin Riley 2016-10-07 15:27:11 -04:00
parent f9554f7f79
commit b4d64b327f
1 changed files with 31 additions and 0 deletions

View File

@ -1,2 +1,33 @@
# OneDNS
Dyanmic DNS for OpenNebula
## Usage
Global options:
```
$ onedns --help
usage: onedns [-h] [--debug] [-d DOMAIN] [--one-address ONE_ADDRESS]
[--one-secret ONE_SECRET] [--one-proxy ONE_PROXY]
{daemon,shell} ...
OneDNS - Dynamic DNS for OpenNebula
positional arguments:
{daemon,shell}
optional arguments:
-h, --help show this help message and exit
--debug ONE controller host address
-d DOMAIN, --domain DOMAIN
DNS domain to use
--one-address ONE_ADDRESS
ONE controller host address
--one-secret ONE_SECRET
ONE credentials to use (e.g. user:key)
--one-proxy ONE_PROXY
proxy host to use to connect to ONE controller
```
Run the `daemon` command to kick off onedns:
```
$ onedns daemon --dns-port=53
```