198 lines
4 KiB
Markdown
198 lines
4 KiB
Markdown
# pdns-console
|
|
|
|
PDNS-Console provided a CLI to manage PowerDNS application and improved it by adding a powerfull DNS zone versionning.
|
|
|
|
# Commands
|
|
|
|
## Available commands
|
|
|
|
### Helpers
|
|
|
|
```
|
|
about Show information about pdns-console
|
|
help Displays help for a command
|
|
list Lists commands
|
|
```
|
|
|
|
### Manage domains
|
|
|
|
```
|
|
domain:add Add a domain
|
|
domain:list List domains
|
|
domain:remove Remove a domain
|
|
```
|
|
|
|
### Manage zones
|
|
|
|
```
|
|
zone:add Add a zone
|
|
zone:assign Assign a zone to a domain.
|
|
zone:list List DNS zones
|
|
zone:push Push activated zones to PowerDNS tables
|
|
zone:record:add Add a zone record
|
|
zone:record:remove Remove a zone record
|
|
zone:remove Remove a zone
|
|
zone:unassign Unassign the domain zone
|
|
zone:version:active Active a zone version
|
|
zone:version:add Add a zone version
|
|
zone:version:copy Copy a zone version
|
|
zone:version:remove Remove an unactivated zone version
|
|
zone:version:unactive Active a zone version
|
|
```
|
|
|
|
### Example
|
|
|
|
#### Specifications
|
|
|
|
* We want to mange the domain *example.com*
|
|
* We need 3 records
|
|
* *example.com* -> 1.2.3.4
|
|
* *www.example.com* -> same as *example.com*
|
|
* *example.com* MX is mail.foo.net
|
|
|
|
#### Add the domain
|
|
|
|
```
|
|
$ ./app/console domain:add
|
|
Name: example.com
|
|
MASTER [null]:
|
|
Type [NATIVE]:
|
|
Domain added
|
|
```
|
|
|
|
```
|
|
$ ./app/console domain:list
|
|
DOMAIN: example.com
|
|
ID : 5
|
|
TYPE : NATIVE
|
|
MASTER:
|
|
```
|
|
|
|
### Create a zone
|
|
|
|
```
|
|
$ ./app/console zone:add
|
|
Name: Example zone
|
|
Description: My example zone
|
|
Zone added.
|
|
```
|
|
|
|
```
|
|
$ ./app/console zone:list
|
|
Example zone
|
|
------------
|
|
My example zone
|
|
ID: 4
|
|
|
|
No version found
|
|
```
|
|
|
|
```
|
|
$ ./app/console zone:version:add 4
|
|
Zone version added.
|
|
```
|
|
|
|
```
|
|
$ ./app/console zone:list
|
|
Example zone
|
|
------------
|
|
My example zone
|
|
ID: 4
|
|
|
|
Version: 1 - Active: No
|
|
|
|
No record found.
|
|
```
|
|
|
|
```
|
|
$ ./app/console zone:record:add 4 1
|
|
Name: @
|
|
Content: 1.2.3.4
|
|
|
|
Available types: A AAAA CNAME MX NS TXT SPF WKS SRV LOC SOA
|
|
Type: A
|
|
TTL: 3600
|
|
Prio [null]:
|
|
Zone record added.
|
|
```
|
|
|
|
```
|
|
$ ./app/console zone:record:add 4 1 --name www --type CNAME --content example.com. --ttl 3600 --prio null
|
|
Zone record added.
|
|
$ ./app/console zone:record:add 4 1 --name @ --type CNAME --content mail.foo.net. --ttl 3600 --prio 10
|
|
Zone record added.
|
|
```
|
|
|
|
```
|
|
$ ./app/console zone:list
|
|
Example zone
|
|
------------
|
|
My example zone
|
|
ID: 4
|
|
|
|
Version: 1 - Active: No
|
|
|
|
ID | NAME | TYPE | TTL | PRIO | CONTENT
|
|
----------------------------------------------------------------------
|
|
14 | @ | A | 3600 | | 1.2.3.4
|
|
15 | www | CNAME | 3600 | | example.com.
|
|
16 | @ | CNAME | 3600 | 10 | mail.foo.net.
|
|
```
|
|
|
|
|
|
# Installation
|
|
|
|
## Requirements
|
|
|
|
* PHP >= 5.4
|
|
* PDO with module for database connection
|
|
* Instance of PDNS (Powerdns) >= 3.1 with MySQL/PostgreSQL/SQLite backend
|
|
|
|
## Downloading sources
|
|
|
|
```shell
|
|
cd /usr/local/src/
|
|
git clone https://github.com/simmstein/pdns-console.git
|
|
cd pdns-console
|
|
```
|
|
|
|
### Dependances
|
|
|
|
```
|
|
curl -sS https://getcomposer.org/installer | php
|
|
./composer.phar install
|
|
```
|
|
|
|
### Database
|
|
|
|
#### Edit *propel.yaml*
|
|
|
|
* ```dsn: "mysql:host=localhost;dbname=pdns"```
|
|
* Change *localhost* with the database server name
|
|
* Change *pdns* with the database name
|
|
|
|
* Change user and password values with your pdsn database login
|
|
|
|
Run `./app/propel/console config:convert`
|
|
|
|
#### Models
|
|
|
|
The sources does not contain all application models. You have to generate them:
|
|
|
|
Run `./app/propel/console --recursive model:build`
|
|
|
|
#### Database updates
|
|
|
|
pdns-console needs to update pdns original tables and uses 3 more.
|
|
|
|
```shell
|
|
./app/propel/console --recursive migration:diff
|
|
./app/propel/console --recursive migration:migrate
|
|
```
|
|
|
|
## Symlink
|
|
|
|
To access the console without using the full path of `app/console`, make a symlink:
|
|
|
|
```ln -s $PWD/app/console /usr/local/bin/pdns-console```
|