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. The easiest way is to use Docker.
If you are looking to install and run PowerDNS-Admin directly onto your system check out the [Wiki](https://github.com/ngoduykhanh/PowerDNS-Admin/wiki#installation-guides) for ways to do that.

### Docker
This are two options to run PowerDNS-Admin using Docker.
To get started as quickly as possible try option 1. If you want to make modifications to the configuration option 2 may be cleaner.

#### Option 1: From Docker Hub
The easiest is to just run the latest Docker image from Docker Hub:
```
$ docker run -d \
    -v pda-data:/data
    -p 9191:80 \
    ngoduykhanh/powerdns-admin:latest
```
This creates a volume called `pda-data` to persist the SQLite database with the configuration.

#### Option 2: Using docker-compose
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-L46).
   To use the Docker secrets feature it is possible to append `_FILE` to the environment variables and point to a file with the values stored in it.

2. Start docker container
   ```
   $ docker-compose up
   ```

You can then access PowerDNS-Admin by pointing your browser to http://localhost:9191.

## Screenshots
![dashboard](https://user-images.githubusercontent.com/6447444/44068603-0d2d81f6-9fa5-11e8-83af-14e2ad79e370.png)

## LICENSE
MIT. See [LICENSE](https://github.com/ngoduykhanh/PowerDNS-Admin/blob/master/LICENSE)

## Support
If you like the project and want to support it, you can *buy me a coffee* ☕

<a href="https://www.buymeacoffee.com/khanhngo" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
Create README.md 2015-12-13 10:46:24 +00:00			`# PowerDNS-Admin`
Update README.md 2018-04-01 09:07:41 +00:00			`A PowerDNS web interface with advanced features.`
Update README.md 2018-09-07 07:58:16 +00:00
Update README.md 2018-04-02 06:45:44 +00: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 07:58:16 +00: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 10:46:24 +00:00
Update README.md 2015-12-13 11:07:10 +00:00			`#### Features:`
Update README.md 2015-12-13 11:07:59 +00:00			`- Multiple domain management`
Update README.md 2018-04-01 09:07:41 +00:00			`- Domain template`
Update README.md 2015-12-13 11:07:10 +00:00			`- User management`
Fix some spelling mistakes in README. Add supported version information. 2016-05-27 06:03:59 +00:00			`- User access management based on domain`
Update README.md 2015-12-13 11:07:10 +00:00			`- User activity logging`
Update README. Fix warning from PR #387 2018-10-26 01:43:25 +00:00			`- Support Local DB / SAML / LDAP / Active Directory user authentication`
Azure OAuth documentation and html templates 2019-12-05 00:52:30 +00:00			`- Support Google / Github / Azure / OpenID OAuth`
Update README.md 2018-04-01 09:07:41 +00:00			`- Support Two-factor authentication (TOTP)`
Update README.md 2015-12-13 11:07:10 +00:00			`- Dashboard and pdns service statistics`
Updated README to mention DynDNS 2 support 2016-06-21 22:22:02 +00:00			`- DynDNS 2 protocol support`
Add 'pretty IPv6 PTR' as a feature. 2016-08-19 23:28:59 +00:00			`- Edit IPv6 PTRs using IPv6 addresses directly (no more editing of literal addresses!)`
Update README and LGTM fixes 2019-12-08 11:23:36 +00:00			`- Limited API for manipulating zones and records`
Update README.md 2015-12-13 11:07:10 +00:00
Use sqlite by default in docker This allows for easy setup with no extra configuration. Also update docs to reflect the new and easy way to run PowerDNS-Admin. Signed-off-by: Felix Kaechele <felix@kaechele.ca> 2020-04-20 22:23:57 +00:00			`## Running PowerDNS-Admin`
			`There are several ways to run PowerDNS-Admin. The easiest way is to use Docker.`
			`If you are looking to install and run PowerDNS-Admin directly onto your system check out the [Wiki](https://github.com/ngoduykhanh/PowerDNS-Admin/wiki#installation-guides) for ways to do that.`

			`### Docker`
			`This are two options to run PowerDNS-Admin using Docker.`
			`To get started as quickly as possible try option 1. If you want to make modifications to the configuration option 2 may be cleaner.`

			`#### Option 1: From Docker Hub`
			`The easiest is to just run the latest Docker image from Docker Hub:`
			```
			`$ docker run -d \`
			`-v pda-data:/data`
			`-p 9191:80 \`
			`ngoduykhanh/powerdns-admin:latest`
			```
			This creates a volume called `pda-data` to persist the SQLite database with the configuration.

			`#### Option 2: Using docker-compose`
			`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-L46).`
			To use the Docker secrets feature it is possible to append `_FILE` to the environment variables and point to a file with the values stored in it.

			`2. Start docker container`
			```
			`$ docker-compose up`
			```

			`You can then access PowerDNS-Admin by pointing your browser to http://localhost:9191.`

			`## Screenshots`
Update README.md 2018-08-14 02:36:26 +00:00			`![dashboard](https://user-images.githubusercontent.com/6447444/44068603-0d2d81f6-9fa5-11e8-83af-14e2ad79e370.png)`
Update README.md 2020-05-17 07:37:15 +00:00
			`## LICENSE`
			`MIT. See [LICENSE](https://github.com/ngoduykhanh/PowerDNS-Admin/blob/master/LICENSE)`

			`## Support`
			`If you like the project and want to support it, you can buy me a coffee ☕`

			`<a href="https://www.buymeacoffee.com/khanhngo" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>`