From 10f5bb7dc147917ec9f614fcf7adc6a87aee3817 Mon Sep 17 00:00:00 2001 From: Matt Scott Date: Sun, 26 Feb 2023 03:47:28 -0500 Subject: [PATCH] Updated project README to include a refreshed feature list. Also updated project README Docker deployment instructions to reference the latest stable release version on Docker Hub. Updated project license to include updated management organization references. --- LICENSE | 1 + README.md | 62 +++++++++++++++++++++++++++++++++++-------------------- 2 files changed, 41 insertions(+), 22 deletions(-) diff --git a/LICENSE b/LICENSE index 6f51774..8375c2e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,7 @@ The MIT License (MIT) Copyright (c) 2016 Khanh Ngo - ngokhanhit[at]gmail.com +Copyright (c) 2022 Azorian Solutions - legal[at]azorian.solutions Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ce12f62..61e4df0 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,65 @@ # PowerDNS-Admin + A PowerDNS web interface with advanced features. [![CodeQL](https://github.com/PowerDNS-Admin/PowerDNS-Admin/actions/workflows/codeql-analysis.yml/badge.svg?branch=master)](https://github.com/PowerDNS-Admin/PowerDNS-Admin/actions/workflows/codeql-analysis.yml) [![Docker Image](https://github.com/PowerDNS-Admin/PowerDNS-Admin/actions/workflows/build-and-publish.yml/badge.svg?branch=master)](https://github.com/PowerDNS-Admin/PowerDNS-Admin/actions/workflows/build-and-publish.yml) #### 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 + +- Provides forward and reverse zone management +- Provides zone templating features +- Provides user management with role based access control +- Provides zone specific access control +- Provides activity logging +- Authentication: + - Local User Support + - SAML Support + - LDAP Support: OpenLDAP / Active Directory + - OAuth Support: Google / GitHub / Azure / OpenID +- Two-factor authentication support (TOTP) +- PDNS Service Configuration & Statistics Monitoring - DynDNS 2 protocol support -- Edit IPv6 PTRs using IPv6 addresses directly (no more editing of literal addresses!) -- Limited API for manipulating zones and records -- Full IDN/Punycode support +- Easy IPv6 PTR record editing +- Provides an API for zone and record management among other features +- Provides full IDN/Punycode support ## 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/PowerDNS-Admin/PowerDNS-Admin/wiki#installation-guides) for ways to do that. + +There are several ways to run PowerDNS-Admin. The quickest 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/PowerDNS-Admin/PowerDNS-Admin/wiki#installation-guides) for ways to do that. ### Docker + Here 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. +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: + +To run the application using the latest stable release on Docker Hub, run the following command: + ``` $ docker run -d \ -e SECRET_KEY='a-very-secret-key' \ -v pda-data:/data \ -p 9191:80 \ - powerdnsadmin/pda-legacy:latest + powerdnsadmin/pda-legacy:v0.3.0 ``` -This creates a volume called `pda-data` to persist the SQLite database with the configuration. + +This creates a volume named `pda-data` to persist the default SQLite database with app 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/PowerDNS-Admin/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. - Make sure to set the environment variable `SECRET_KEY` to a long random string (https://flask.palletsprojects.com/en/1.1.x/config/#SECRET_KEY) + Other environment variables are mentioned in + the [legal_envvars](https://github.com/PowerDNS-Admin/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. + Make sure to set the environment variable `SECRET_KEY` to a long random + string (https://flask.palletsprojects.com/en/1.1.x/config/#SECRET_KEY) 2. Start docker container ``` @@ -53,8 +69,10 @@ This creates a volume called `pda-data` to persist the SQLite database with the 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/PowerDNS-Admin/PowerDNS-Admin/blob/master/LICENSE) +This project is released under the MIT license. For additional +information, [see here](https://github.com/PowerDNS-Admin/PowerDNS-Admin/blob/master/LICENSE)