PowerDNS-Admin/README.md

# PowerDNS-Admin
A PowerDNS web interface with advanced features.

[![Build Status](https://travis-ci.org/ngoduykhanh/PowerDNS-Admin.svg?branch=master)](https://travis-ci.org/ngoduykhanh/PowerDNS-Admin)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/ngoduykhanh/PowerDNS-Admin.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ngoduykhanh/PowerDNS-Admin/context:python)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ngoduykhanh/PowerDNS-Admin.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ngoduykhanh/PowerDNS-Admin/context:javascript)

#### Features:
- Multiple domain management
- Domain template
- User management
- User access management based on domain
- User activity logging
- Support Local DB / SAML / LDAP / Active Directory user authentication
- Support Google / Github / Azure / OpenID OAuth
- Support Two-factor authentication (TOTP)
- Dashboard and pdns service statistics
- DynDNS 2 protocol support
- Edit IPv6 PTRs using IPv6 addresses directly (no more editing of literal addresses!)
- Limited API for manipulating zones and records

### Running PowerDNS-Admin
There are several ways to run PowerDNS-Admin. Following is a simple way to start PowerDNS-Admin using Docker

Step 1: Update the configuration

Edit the `docker-compose.yml` file to update the database connection string in `SQLALCHEMY_DATABASE_URI`. Other environment variables are mentioned in the [legal_envvars](https://github.com/ngoduykhanh/PowerDNS-Admin/blob/master/configs/docker_config.py#L5-L37).

Step 2: Start docker container

```$ docker-compose up```

You can now access PowerDNS-Admin at url http://localhost:9191

**NOTE:** For other methods to run PowerDNS-Admin, please take look at WIKI pages.

### Screenshots
![dashboard](https://user-images.githubusercontent.com/6447444/44068603-0d2d81f6-9fa5-11e8-83af-14e2ad79e370.png)
Create README.md 2015-12-13 11:46:24 +01:00			`# PowerDNS-Admin`
Update README.md 2018-04-01 11:07:41 +02:00			`A PowerDNS web interface with advanced features.`
Update README.md 2018-09-07 09:58:16 +02:00
Update README.md 2018-04-02 08:45:44 +02:00			`[![Build Status](https://travis-ci.org/ngoduykhanh/PowerDNS-Admin.svg?branch=master)](https://travis-ci.org/ngoduykhanh/PowerDNS-Admin)`
Update README.md 2018-09-07 09:58:16 +02:00			`[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/ngoduykhanh/PowerDNS-Admin.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ngoduykhanh/PowerDNS-Admin/context:python)`
			`[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ngoduykhanh/PowerDNS-Admin.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ngoduykhanh/PowerDNS-Admin/context:javascript)`
Create README.md 2015-12-13 11:46:24 +01:00
Update README.md 2015-12-13 12:07:10 +01:00			`#### Features:`
Update README.md 2015-12-13 12:07:59 +01:00			`- Multiple domain management`
Update README.md 2018-04-01 11:07:41 +02:00			`- Domain template`
Update README.md 2015-12-13 12:07:10 +01:00			`- User management`
Fix some spelling mistakes in README. Add supported version information. 2016-05-27 08:03:59 +02:00			`- User access management based on domain`
Update README.md 2015-12-13 12:07:10 +01:00			`- User activity logging`
Update README. Fix warning from PR #387 2018-10-26 03:43:25 +02:00			`- Support Local DB / SAML / LDAP / Active Directory user authentication`
Azure OAuth documentation and html templates 2019-12-05 01:52:30 +01:00			`- Support Google / Github / Azure / OpenID OAuth`
Update README.md 2018-04-01 11:07:41 +02:00			`- Support Two-factor authentication (TOTP)`
Update README.md 2015-12-13 12:07:10 +01:00			`- Dashboard and pdns service statistics`
Updated README to mention DynDNS 2 support 2016-06-22 00:22:02 +02:00			`- DynDNS 2 protocol support`
Add 'pretty IPv6 PTR' as a feature. 2016-08-20 01:28:59 +02:00			`- Edit IPv6 PTRs using IPv6 addresses directly (no more editing of literal addresses!)`
Update README and LGTM fixes 2019-12-08 12:23:36 +01:00			`- Limited API for manipulating zones and records`
Update README.md 2015-12-13 12:07:10 +01:00
Update README.md 2018-04-01 11:07:41 +02:00			`### Running PowerDNS-Admin`
Fix the tests Fix the tests Fix the tests 2019-12-06 04:32:57 +01:00			`There are several ways to run PowerDNS-Admin. Following is a simple way to start PowerDNS-Admin using Docker`
Create README.md 2015-12-13 11:46:24 +01:00
Update README and LGTM fixes 2019-12-08 12:23:36 +01:00			`Step 1: Update the configuration`
Update README.md 2018-08-14 04:36:26 +02:00
Update README and LGTM fixes 2019-12-08 12:23:36 +01:00			Edit the `docker-compose.yml` file to update the database connection string in `SQLALCHEMY_DATABASE_URI`. Other environment variables are mentioned in the [legal_envvars](https://github.com/ngoduykhanh/PowerDNS-Admin/blob/master/configs/docker_config.py#L5-L37).
Update README.md 2018-04-01 11:10:07 +02:00
Update README and LGTM fixes 2019-12-08 12:23:36 +01:00			`Step 2: Start docker container`
Update README.md 2018-04-01 11:10:07 +02:00
Editing README 2018-04-18 05:31:00 +02:00			```$ docker-compose up```
Create README.md 2015-12-13 11:46:24 +01:00
Update README.md 2018-04-01 11:07:41 +02:00			`You can now access PowerDNS-Admin at url http://localhost:9191`
Create README.md 2015-12-13 11:46:24 +01:00
Editing README 2018-04-18 05:31:00 +02:00			`NOTE: For other methods to run PowerDNS-Admin, please take look at WIKI pages.`
Update README.md 2015-12-13 11:58:26 +01:00
Update docker stuff and bug fixes 2019-12-04 05:50:46 +01:00			`### Screenshots`
Update README.md 2018-08-14 04:36:26 +02:00			`![dashboard](https://user-images.githubusercontent.com/6447444/44068603-0d2d81f6-9fa5-11e8-83af-14e2ad79e370.png)`