yaPDNSui

Yet Another PowerDNS web interface

View project onGitHub

yapdnsui

Yet Another PowerDNS web interface

The ultimate goal is to produce a slick web interface to PowerDNS that will let you fully operate your PowerDNS instance via the official PowerDNS API.

The application should let you do add/delete/update domains and records as well as graph statistics and list/update configuration items LIVE from one or multiple PowerDNS instance via the PowerDNS API.

In addition, the application should let you manage DNSSEC zones and zone metadata.

It is not just another PowerDNS UI, it is the first to use the PowerDNS API, therefor to be backend-agnostic and DNSSEC aware.

Currently, you can list the configuration and see live statistics in a graph and list all the domains and records for demonstration purpose.

You can checkout the web interface using the live demo running on OpenShift cloud.

You are welcome to contribute.

yapdnsui_livestats

yapdnsui_config

yapdnsui_domains

yapdnsui_records

yapdnsui Prereqs

You need NodeJS v0.10.x+ for this application to work.

It might work with lower requirements but I didn't test.

PowerDNS Prereqs

Yes, you need a PowerDNS server.

It can be either an Authoritative or a Recursor to try this application out.

You need to enable the PowerDNS API on your PowerDNS instances.

For an Authoritative instance, configure as follows:

webserver=yes
webserver-address=127.0.0.1
webserver-port=8081
webserver-password=changeme
experimental-json-interface=yes
  • Restart
$ /etc/init.d/pdns restart
  • Test
$ curl -v http://a:changeme@localhost:8081/

Installing

  • Clone the repository
git clone https://github.com/xbgmsharp/yapdnsui
cd yapdnsui
  • Install dependencies
$ npm install
  • Start the application 
$ npm start

Or manually, you can define an IP and the PORT by using environment variables.

$ HOST=127.0.0.1 PORT=8080 DEBUG=yapdnsui node bin/www

Note : yaPDNSui use a sqlite memory database to store PowerDNS instances details. As an advantage, you don't need to configure anything outside of the webgui. However you need to add a PowerDNS instances to the configuration after each application start. You can access the PowerDNS server manage interface using the menu on the right.

Test using Docker

The Docker deb package are valid for Ubuntu and Debian.

$ wget http://get.docker.io/ -O - | sh

Or

echo deb https://get.docker.io/ubuntu docker main > /etc/apt/sources.list.d/docker.list
apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 36A1D7869245C8950F966E92D8576A8BA88D21E9
apt-get update && apt-get install -y lxc-docker
  • Build the images

The following command build the build directly from the github repository.

The build process might take some time a while as it download the origin nodejs docker image.

$ docker build --rm=true --no-cache=true -t xbgmsharp/yapdnsui github.com/xbgmsharp/yapdnsui.git

Alternatively, you can build the image localy after cloning the repository.

$ docker build --rm=true --no-cache=true -t xbgmsharp/yapdnsui .
  • Run the container

Run as a detach container

$ docker run -d -p 22:22 -p 8080:8080 -t xbgmsharp/yapdnsui

Or run the container with an attach shell

$ docker run -i --rm -p 22:22 -p 8080:8080 -t xbgmsharp/yapdnsui /bin/bash
  • Check the IP
$ docker ps -a
$ docker inspect CONTAINER_ID | grep IPA

Or both command in one

$ docker ps -a | grep yapdnsui  | awk '{print $1}' | xargs docker inspect | grep IPAddress

Or all in one with the ssh connection

$ ssh $(docker ps -a | grep yapdnsui  | awk '{print $1}' | xargs docker inspect | grep IPAddress | awk '{print $2}' | tr -d '"' | tr -d ',' )
  • Login in the container via SSH

User is root and password is admin.

$ ssh root@172.17.0.x
  • Review logs
$ docker logs CONTAINER_ID
  yapdnsui Express server listening on port 8080 +0ms

If the application crash. The container exit. From a SSH shell, you can restart the application. You can fillup an issue and add the backtrace or you fix it.

Secure yapdnsui

For security reasons, you may want to run a webserver (like Apache or nginx) in front of your PowerDNS webserver as a reverse proxy using SSL. As a best pratice, it is recommended to apply use SSL for the traffic between the end-user and the application.

You can read this HOWTO to see how.

For security reasons, you probably want to use the same webserver for authentication purpose.

You can read this mod_auth_ldap - Apache HTTP Server

E.g. you might want use a SSL connection and authenticate your co-workers using the internal LDAP or database server of your company intranet.

Contributing to yapdnsui

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Use a specific branch for your changes (one bonus point if it's prefixed with 'feature/')
  • write tests, doc, commit and push until you are happy with your contribution
  • Send a pull request
  • Please try not to mess with the package, version, or history

License

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program comes without any warranty.

Credits