Merge pull request #1434 from subbink/improve-psql-docs

PostgreSQL Support Improvement

configs/development.py

@@ -27,6 +27,7 @@ CAPTCHA_SESSION_KEY = 'captcha_image'
 SESSION_TYPE = 'sqlalchemy'
 
 ### DATABASE - MySQL
+## Don't forget to uncomment the import in the top
 #SQLALCHEMY_DATABASE_URI = 'mysql://{}:{}@{}/{}'.format(
 #    urllib.parse.quote_plus(SQLA_DB_USER),
 #    urllib.parse.quote_plus(SQLA_DB_PASSWORD),
@@ -34,6 +35,15 @@ SESSION_TYPE = 'sqlalchemy'
 #    SQLA_DB_NAME
 #)
 
+### DATABASE - PostgreSQL
+## Don't forget to uncomment the import in the top
+#SQLALCHEMY_DATABASE_URI = 'postgres://{}:{}@{}/{}'.format(
+#    urllib.parse.quote_plus(SQLA_DB_USER),
+#    urllib.parse.quote_plus(SQLA_DB_PASSWORD),
+#    SQLA_DB_HOST,
+#    SQLA_DB_NAME
+#)
+
 ### DATABASE - SQLite
 SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(basedir, 'pdns.db')
 

docker-test/Dockerfile

@@ -11,6 +11,7 @@ RUN apt-get update -y \
         libffi-dev \
         libldap2-dev \
         libmariadb-dev-compat \
+        libpq-dev \
         libsasl2-dev \
         libssl-dev \
         libxml2-dev \

docker/Dockerfile

@@ -2,6 +2,7 @@ FROM alpine:3.17 AS builder
 
 ARG BUILD_DEPENDENCIES="build-base \
     libffi-dev \
+    libpq-dev \
     libxml2-dev \
     mariadb-connector-c-dev \
     openldap-dev \

docs/wiki/database-setup/Setup-PostgreSQL.md

@@ -15,10 +15,9 @@ The below will create a database called powerdnsadmindb and a user of powerdnsad
 ```
 $ sudo su - postgres
 $ createuser powerdnsadmin
-$ createdb powerdnsadmindb
+$ createdb -E UTF8 -l en_US.UTF-8 -O powerdnsadmin -T template0 powerdnsadmindb 'The database for PowerDNS-Admin'
 $ psql
-postgres=# alter user powerdnsadmin with encrypted password 'powerdnsadmin';
+postgres=# ALTER ROLE powerdnsadmin WITH PASSWORD 'powerdnsadmin_password';
-postgres=# grant all privileges on database powerdnsadmindb to powerdnsadmin;
 ```
 
 Note:
@@ -51,18 +50,14 @@ On debian based systems these files are located in:
 
 ## Install required packages:
 ### Red-hat based systems:
+TODO: confirm this is correct
 ```
 sudo yum install postgresql-libs
 ```
 
 ### Debian based systems:
 ```
-apt install libpq-dev python-dev
+apt install python3-psycopg2
-```
-
-### Install python packages:
-```
-pip3 install psycopg2
 ```
 
 ## Known Issues:

docs/wiki/install/Running-PowerDNS-Admin-on-Ubuntu-or-Debian.md

@@ -7,19 +7,30 @@ First setup your database accordingly:
 
 ### Install required packages for building python libraries from requirements.txt file
 
+For Debian 11 (bullseye) and above:
 ```bash
-sudo apt install -y python3-dev git libsasl2-dev libldap2-dev libssl-dev libxml2-dev libxslt1-dev libxmlsec1-dev libffi-dev pkg-config apt-transport-https virtualenv build-essential curl
+sudo apt install -y python3-dev git libsasl2-dev libldap2-dev python3-venv libmariadb-dev pkg-config build-essential curl libpq-dev
+```
+Older systems might also need the following:
+```bash
+sudo apt install -y libssl-dev libxml2-dev libxslt1-dev libxmlsec1-dev libffi-dev apt-transport-https virtualenv
 ```
 
 ### Install NodeJs
 
 ```bash
-curl -sL https://deb.nodesource.com/setup_14.x | bash -
+curl -sL https://deb.nodesource.com/setup_14.x | sudo bash -
-apt install -y nodejs
+sudo apt install -y nodejs
 ```
 
 ### Install yarn to build asset files
-
+For Debian 11 (bullseye) and above:
+```bash
+curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | gpg --dearmor | sudo tee /usr/share/keyrings/yarnkey.gpg >/dev/null
+echo "deb [signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
+sudo apt update && sudo apt install -y yarn
+```
+For older Debian systems:
 ```bash
 sudo curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
 echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

requirements.txt

@@ -43,3 +43,4 @@ webcolors==1.12
 werkzeug==2.1.2
 zipp==3.11.0
 rcssmin==1.1.1
+psycopg2==2.9.5