diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md deleted file mode 100644 index 7902a97..0000000 --- a/docs/wiki/Home.md +++ /dev/null @@ -1,22 +0,0 @@ -Welcome to the PowerDNS-Admin wiki! - -## Preparation guides -- [Prepare MySQL or MariaDB Database for PowerDNS-Admin](Prepare-MySQL-or-MariaDB-Database-for-PowerDNS-Admin) -- [Using PowerDNS-Admin with PostgreSQL](Using-PowerDNS-Admin-with-PostgreSQL) - -## Installation guides -- [Running PowerDNS Admin on Ubuntu or Debian](Running-PowerDNS-Admin-on-Ubuntu-or-Debian) -- [Running PowerDNS-Admin in Centos 7](Running-PowerDNS-Admin-on-Centos-7) -- [Running PowerDNS-Admin in Fedora 30](Running-PowerDNS-Admin-on-Fedora-30) -- [Running PowerDNS-Admin on FreeBSD 12.1-RELEASE](Running-on-FreeBSD) - -## Web Server configuration -- [Supervisord](Supervisord-example) -- [Systemd](Systemd-example) -- [Systemd + Gunicorn + Nginx](Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx) -- [Systemd + Gunicorn + Apache](Running-PowerDNS-Admin-with-Systemd,-Gunicorn-and-Apache) -- [uWSGI](uWSGI-example) -- [WSGI-Apache](WSGI-Apache-example) - -## Feature usage -- [DynDNS2](https://github.com/ngoduykhanh/PowerDNS-Admin/wiki/DynDNS2) \ No newline at end of file diff --git a/docs/wiki/Install-PowerDNS-Admin-in-Fedora-23.md b/docs/wiki/Install-PowerDNS-Admin-in-Fedora-23.md deleted file mode 100644 index 7f876ff..0000000 --- a/docs/wiki/Install-PowerDNS-Admin-in-Fedora-23.md +++ /dev/null @@ -1 +0,0 @@ -Please refer to CentOS guide: https://github.com/ngoduykhanh/PowerDNS-Admin/wiki/Running-PowerDNS-Admin-on-Centos-7 \ No newline at end of file diff --git a/docs/wiki/README.md b/docs/wiki/README.md new file mode 100644 index 0000000..8010cc1 --- /dev/null +++ b/docs/wiki/README.md @@ -0,0 +1,23 @@ +# Welcome to the PowerDNS-Admin wiki! + +## Preparation guides +- [Prepare MySQL or MariaDB Database for PowerDNS-Admin](preparation/Prepare-MySQL-or-MariaDB-Database-for-PowerDNS-Admin.md) +- [Using PowerDNS-Admin with PostgreSQL](preparation/Using-PowerDNS-Admin-with-PostgreSQL.md) + +## Installation guides +- [Running PowerDNS Admin on Ubuntu or Debian](install/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md) +- [Running PowerDNS-Admin on Centos 7](install/Running-PowerDNS-Admin-on-Centos-7.md) +- [Running PowerDNS-Admin on Fedora 23](install/Running-PowerDNS-Admin-on-Fedora-23.md) +- [Running PowerDNS-Admin on Fedora 30](install/Running-PowerDNS-Admin-on-Fedora-30.md) +- [Running PowerDNS-Admin on FreeBSD 12.1-RELEASE](install/Running-on-FreeBSD.md) + +## Web Server configuration +- [Supervisord](web-server/Supervisord-example.md) +- [Systemd](web-server/Systemd-example.md) +- [Systemd + Gunicorn + Nginx](web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx.md) +- [Systemd + Gunicorn + Apache](web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn-and-Apache.md) +- [uWSGI](web-server/uWSGI-example.md) +- [WSGI-Apache](web-server/WSGI-Apache-example.md) + +## Feature usage +- [DynDNS2](features/DynDNS2.md) \ No newline at end of file diff --git a/docs/wiki/Running-PowerDNS-Admin-as-a-service-(Systemd).md b/docs/wiki/Running-PowerDNS-Admin-as-a-service-(Systemd).md index df01179..f693736 100644 --- a/docs/wiki/Running-PowerDNS-Admin-as-a-service-(Systemd).md +++ b/docs/wiki/Running-PowerDNS-Admin-as-a-service-(Systemd).md @@ -1,6 +1,6 @@ *** -**WARNING** -This just uses the development server for testing purposes. For production environments you should probably go with a more robust solution, like [gunicorn](https://github.com/ngoduykhanh/PowerDNS-Admin/wiki/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx) or a WSGI server. +**WARNING** +This just uses the development server for testing purposes. For production environments you should probably go with a more robust solution, like [gunicorn](web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx.md) or a WSGI server. *** ### Following example shows a systemd unit file that can run PowerDNS-Admin diff --git a/docs/wiki/DynDNS2.md b/docs/wiki/features/DynDNS2.md similarity index 99% rename from docs/wiki/DynDNS2.md rename to docs/wiki/features/DynDNS2.md index 2fbd9ae..b599727 100644 --- a/docs/wiki/DynDNS2.md +++ b/docs/wiki/features/DynDNS2.md @@ -3,6 +3,7 @@ IPv4: http://user:pass@yournameserver.yoursite.tld/nic/update?hostname=record.do IPv6: http://user:pass@yournameserver.yoursite.tld/nic/update?hostname=record.domain.tld&myip=::1 Multiple IPs: http://user:pass@yournameserver.yoursite.tld/nic/update?hostname=record.domain.tld&myip=127.0.0.1,127.0.0.2,::1,::2 +Notes: - user needs to be a LOCAL user, not LDAP etc - user must have already logged-in - user needs to be added to Domain Access Control list of domain.tld - admin status (manage all) does not suffice diff --git a/docs/wiki/Running-PowerDNS-Admin-on-Centos-7.md b/docs/wiki/install/Running-PowerDNS-Admin-on-Centos-7.md similarity index 97% rename from docs/wiki/Running-PowerDNS-Admin-on-Centos-7.md rename to docs/wiki/install/Running-PowerDNS-Admin-on-Centos-7.md index e61485a..18d57f6 100644 --- a/docs/wiki/Running-PowerDNS-Admin-on-Centos-7.md +++ b/docs/wiki/install/Running-PowerDNS-Admin-on-Centos-7.md @@ -57,7 +57,7 @@ yum install yarn NOTE: Please adjust `/opt/web/powerdns-admin` to your local web application directory ``` -git clone https://github.com/ngoduykhanh/PowerDNS-Admin.git /opt/web/powerdns-admin +git clone https://github.com/PowerDNS-Admin/PowerDNS-Admin.git /opt/web/powerdns-admin cd /opt/web/powerdns-admin virtualenv -p python3 flask ``` diff --git a/docs/wiki/install/Running-PowerDNS-Admin-on-Fedora-23.md b/docs/wiki/install/Running-PowerDNS-Admin-on-Fedora-23.md new file mode 100644 index 0000000..ca84460 --- /dev/null +++ b/docs/wiki/install/Running-PowerDNS-Admin-on-Fedora-23.md @@ -0,0 +1 @@ +Please refer to CentOS guide: [Running-PowerDNS-Admin-on-Centos-7](Running-PowerDNS-Admin-on-Centos-7.md) \ No newline at end of file diff --git a/docs/wiki/Running-PowerDNS-Admin-on-Fedora-30.md b/docs/wiki/install/Running-PowerDNS-Admin-on-Fedora-30.md similarity index 90% rename from docs/wiki/Running-PowerDNS-Admin-on-Fedora-30.md rename to docs/wiki/install/Running-PowerDNS-Admin-on-Fedora-30.md index e3b23ea..51b705c 100644 --- a/docs/wiki/Running-PowerDNS-Admin-on-Fedora-30.md +++ b/docs/wiki/install/Running-PowerDNS-Admin-on-Fedora-30.md @@ -36,7 +36,7 @@ npm install yarn -g ## Clone the PowerDNS-Admin repository to the installation path: ```bash cd /opt/web/ -git clone https://github.com/ngoduykhanh/PowerDNS-Admin.git powerdns-admin +git clone https://github.com/PowerDNS-Admin/PowerDNS-Admin.git powerdns-admin ``` **Prepare the Virtual Environment:** @@ -80,4 +80,4 @@ Open your web browser and access to `http://localhost:9191` to visit PowerDNS-Ad At the first time you login into the PDA UI, you will be redirected to setting page to configure the PDNS API information. _**Note:**_ For production environment, i recommend to run PowerDNS-Admin with WSGI over Apache instead of flask's built-in web server... - Take a look at [WSGI Apache Example](https://github.com/ngoduykhanh/PowerDNS-Admin/wiki/WSGI-Apache-example#fedora) WIKI page to see how to configure it. \ No newline at end of file + Take a look at [WSGI Apache Example](web-server/WSGI-Apache-example#fedora) WIKI page to see how to configure it. \ No newline at end of file diff --git a/docs/wiki/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md b/docs/wiki/install/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md similarity index 92% rename from docs/wiki/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md rename to docs/wiki/install/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md index 1cdda78..acc5858 100644 --- a/docs/wiki/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md +++ b/docs/wiki/install/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md @@ -44,7 +44,7 @@ sudo apt install -y yarn _**Note:**_ Please adjust `/opt/web/powerdns-admin` to your local web application directory ```bash -git clone https://github.com/ngoduykhanh/PowerDNS-Admin.git /opt/web/powerdns-admin +git clone https://github.com/PowerDNS-Admin/PowerDNS-Admin.git /opt/web/powerdns-admin cd /opt/web/powerdns-admin python3 -mvenv ./venv ``` @@ -91,4 +91,4 @@ Now you can run PowerDNS-Admin by command Open your web browser and go to `http://localhost:9191` to visit PowerDNS-Admin web interface. Register a user. The first user will be in the Administrator role. -This is good for testing, but for production usage, you should use gunicorn or uwsgi. See [Running PowerDNS Admin with Systemd, Gunicorn and Nginx](https://github.com/ngoduykhanh/PowerDNS-Admin/wiki/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx) for instructions. \ No newline at end of file +This is good for testing, but for production usage, you should use gunicorn or uwsgi. See [Running PowerDNS Admin with Systemd, Gunicorn and Nginx](web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx) for instructions. \ No newline at end of file diff --git a/docs/wiki/Running-on-FreeBSD.md b/docs/wiki/install/Running-on-FreeBSD.md similarity index 93% rename from docs/wiki/Running-on-FreeBSD.md rename to docs/wiki/install/Running-on-FreeBSD.md index 76a8f5b..b37e9c3 100644 --- a/docs/wiki/Running-on-FreeBSD.md +++ b/docs/wiki/install/Running-on-FreeBSD.md @@ -17,7 +17,7 @@ sudo pkg install libxml2 libxslt pkgconf py37-xmlsec py37-cffi py37-ldap _**Note:**_ Please adjust `/opt/powerdns-admin` to your local web application directory ```bash -git clone https://github.com/ngoduykhanh/PowerDNS-Admin.git /opt/powerdns-admin +git clone https://github.com/PowerDNS-Admin/PowerDNS-Admin.git /opt/powerdns-admin cd /opt/powerdns-admin ``` @@ -97,6 +97,6 @@ Open your web browser and go to `http://localhost:9191` to visit PowerDNS-Admin ### Running at startup -This is good for testing, but for production usage, you should use gunicorn or uwsgi. See [Running PowerDNS Admin with Systemd, Gunicorn and Nginx](https://github.com/ngoduykhanh/PowerDNS-Admin/wiki/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx) for instructions. +This is good for testing, but for production usage, you should use gunicorn or uwsgi. See [Running PowerDNS Admin with Systemd, Gunicorn and Nginx](../web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx.md) for instructions. The right approach long-term is to create a startup script in `/usr/local/etc/rc.d` and enable it through `/etc/rc.conf`. \ No newline at end of file diff --git a/docs/wiki/Prepare-MySQL-or-MariaDB-Database-for-PowerDNS-Admin.md b/docs/wiki/preparation/Prepare-MySQL-or-MariaDB-Database-for-PowerDNS-Admin.md similarity index 100% rename from docs/wiki/Prepare-MySQL-or-MariaDB-Database-for-PowerDNS-Admin.md rename to docs/wiki/preparation/Prepare-MySQL-or-MariaDB-Database-for-PowerDNS-Admin.md diff --git a/docs/wiki/Using-PowerDNS-Admin-with-PostgreSQL.md b/docs/wiki/preparation/Using-PowerDNS-Admin-with-PostgreSQL.md similarity index 100% rename from docs/wiki/Using-PowerDNS-Admin-with-PostgreSQL.md rename to docs/wiki/preparation/Using-PowerDNS-Admin-with-PostgreSQL.md diff --git a/docs/wiki/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx.md b/docs/wiki/web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx.md similarity index 100% rename from docs/wiki/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx.md rename to docs/wiki/web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn--and--Nginx.md diff --git a/docs/wiki/Running-PowerDNS-Admin-with-Systemd,-Gunicorn-and-Apache.md b/docs/wiki/web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn-and-Apache.md similarity index 100% rename from docs/wiki/Running-PowerDNS-Admin-with-Systemd,-Gunicorn-and-Apache.md rename to docs/wiki/web-server/Running-PowerDNS-Admin-with-Systemd,-Gunicorn-and-Apache.md diff --git a/docs/wiki/Supervisord-example.md b/docs/wiki/web-server/Supervisord-example.md similarity index 100% rename from docs/wiki/Supervisord-example.md rename to docs/wiki/web-server/Supervisord-example.md diff --git a/docs/wiki/Systemd-example.md b/docs/wiki/web-server/Systemd-example.md similarity index 100% rename from docs/wiki/Systemd-example.md rename to docs/wiki/web-server/Systemd-example.md diff --git a/docs/wiki/WSGI-Apache-example.md b/docs/wiki/web-server/WSGI-Apache-example.md similarity index 100% rename from docs/wiki/WSGI-Apache-example.md rename to docs/wiki/web-server/WSGI-Apache-example.md diff --git a/docs/wiki/uWSGI-example.md b/docs/wiki/web-server/uWSGI-example.md similarity index 85% rename from docs/wiki/uWSGI-example.md rename to docs/wiki/web-server/uWSGI-example.md index d50455d..db15d03 100644 --- a/docs/wiki/uWSGI-example.md +++ b/docs/wiki/web-server/uWSGI-example.md @@ -1,11 +1,18 @@ +# uWSGI Example + This guide will show you how to run PowerDNS-Admin via uWSGI and nginx. This guide was written using Debian 8 with the following software versions: - nginx 1.6.2 - uwsgi 2.0.7-debian - python 2.7.9 -`sudo apt-get install uwsgi uwsgi-plugin-python nginx` +## Software installation: -### Step-by-step instructions +1. apt install the following packages: + - `uwsgi` + - `uwsgi-plugin-python` + - `nginx` + +## Step-by-step instructions 1. Create a uWSGI .ini in `/etc/uwsgi/apps-enabled` with the following contents, making sure to replace the chdir, pythonpath and virtualenv directories with where you've installed PowerDNS-Admin: ```ini [uwsgi]