Update version for release.

refs #6334

.dockerignore

@@ -0,0 +1,8 @@
+.git
+web/node_modules
+web/*.log
+web/regression
+web/**/tests/
+.DS_Store
+web/pgadmin/messages.pot
+web/pgadmin/translations/??/LC_MESSAGES/messages.po

.gitignore

@@ -19,11 +19,12 @@
 /redhat-build
 /src-build
 /win-build
+/win-temp
 _build
 /build-*
 pgadmin4.log
 pkg/win32/installer.iss
-pkg/mac/codesign.conf
+pkg/mac/codesign.confx
 pkg/mac/framework.conf
 runtime/.qmake.cache
 runtime/.qmake.stash
@@ -51,4 +52,8 @@ auditjs.html
 auditpy.txt
 /venv/
 .scannerwork/
-web/coverage/
+web/coverage/
+web/.coverage
+web/regression/.coverage
+web/regression/covhtml/
+web/regression/htmlcov/

Dockerfile

@@ -12,19 +12,22 @@
 # and clean up the web/ source code
 #########################################################################
 
-FROM node:12-alpine3.11 AS app-builder
+FROM alpine:3.13 AS app-builder
 
 RUN apk add --no-cache \
     autoconf \
     automake \
     bash \
     g++ \
+    git \
     libc6-compat \
     libjpeg-turbo-dev \
     libpng-dev \
+    libtool \
     make \
     nasm \
-    git \
+    nodejs \
+    yarn \
     zlib-dev
 
 # Create the /pgadmin4 directory and copy the source into it. Explicitly
@@ -41,15 +44,8 @@ RUN rm -rf /pgadmin4/web/*.log \
 WORKDIR /pgadmin4/web
 
 # Build the JS vendor code in the app-builder, and then remove the vendor source.
-RUN npm install && \
-	npm audit fix && \
-	rm -f yarn.lock && \
-	yarn import && \
-# Commented the below line to avoid vulnerability in lodash package.
-# Refer https://www.npmjs.com/advisories/1523.
-# Once fixed we will uncomment it.
-#	yarn audit && \
-	rm -f package-lock.json && \
+RUN export CPPFLAGS="-DPNG_ARM_NEON_OPT=0" && \
+    yarn install && \
     yarn run bundle && \
     rm -rf node_modules \
            yarn.lock \
@@ -60,28 +56,39 @@ RUN npm install && \
            karma.conf.js \
            ./pgadmin/static/js/generated/.cache
 
+#########################################################################
+# Next, create the base environment for Python
+#########################################################################
+
+FROM alpine:3.13 as env-builder
+
+# Install dependencies
+COPY requirements.txt /
+RUN     apk add --no-cache \
+        make \
+        python3 \
+        py3-pip && \
+    apk add --no-cache --virtual build-deps \
+        build-base \
+        openssl-dev \
+        libffi-dev \
+        postgresql-dev \
+        krb5-dev \
+        rust \
+        cargo \
+        python3-dev && \
+    python3 -m venv --system-site-packages --without-pip /venv && \
+    /venv/bin/python3 -m pip install --no-cache-dir -r requirements.txt && \
+    apk del --no-cache build-deps
+
 #########################################################################
 # Now, create a documentation build container for the Sphinx docs
 #########################################################################
 
-FROM python:3.8-alpine3.11 as docs-builder
+FROM env-builder as docs-builder
 
-# Install only dependencies absolutely required for documentation building
-RUN apk add --no-cache \
-        make \
-        build-base \
-        openssl-dev \
-        libffi-dev && \
-    pip install --no-cache-dir \
-        sphinx \
-        flask_security_too \
-        flask_paranoid \
-        python-dateutil \
-        flask_sqlalchemy \
-        flask_gravatar \
-        flask_migrate \
-        simplejson \
-        cryptography
+# Install Sphinx
+RUN /venv/bin/python3 -m pip install --no-cache-dir sphinx
 
 # Copy the docs from the local tree. Explicitly remove any existing builds that
 # may be present
@@ -90,26 +97,26 @@ COPY web /pgadmin4/web
 RUN rm -rf /pgadmin4/docs/en_US/_build
 
 # Build the docs
-RUN LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 make -C /pgadmin4/docs/en_US -f Makefile.sphinx html
+RUN LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 /venv/bin/sphinx-build /pgadmin4/docs/en_US /pgadmin4/docs/en_US/_build/html
+
+# Cleanup unwanted files
+RUN rm -rf /pgadmin4/docs/en_US/_build/html/.doctrees
+RUN rm -rf /pgadmin4/docs/en_US/_build/html/_sources
+RUN rm -rf /pgadmin4/docs/en_US/_build/html/_static/*.png
 
 #########################################################################
 # Create additional builders to get all of the PostgreSQL utilities
 #########################################################################
 
-FROM postgres:9.5-alpine as pg95-builder
 FROM postgres:9.6-alpine as pg96-builder
 FROM postgres:10-alpine as pg10-builder
 FROM postgres:11-alpine as pg11-builder
 FROM postgres:12-alpine as pg12-builder
+FROM postgres:13-alpine as pg13-builder
 
-FROM alpine:3.11 as tool-builder
+FROM alpine:3.13 as tool-builder
 
 # Copy the PG binaries
-COPY --from=pg95-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-9.5/
-COPY --from=pg95-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-9.5/
-COPY --from=pg95-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-9.5/
-COPY --from=pg95-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-9.5/
-
 COPY --from=pg96-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-9.6/
 COPY --from=pg96-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-9.6/
 COPY --from=pg96-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-9.6/
@@ -130,12 +137,21 @@ COPY --from=pg12-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-12/
 COPY --from=pg12-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-12/
 COPY --from=pg12-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-12/
 
+COPY --from=pg13-builder /usr/local/bin/pg_dump /usr/local/pgsql/pgsql-13/
+COPY --from=pg13-builder /usr/local/bin/pg_dumpall /usr/local/pgsql/pgsql-13/
+COPY --from=pg13-builder /usr/local/bin/pg_restore /usr/local/pgsql/pgsql-13/
+COPY --from=pg13-builder /usr/local/bin/psql /usr/local/pgsql/pgsql-13/
+
 #########################################################################
 # Assemble everything into the final container.
 #########################################################################
 
-FROM python:3.8-alpine3.11
+FROM alpine:3.13
 
+# Copy in the Python packages
+COPY --from=env-builder /venv /venv
+
+# Copy in the tools
 COPY --from=tool-builder /usr/local/pgsql /usr/local/
 
 WORKDIR /pgadmin4
@@ -144,53 +160,36 @@ ENV PYTHONPATH=/pgadmin4
 # Copy in the code and docs
 COPY --from=app-builder /pgadmin4/web /pgadmin4
 COPY --from=docs-builder /pgadmin4/docs/en_US/_build/html/ /pgadmin4/docs
-COPY requirements.txt /pgadmin4/requirements.txt
+COPY pkg/docker/run_pgadmin.py /pgadmin4
+COPY pkg/docker/gunicorn_config.py /pgadmin4
+COPY pkg/docker/entrypoint.sh /entrypoint.sh
 
 # License files
 COPY LICENSE /pgadmin4/LICENSE
 COPY DEPENDENCIES /pgadmin4/DEPENDENCIES
 
-# Install build-dependencies, build & install C extensions and purge deps in
-# one RUN step
-RUN apk add --no-cache --virtual \
-        build-deps \
-        build-base \
-        postgresql-dev \
-        libffi-dev \
-        linux-headers && \
-    apk add \
+# Install runtime dependencies and configure everything in one RUN step
+RUN apk add \
+        python3 \
+        py3-pip \
         postfix \
-        postgresql-client \
         postgresql-libs \
+        krb5-libs \
         shadow \
         sudo \
+        libedit \
         libcap && \
-    pip install --upgrade pip && \
-    pip install --no-cache-dir -r requirements.txt && \
-    pip install --no-cache-dir gunicorn==19.9.0 && \
-    apk del --no-cache build-deps && \
-    echo "pgadmin ALL = NOPASSWD: /usr/sbin/postfix start" > /etc/sudoers.d/postfix
-
-# We need the v12 libpq, which is only in the 'edge' build of Alpine at present
-COPY --from=pg12-builder /usr/local/lib/libpq.so.5.12 /usr/lib/
-RUN ln -sf /usr/lib/libpq.so.5.12 /usr/lib/libpq.so.5
-
-# Copy the runner script
-COPY pkg/docker/run_pgadmin.py /pgadmin4
-COPY pkg/docker/entrypoint.sh /entrypoint.sh
-
-# Precompile and optimize python code to save time and space on startup
-RUN python -O -m compileall -x node_modules /pgadmin4
-
-RUN groupadd -g 5050 pgadmin && \
+    /venv/bin/python3 -m pip install --no-cache-dir gunicorn && \
+    find / -type d -name '__pycache__' -exec rm -rf {} + && \
+    groupadd -g 5050 pgadmin && \
     useradd -r -u 5050 -g pgadmin pgadmin && \
     mkdir -p /var/lib/pgadmin && \
     chown pgadmin:pgadmin /var/lib/pgadmin && \
-    mkdir -p /var/log/pgadmin && \
-    chown pgadmin:pgadmin /var/log/pgadmin && \
     touch /pgadmin4/config_distro.py && \
     chown pgadmin:pgadmin /pgadmin4/config_distro.py && \
-    setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/python3.8
+    setcap CAP_NET_BIND_SERVICE=+eip /usr/bin/python3.8 && \
+    echo "pgadmin ALL = NOPASSWD: /usr/sbin/postfix start" > /etc/sudoers.d/postfix
+
 USER pgadmin
 
 # Finish up

LICENSE

@@ -1,6 +1,6 @@
 pgAdmin 4
 
-Copyright (C) 2013 - 2020, The pgAdmin Development Team
+Copyright (C) 2013 - 2021, The pgAdmin Development Team
 
 Permission to use, copy, modify, and distribute this software and its
 documentation for any purpose, without fee, and without a written agreement is

Make.bat

@@ -3,6 +3,7 @@ SETLOCAL
 
 SET WD=%CD%
 SET "BUILDROOT=%WD%\win-build"
+SET "TMPDIR=%WD%\win-temp"
 SET "DISTROOT=%WD%\dist"
 
 SET CMDOPTIONS=""
@@ -18,19 +19,13 @@ IF "%1" == "clean" (
     EXIT /B %ERRORLEVEL%
 )
 
-set "ARCHITECTURE=x64"
-if "%Platform%" == "X86" (
-    set "ARCHITECTURE=x86"
-)
-
 REM Main build sequence
 CALL :SET_ENVIRONMENT
 CALL :VALIDATE_ENVIRONMENT || EXIT /B 1
 CALL :CLEAN || EXIT /B 1
 CALL :CREATE_VIRTUAL_ENV || EXIT /B 1
-CALL :CREATE_RUNTIME_ENV || EXIT /B 1
 CALL :CREATE_PYTHON_ENV || EXIT /B 1
-CALL :CLEANUP_ENV || EXIT /B 1
+CALL :CREATE_RUNTIME_ENV || EXIT /B 1
 CALL :CREATE_INSTALLER || EXIT /B 1
 CALL :SIGN_INSTALLER || EXIT /B 1
 
@@ -42,7 +37,10 @@ REM Main build sequence Ends
     ECHO Removing build directory...
     IF EXIST "%BUILDROOT%" RD "%BUILDROOT%" /S /Q > nul || EXIT /B 1
 
-    ECHO Removing temp build directory...
+    ECHO Removing tmp directory...
+    IF EXIST "%TMPDIR%" RD "%TMPDIR%" /S /Q > nul || EXIT /B 1
+
+    ECHO Removing installer build directory...
     IF EXIST "%WD%\pkg\win32\Output" rd "%WD%\pkg\win32\Output" /S /Q > nul || EXIT /B 1
 
     ECHO Removing installer configuration script...
@@ -54,14 +52,14 @@ REM Main build sequence Ends
 :SET_ENVIRONMENT
     ECHO Configuring the environment...
     IF "%PGADMIN_PYTHON_DIR%" == ""   SET "PGADMIN_PYTHON_DIR=C:\Python38"
-    IF "%PGADMIN_QT_DIR%" == ""       SET "PGADMIN_QT_DIR=C:\Qt\5.14.2\msvc2017_64"
+    IF "%PGADMIN_KRB5_DIR%" == ""     SET "PGADMIN_KRB5_DIR=C:\Program Files\MIT\Kerberos"
     IF "%PGADMIN_POSTGRES_DIR%" == "" SET "PGADMIN_POSTGRES_DIR=C:\Program Files (x86)\PostgreSQL\12"
     IF "%PGADMIN_INNOTOOL_DIR%" == "" SET "PGADMIN_INNOTOOL_DIR=C:\Program Files (x86)\Inno Setup 6"
     IF "%PGADMIN_VCREDIST_DIR%" == "" SET "PGADMIN_VCREDIST_DIR=C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\VC\Redist\MSVC\14.16.27012"
     IF "%PGADMIN_SIGNTOOL_DIR%" == "" SET "PGADMIN_SIGNTOOL_DIR=C:\Program Files (x86)\Windows Kits\10\bin\10.0.17763.0\x64"
 
     REM Set REDIST_NAME (the filename)
-    set "VCREDIST_FILE=vcredist_%ARCHITECTURE%.exe"
+    set "VCREDIST_FILE=vcredist_x64.exe"
 
     REM Set additional variables we need
     FOR /F "tokens=3" %%a IN ('findstr /C:"APP_RELEASE =" %WD%\web\config.py')  DO SET APP_MAJOR=%%a
@@ -73,13 +71,13 @@ REM Main build sequence Ends
     FOR /F "tokens=2* DELims='" %%a IN ('findstr /C:"APP_NAME =" web\config.py') DO SET APP_NAME=%%a
     FOR /f "tokens=1 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "print('%APP_NAME%'.lower().replace(' ', ''))"') DO SET APP_SHORTNAME=%%G
     SET APP_VERSION=%APP_MAJOR%.%APP_MINOR%
-    SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-%APP_VERSION_SUFFIX%-%ARCHITECTURE%.exe
-    IF "%APP_VERSION_SUFFIX%" == "" SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-%ARCHITECTURE%.exe
+    SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-%APP_VERSION_SUFFIX%-x64.exe
+    IF "%APP_VERSION_SUFFIX%" == "" SET INSTALLERNAME=%APP_SHORTNAME%-%APP_MAJOR%.%APP_MINOR%-x64.exe
 
-    REM get Python version for the runtime build ex. 2.7.1 will be 27
+    REM get Python version for the runtime build ex. 3.9.2 will be 39
     FOR /f "tokens=1 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MAJOR=%%G
     FOR /f "tokens=2 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_MINOR=%%G
-    SET "PYTHON_VERSION=%PYTHON_MAJOR%%PYTHON_MINOR%"
+    FOR /f "tokens=3 DELims=." %%G IN ('%PGADMIN_PYTHON_DIR%/python.exe -c "import sys; print(sys.version.split(' ')[0])"') DO SET PYTHON_REVISION=%%G
 
     EXIT /B 0
 
@@ -93,10 +91,9 @@ REM Main build sequence Ends
     ECHO Installer name:            %INSTALLERNAME%
     ECHO.
     ECHO Python directory:          %PGADMIN_PYTHON_DIR%
-    ECHO Python DLL:                %PGADMIN_PYTHON_DIR%\Python%PYTHON_VERSION%.dll
-    ECHO Python version:            %PYTHON_MAJOR%.%PYTHON_MINOR%
+    ECHO Python version:            %PYTHON_MAJOR%.%PYTHON_MINOR%.%PYTHON_REVISION%
     ECHO.
-    ECHO Qt directory:              %PGADMIN_QT_DIR%
+    ECHO KRB5 directory:            %PGADMIN_KRB5_DIR%
     ECHO PostgreSQL directory:      %PGADMIN_POSTGRES_DIR%
     ECHO.
     ECHO VC++ redist directory:     %PGADMIN_VCREDIST_DIR%
@@ -123,15 +120,9 @@ REM Main build sequence Ends
         EXIT /B 1
     )
 
-    IF NOT EXIST "%PGADMIN_QT_DIR%" (
-        ECHO !PGADMIN_QT_DIR! does not exist.
-        ECHO Please install Qt and set the PGADMIN_QT_DIR environment variable.
-        EXIT /B 1
-    )
-
-    IF NOT EXIST "%PGADMIN_QT_DIR%\bin\qmake.exe" (
-        ECHO !QMAKE! does not exist.
-        ECHO Please install Qt and set the PGADMIN_QT_DIR environment variable.
+    IF NOT EXIST "%PGADMIN_KRB5_DIR%" (
+        ECHO !PGADMIN_KRB5_DIR! does not exist.
+        ECHO Please install MIT Kerberos for Windows and set the PGADMIN_KRB5_DIR environment variable.
         EXIT /B 1
     )
 
@@ -141,12 +132,6 @@ REM Main build sequence Ends
         EXIT /B 1
     )
 
-    IF NOT EXIST "%PGADMIN_PYTHON_DIR%\Python%PYTHON_VERSION%.dll" (
-        ECHO !PGADMIN_PYTHON_DIR!\Python!PYTHON_VERSION!.dll does not exist.
-        ECHO Please check your Python installation is complete.
-        EXIT /B 1
-    )
-
     IF NOT EXIST "%PGADMIN_POSTGRES_DIR%" (
         ECHO !PGADMIN_POSTGRES_DIR! does not exist.
         ECHO Please install PostgreSQL and set the PGADMIN_POSTGRES_DIR environment variable.
@@ -166,47 +151,75 @@ REM Main build sequence Ends
 
 :CREATE_VIRTUAL_ENV
     ECHO Creating virtual environment...
-    IF NOT EXIST "%BUILDROOT%"  MKDIR "%BUILDROOT%"
-    
-    CD "%BUILDROOT%"
+    IF NOT EXIST "%TMPDIR%"  MKDIR "%TMPDIR%"
+
+    CD "%TMPDIR%"
 
     REM Note that we must use virtualenv.exe here, as the venv module doesn't allow python.exe to relocate.
     "%PGADMIN_PYTHON_DIR%\Scripts\virtualenv.exe" venv
 
-    XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\DLLs" "%BUILDROOT%\venv\DLLs" > nul || EXIT /B 1
-    XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\Lib" "%BUILDROOT%\venv\Lib" > nul || EXIT /B 1
+    XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\DLLs" "%TMPDIR%\venv\DLLs" > nul || EXIT /B 1
+    XCOPY /S /I /E /H /Y "%PGADMIN_PYTHON_DIR%\Lib" "%TMPDIR%\venv\Lib" > nul || EXIT /B 1
 
-    ECHO Activating virtual environment -  %BUILDROOT%\venv...
-    CALL "%BUILDROOT%\venv\Scripts\activate" || EXIT /B 1
+    ECHO Activating virtual environment -  %TMPDIR%\venv...
+    CALL "%TMPDIR%\venv\Scripts\activate" || EXIT /B 1
 
     ECHO Installing dependencies...
-    CALL pip install -r "%WD%\requirements.txt" || EXIT /B 1
-    CALL pip install sphinx || EXIT /B 1
-
-    REM If this is Python 3.6+, we need to remove the hack above or it will break qmake. Sigh.
-    IF %PYTHON_VERSION% GEQ 36 SET CL=
+    CALL python -m pip install --upgrade pip || EXIT /B 1
+    CALL pip install --only-binary=cryptography -r "%WD%\requirements.txt" || EXIT /B 1
 
     CD %WD%
     EXIT /B 0
 
 
+:CREATE_PYTHON_ENV
+    ECHO Staging Python...
+    MKDIR "%BUILDROOT%\python\Lib" || EXIT /B 1
+
+    ECHO Downloading embedded Python...
+    REM Get the python embeddable and extract it to %BUILDROOT%\python
+    CD "%TMPDIR%
+    %PGADMIN_PYTHON_DIR%\python -c "import sys; from urllib.request import urlretrieve; urlretrieve('https://www.python.org/ftp/python/' + sys.version.split(' ')[0] + '/python-' + sys.version.split(' ')[0] + '-embed-amd64.zip', 'python-embedded.zip')" || EXIT /B 1
+    %PGADMIN_PYTHON_DIR%\python -c "import zipfile; z = zipfile.ZipFile('python-embedded.zip', 'r'); z.extractall('../win-build/python/')" || EXIT /B 1
+
+    ECHO Copying site-packages...
+    XCOPY /S /I /E /H /Y "%TMPDIR%\venv\Lib\site-packages" "%BUILDROOT%\python\Lib\site-packages" > nul || EXIT /B 1
+
+    REM NOTE: There is intentionally no space after "site" in the line below, to prevent Python barfing if there's one in the file
+    ECHO import site>> "%BUILDROOT%\python\python%PYTHON_MAJOR%%PYTHON_MINOR%._pth"
+
+    ECHO Staging Kerberos components...
+    COPY "%PGADMIN_KRB5_DIR%\bin\kinit.exe" "%BUILDROOT%\python" > nul || EXIT /B 1
+    COPY "%PGADMIN_KRB5_DIR%\bin\krb5_64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
+    COPY "%PGADMIN_KRB5_DIR%\bin\comerr64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
+    COPY "%PGADMIN_KRB5_DIR%\bin\k5sprt64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
+    COPY "%PGADMIN_KRB5_DIR%\bin\gssapi64.dll" "%BUILDROOT%\python" > nul || EXIT /B 1
+
+    ECHO Cleaning up unnecessary .pyc and .pyo files...
+    FOR /R "%BUILDROOT%\python" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
+    ECHO Removing tests...
+    FOR /R "%BUILDROOT%\python\Lib" %%f in (test tests) do RD /Q /S "%%f" 1> nul 2>&1
+
+    EXIT /B 0
+
+
 :CREATE_RUNTIME_ENV
+    IF NOT EXIST "%BUILDROOT%"  MKDIR "%BUILDROOT%"
     MKDIR "%BUILDROOT%\runtime"
 
-    CD "%WD%\web"
-
-    ECHO Installing javascript dependencies...
-    CALL yarn install || EXIT /B 1
-
-    ECHO Bundling javascript...
-    CALL yarn run bundle || EXIT /B 1
-
     ECHO Removing webpack caches...
     RD /Q /S "%WD%\web\pgadmin\static\js\generated\.cache" 1> nul 2>&1
 
     ECHO Copying web directory...
     XCOPY /S /I /E /H /Y "%WD%\web" "%BUILDROOT%\web" > nul || EXIT /B 1
 
+    ECHO Installing javascript dependencies...
+    CD "%BUILDROOT%\web"
+    CALL yarn install || EXIT /B 1
+
+    ECHO Bundling javascript...
+    CALL yarn run bundle || EXIT /B 1
+
     ECHO Cleaning up unnecessary .pyc and .pyo files...
     FOR /R "%BUILDROOT%\web" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
     ECHO Removing tests, Python caches and node modules...
@@ -232,51 +245,59 @@ REM Main build sequence Ends
     ECHO } >> "%BUILDROOT%\web\config_distro.py"
 
     ECHO Building docs...
+    CALL pip install sphinx || EXIT /B 1
     MKDIR "%BUILDROOT%\docs\en_US\html"
     CD "%WD%\docs\en_US"
-    CALL "%BUILDROOT%\venv\Scripts\python.exe" build_code_snippet.py || EXIT /B 1
-    CALL "%BUILDROOT%\venv\Scripts\sphinx-build.exe"   "%WD%\docs\en_US" "%BUILDROOT%\docs\en_US\html" || EXIT /B 1
+    CALL "%TMPDIR%\venv\Scripts\python.exe" build_code_snippet.py || EXIT /B 1
+    CALL "%TMPDIR%\venv\Scripts\sphinx-build.exe" "%WD%\docs\en_US" "%BUILDROOT%\docs\en_US\html" || EXIT /B 1
 
-    ECHO Removing Sphinx
-    CALL pip uninstall -y sphinx Pygments alabaster colorama docutils imagesize requests snowballstemmer
+    REM Remove unnecessary doc files
+    DEL /q "%BUILDROOT%\docs\en_US\html\_static\*.png" 1> nul 2>&1
+    RD /Q /S "%BUILDROOT%\docs\en_US\html\_sources" 1> nul 2>&1
 
-    ECHO Assembling runtime environment...
-    CD "%WD%\runtime"
+    ECHO Staging runtime components...
+    XCOPY /S /I /E /H /Y "%WD%\runtime\assets" "%BUILDROOT%\runtime\assets" > nul || EXIT /B 1
+    XCOPY /S /I /E /H /Y "%WD%\runtime\src" "%BUILDROOT%\runtime\src" > nul || EXIT /B 1
 
-    ECHO Running qmake...
-    CALL set "PGADMIN_PYTHON_DIR=%PGADMIN_PYTHON_DIR%" && "%PGADMIN_QT_DIR%\bin\qmake.exe" || EXIT /B 1
+    COPY "%WD%\runtime\package.json" "%BUILDROOT%\runtime\" > nul || EXIT /B 1
+    CD "%BUILDROOT%\runtime\"
+    CALL yarn install --production=true || EXIT /B 1
 
-    ECHO Cleaning the build directory...
-    CALL nmake clean || EXIT /B 1
+    ECHO Downloading NWjs to %TMPDIR%...
+    REM Get a fresh copy of nwjs.
+    REM NOTE: The nw download servers seem to be very unreliable, so at the moment we're using wget which retries
 
-    ECHO Running make...
-    CALL nmake || EXIT /B 1
+    REM YARN
+    REM CALL yarn --cwd "%TMPDIR%" add nw || EXIT /B
+    REM YARN END
 
-    ECHO Staging pgAdmin4.exe...
-    COPY "%WD%\runtime\release\pgAdmin4.exe" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    REM WGET
+    FOR /f "tokens=2 delims='" %%i IN ('yarn info nw ^| findstr "latest: "') DO SET "NW_VERSION=%%i"
+    :GET_NW
+        wget https://dl.nwjs.io/v%NW_VERSION%/nwjs-v%NW_VERSION%-win-x64.zip -O "%TMPDIR%\nwjs-v%NW_VERSION%-win-x64.zip"
+        IF %ERRORLEVEL% NEQ 0 GOTO GET_NW
 
-    ECHO Staging Qt components...
-    COPY "%PGADMIN_QT_DIR%\bin\Qt5Core.dll"   "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    COPY "%PGADMIN_QT_DIR%\bin\Qt5Gui.dll"    "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    COPY "%PGADMIN_QT_DIR%\bin\Qt5Widgets.dll" "%BUILDROOT%\runtime" > nul  || EXIT /B 1
-    COPY "%PGADMIN_QT_DIR%\bin\Qt5Network.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    COPY "%PGADMIN_QT_DIR%\bin\Qt5Svg.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    MKDIR "%BUILDROOT%\runtime\platforms" > nul || EXIT /B 1
-    COPY "%PGADMIN_QT_DIR%\plugins\platforms\qwindows.dll" "%BUILDROOT%\runtime\platforms" > nul || EXIT /B 1
-    MKDIR "%BUILDROOT%\runtime\imageformats" > nul || EXIT /B 1
-    COPY "%PGADMIN_QT_DIR%\plugins\imageformats\qsvg.dll" "%BUILDROOT%\runtime\imageformats" > nul || EXIT /B 1
-    ECHO [Paths] > "%BUILDROOT%\runtime\qt.conf"
-    ECHO Plugins=plugins >> "%BUILDROOT%\runtime\qt.conf"
+    tar -C "%TMPDIR%" -xvf "%TMPDIR%\nwjs-v%NW_VERSION%-win-x64.zip" || EXIT /B 1
+    REM WGET END
+
+    REM YARN
+    REM XCOPY /S /I /E /H /Y "%TMPDIR%\node_modules\nw\nwjs\*" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    REM YARN END
+
+    REM WGET
+    XCOPY /S /I /E /H /Y "%TMPDIR%\nwjs-v%NW_VERSION%-win-x64\*" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    REM WGET END
+
+    MOVE "%BUILDROOT%\runtime\nw.exe" "%BUILDROOT%\runtime\pgAdmin4.exe"
+
+    ECHO Replacing executable icon...
+    CALL yarn --cwd "%TMPDIR%" add winresourcer || EXIT /B
+    "%TMPDIR%\node_modules\winresourcer\bin\Resourcer.exe" -op:upd -src:"%BUILDROOT%\runtime\pgAdmin4.exe" -type:Icongroup -name:IDR_MAINFRAME -file:"%WD%\pkg\win32\Resources\pgAdmin4.ico"
 
     ECHO Staging PostgreSQL components...
     COPY "%PGADMIN_POSTGRES_DIR%\bin\libpq.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    IF "%ARCHITECTURE%" == "x64" (
-        COPY "%PGADMIN_POSTGRES_DIR%\bin\libcrypto-1_1-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
-        COPY "%PGADMIN_POSTGRES_DIR%\bin\libssl-1_1-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    ) ELSE (
-        COPY "%PGADMIN_POSTGRES_DIR%\bin\libcrypto-1_1.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
-        COPY "%PGADMIN_POSTGRES_DIR%\bin\libssl-1_1.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    )
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\libcrypto-1_1-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
+    COPY "%PGADMIN_POSTGRES_DIR%\bin\libssl-1_1-x64.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
     IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\libintl-*.dll" "%BUILDROOT%\runtime" > nul
     IF EXIST "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" COPY "%PGADMIN_POSTGRES_DIR%\bin\libiconv-*.dll" "%BUILDROOT%\runtime" > nul
     COPY "%PGADMIN_POSTGRES_DIR%\bin\zlib.dll" "%BUILDROOT%\runtime" > nul || EXIT /B 1
@@ -291,22 +312,6 @@ REM Main build sequence Ends
 
     CD %WD%
     EXIT /B 0
-    
-
-:CREATE_PYTHON_ENV
-    ECHO Staging Python...
-    COPY %PGADMIN_PYTHON_DIR%\python%PYTHON_VERSION%.dll "%BUILDROOT%\runtime"  > nul || EXIT /B 1
-    COPY %PGADMIN_PYTHON_DIR%\python.exe "%BUILDROOT%\runtime" > nul || EXIT /B 1
-    COPY %PGADMIN_PYTHON_DIR%\pythonw.exe "%BUILDROOT%\runtime" > nul || EXIT /B 1
-
-    ECHO Cleaning up unnecessary .pyc and .pyo files...
-    FOR /R "%BUILDROOT%\venv" %%f in (*.pyc *.pyo) do DEL /q "%%f" 1> nul 2>&1
-    ECHO Removing tests...
-    FOR /R "%BUILDROOT%\venv\Lib" %%f in (test tests) do RD /Q /S "%%f" 1> nul 2>&1
-    ECHO Removing TCL...
-    RD /Q /S "%BUILDROOT%\venv\tcl" 1> nul 2>&1
-
-    EXIT /B 0
 
 
 :CREATE_INSTALLER
@@ -319,16 +324,9 @@ REM Main build sequence Ends
     CD "%WD%\pkg\win32"
 
     ECHO Processing installer configuration script...
-    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in" "-o" "%WD%\pkg\win32\installer.iss.in_stage1" "-s" MYAPP_NAME -r """%APP_NAME%"""
-    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage1" "-o" "%WD%\pkg\win32\installer.iss.in_stage2" "-s" MYAPP_FULLVERSION -r """%APP_VERSION%"""
-    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage2" "-o" "%WD%\pkg\win32\installer.iss.in_stage3" "-s" MYAPP_VERSION -r """v%APP_MAJOR%"""
-
-    SET ARCMODE=
-    IF "%ARCHITECTURE%" == "x64" (
-        set ARCMODE="x64"
-    )
-    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage3" "-o" "%WD%\pkg\win32\installer.iss.in_stage4" "-s" MYAPP_ARCHITECTURESMODE -r """%ARCMODE%"""
-    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage4" "-o" "%WD%\pkg\win32\installer.iss" "-s" MYAPP_VCDIST -r """%PGADMIN_VCREDIST_DIRNAME%\%VCREDIST_FILE%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in" "-o" "%WD%\pkg\win32\installer.iss.in_stage1" "-s" MYAPP_FULLVERSION -r """%APP_VERSION%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage1" "-o" "%WD%\pkg\win32\installer.iss.in_stage2" "-s" MYAPP_VERSION -r """v%APP_MAJOR%"""
+    CALL "%PGADMIN_PYTHON_DIR%\python" "%WD%\pkg\win32\replace.py" "-i" "%WD%\pkg\win32\installer.iss.in_stage2" "-o" "%WD%\pkg\win32\installer.iss" "-s" MYAPP_VCDIST -r """%PGADMIN_VCREDIST_DIRNAME%\%VCREDIST_FILE%"""
 
     ECHO Cleaning up...
     DEL /s "%WD%\pkg\win32\installer.iss.in_stage*" > nul
@@ -337,7 +335,7 @@ REM Main build sequence Ends
     CALL "%PGADMIN_INNOTOOL_DIR%\ISCC.exe" /q "%WD%\pkg\win32\installer.iss" || EXIT /B 1
 
     ECHO Renaming installer...
-    MOVE "%WD%\pkg\win32\Output\Setup.exe" "%DISTROOT%\%INSTALLERNAME%" > nul || EXIT /B 1
+    MOVE "%WD%\pkg\win32\Output\pgadmin4-setup.exe" "%DISTROOT%\%INSTALLERNAME%" > nul || EXIT /B 1
 
     ECHO Location - %DISTROOT%\%INSTALLERNAME%
     ECHO Installer generated successfully.
@@ -348,7 +346,7 @@ REM Main build sequence Ends
 
 :SIGN_INSTALLER
     ECHO Attempting to sign the installer...
-    CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" sign  /t http://timestamp.verisign.com/scripts/timstamp.dll "%DISTROOT%\%INSTALLERNAME%"
+    CALL "%PGADMIN_SIGNTOOL_DIR%\signtool.exe" sign /t http://time.certum.pl "%DISTROOT%\%INSTALLERNAME%"
     IF %ERRORLEVEL% NEQ 0 (
         ECHO.
         ECHO ************************************************************
@@ -360,14 +358,6 @@ REM Main build sequence Ends
     EXIT /B 0
 
 
-:CLEANUP_ENV
-    ECHO Cleaning the build environment...
-    RD "%BUILDROOT%\venv\Include" /S /Q 1> nul 2>&1
-    DEL /s "%BUILDROOT%\venv\pip-selfcheck.json" 1> nul 2>&1
-
-    EXIT /B 0
-
-
 :USAGE
     ECHO Invalid command line options.
     ECHO Usage: "Make.bat [clean]"

Makefile

@@ -20,7 +20,7 @@ APP_REVISION := $(shell grep ^APP_REVISION web/config.py | awk -F"=" '{print $$N
 # Include only platform-independent builds in all
 all: docs pip src runtime
 
-appbundle: docs
+appbundle:
 	./pkg/mac/build.sh
 
 install-node:

README

@@ -1,321 +0,0 @@
-pgAdmin 4 
-=========
-
-pgAdmin 4 is a rewrite of the popular pgAdmin3 management tool for the
-PostgreSQL (http://www.postgresql.org) database. 
-
-In the following documentation and examples, "$PGADMIN4_SRC/" is used to denote
-the top-level directory of a copy of the pgAdmin source tree, either from a
-tarball or a git checkout.
-
-Architecture
-------------
-
-pgAdmin 4 is written as a web application in Python, using jQuery and Bootstrap
-for the client side processing and UI. On the server side, Flask is being
-utilised.
-
-Although developed using web technologies, pgAdmin 4 can be deployed either on
-a web server using a browser, or standalone on a workstation. The runtime/
-subdirectory contains a QT based runtime application intended to allow this -
-it is essentially a Python application server that runs in the system tray
-and allows the user to connect to the application using their web browser.
-
-Building the Runtime
---------------------
-
-To build the runtime, the following packages must be installed:
-
-- QT 5 (Use the VC++ build on Windows, not MinGW).
-- Python 3.4+
-
-An environment variable named PGADMIN_PYTHON_DIR must be set to the directory
-in which Python has been installed, for example:
-
-- /usr
-- /usr/local/python-3.8
-- C:\Python38
-
-Assuming both qmake is in the path:
-
-  dpage@hal:~/git/pgadmin4$ cd runtime
-  dpage@hal:~/git/pgadmin4/runtime$ export PGADMIN_PYTHON_DIR=/opt/local
-  dpage@hal:~/git/pgadmin4/runtime$ qmake
-  Project MESSAGE: ==================================
-  Project MESSAGE: Configuring the pgAdmin 4 runtime.
-  Project MESSAGE: ==================================
-  Project MESSAGE: Qt version: 5
-  Project MESSAGE: Platform: macOS
-  Project MESSAGE: Python executable: /opt/local/bin/python3
-  Project MESSAGE: Python version: 3.8 (38)
-  Project MESSAGE: Python config: /opt/local/bin/python3-config
-  Project MESSAGE: CXXFLAGS: -pipe -stdlib=libc++ -I/opt/local/Library/Frameworks/Python.framework/Versions/3.8/include/python3.8 -I/opt/local/Library/Frameworks/Python.framework/Versions/3.8/include/python3.8
-  Project MESSAGE: LDFLAGS: -stdlib=libc++ -L/opt/local/Library/Frameworks/Python.framework/Versions/3.8/lib/python3.8/config-3.8-darwin -ldl -framework CoreFoundation
-  Project MESSAGE: LIBS: -lpython3.8 -ldl -framework CoreFoundation
-  dpage@hal:~/git/pgadmin4/runtime$ make
-  ...
-
-To build the runtime in debug mode, use the option below with qmake:
-$ qmake CONFIG+=debug
-
-To build the runtime in release mode, use the option below with qmake:
-$ qmake CONFIG+=release
-
-By default, the runtime application will be built in release mode.
-
-On Linux, an executable called 'pgAdmin4' will be built, on Windows,
-'pgAdmin4.exe', and on Mac OS X, an app bundle called pgAdmin4.app will be
-created.
-
-You can also use Qt Creator to build, develop and debug the runtime. Simply
-open the $PGADMIN4_SRC/runtime/pgAdmin4.pro project file in Qt Creator and
-configure the project with a supported version of Qt when prompted.
-
-Create Database Migrations
---------------------------
-
-In order to make changes to the SQLite DB, navigate to the 'web' directory:
-
-(pgadmin4) $ cd $PGADMIN4_SRC/web
-
-Create a migration file with the following command:
-
-(pgadmin4) $ FLASK_APP=pgAdmin4.py flask db revision
-
-This will create a file in: $PGADMIN4_SRC/web/migrations/versions/ .
-Add any changes to the 'upgrade' function.
-Increment the SCHEMA_VERSION in $PGADMIN4_SRC/web/pgadmin/model/__init__.py file.
-
-There is no need to increment the SETTINGS_SCHEMA_VERSION.
-
-Configuring the Python Environment
-----------------------------------
-
-In order to run the Python code, a suitable runtime environment is required.
-Python version 3.4 and later are currently supported. It is recommended that a
-Python Virtual Environment is setup for this purpose, rather than using the
-system Python environment. On Linux and Mac systems, the process is fairly
-simple - adapt as required for your distribution:
-
-1) Install the virtualenv packages into the system Python environment
-
-    $ sudo pip install virtualenv virtualenvwrapper
-
-2) Source the virtualenv wrapper tools script. You may want to add this command
-   to your ~/.bash_profile file for future convenience:
-
-    $ source /usr/local/bin/virtualenvwrapper.sh
-
-3) Create a virtual environment:
-
-    $ mkvirtualenv pgadmin4
-
-   To make use of the virtual environment in the future, use the following
-   command to re-activate it:
-
-    $ workon pgadmin4
-
-4) Ensure that a PostgreSQL installation's bin/ directory is in the path (so
-   pg_config can be found for building psycopg2), and install the required
-   packages:
-
-    (pgadmin4) $ PATH=$PATH:/usr/local/pgsql/bin pip install -r $PGADMIN4_SRC/requirements.txt
-
-   If you are planning to run the regression tests, you also need to install
-   additional requirements from web/regression/requirements.txt:
-
-   (pgadmin4) $ pip install -r $PGADMIN4_SRC/web/regression/requirements.txt
-
-5) Create a local configuration file for pgAdmin. Edit
-   $PGADMIN4_SRC/web/config_local.py and add any desired configuration options
-   (use the config.py file as a reference - any settings duplicated in
-   config_local.py will override those in config.py). A typical development
-   configuration may look like:
-
-    from config import *
-
-    # Debug mode
-    DEBUG = True
-
-    # App mode
-    SERVER_MODE = True
-
-    # Enable the test module
-    MODULE_BLACKLIST.remove('test')
-
-    # Log
-    CONSOLE_LOG_LEVEL = DEBUG
-    FILE_LOG_LEVEL = DEBUG
-
-    DEFAULT_SERVER = '127.0.0.1'
-
-    UPGRADE_CHECK_ENABLED = True
-
-    # Use a different config DB for each server mode.
-    if SERVER_MODE == False:
-        SQLITE_PATH = os.path.join(
-            DATA_DIR,
-            'pgadmin4-desktop.db'
-        )
-    else:
-        SQLITE_PATH = os.path.join(
-            DATA_DIR,
-            'pgadmin4-server.db'
-        )
-
-   This configuration allows easy switching between server and desktop modes
-   for testing.
-
-6) The initial setup of the configuration database is interactive in server
-   mode,  and non-interactive in desktop mode. You can run it either by
-   running:
-
-    (pgadmin4) $ python $PGADMIN4_SRC/web/setup.py
-
-   or by starting pgAdmin 4:
-
-    (pgadmin4) $ python $PGADMIN4_SRC/web/pgAdmin4.py
-
-   Whilst it is possible to automatically run setup in desktop mode by running
-   the runtime, that will not work in server mode as the runtime doesn't allow
-   command line interaction with the setup program.
-
-At this point you will be able to run pgAdmin 4 from the command line in either
-server or desktop mode, and access it from a web browser using the URL shown in
-the terminal once pgAdmin has started up.
-
-Setup of an environment on Windows is somewhat more complicated unfortunately,
-please see pkg/win32/README.txt for complete details.
-
-Once a virtual environment has been created and enabled, setup can continue
-from step 4 above.
-
-Building the Web Assets
------------------------
-
-pgAdmin is dependent on a number of third party Javascript libraries. These,
-along with it's own Javascript code, SCSS/CSS code and images must be
-compiled into a "bundle" which is transferred to the browser for execution
-and rendering. This is far more efficient than simply requesting each
-asset as it's needed by the client.
-
-To create the bundle, you will need the 'yarn' package management tool to be
-installed. Then, you can run the following commands on a *nix system to
-download the required packages and build the bundle:
-
-    (pgadmin4) $ cd $PGADMIN4_SRC
-    (pgadmin4) $ make install-node
-    (pgadmin4) $ make bundle
-
-On Windows systems (where "make" is not available, the following commands
-can be used:
-
-    C:\> cd $PGADMIN4_SRC\web
-    C:\$PGADMIN4_SRC\web> yarn install
-    C:\$PGADMIN4_SRC\web> yarn run bundle
-
-Creating pgAdmin themes
------------------------
-
-To create a pgAdmin theme, you need to create a directory under
-web/pgadmin/static/scss/resources.
-Copy the sample file _theme.variables.scss.sample to the new directory and
-rename it to _theme.variables.scss. Change the desired hexadecimal values of
-the colors and bundle pgAdmin. You can also add a preview image in the theme
-directory with the name as <dir name>_preview.png. It is recommended that the
-preview image should not be larger in size as it may take time to load on slow
-networks. Run the yarn run bundle and you're good to go. No other changes are
-required, pgAdmin bundle will read the directory and create other required
-entries to make them available in preferences.
-
-The name of the theme is derived from the directory name. Underscores (_) and
-hyphens (-) will be replaced with spaces and the result will be camel cased.
-
-Configuring the Runtime
------------------------
-
-The pgAdmin 4 Runtime maintains it's own Python Path to avoid conflicts with
-packages or other issues in the system Python installation. It will also search
-a number of known locations for the pgAdmin4.py file needed to run pgAdmin
-(including relative locations in a source code tree), however you can specify
-an alternate path if needed.
-
-If either a working environment or pgAdmin4.py cannot be found at startup, the
-runtime will prompt for the locations. Alternatively, you can click the try
-icon and select the Configuration option to open the configuration dialogue.
-
-On a Linux/Mac system, the Python Path will typically consist of a single path
-to the virtual environment's site-packages directory, e.g.
-
-    /Users/<USERNAME>/.virtualenvs/pgadmin4/lib/python3.8/site-packages
-
-On Windows, multiple paths are likely to be required, e.g.
-
-    C:\Users\dpage\.virtualenvs\pgadmin4\Lib\site-packages;C:\Users\dpage\.virtualenvs\pgadmin4\Lib;C:\Users\dpage\.virtualenvs\pgadmin4\Lib\lib-tk;C:\Users\dpage\.virtualenvs\pgadmin4\DLLs
-
-If you wish to specify a specific copy of the Python code to run, you can set
-the  Application Path to a directory containing pgAdmin4.py, e.g.
-
-    /Users/<USERNAME>/git/pgadmin4-test/web/
-
-Building the documentation
---------------------------
-
-In order to build the docs, an additional Python package is required in the
-virtual environment. This can be installed with the pip package manager:
-
-    $ workon pgadmin4
-    (pgadmin4) $ pip install Sphinx
-
-The docs can then be built using the Makefile in $PGADMIN4_SRC, e.g.
-
-    (pgadmin4) $ make docs
-
-The output can be found in $PGADMIN4_SRC/docs/en_US/_build/html/index.html
-
-Building packages
------------------
-
-Most packages can be built using the Makefile in $PGADMIN4_SRC, provided all
-the setup and configuration above has been completed.
-
-To build a source tarball:
-
-    (pgadmin4) $ make src
-
-To build a PIP Wheel, activate either a Python 2 or Python 3 virtual
-environment as desired, configured with all the required packages, and then
-run:
-
-    (pgadmin4) $ make pip
-
-To build the macOS AppBundle, please see pkg/mac/README.
-
-To build the Windows installer, please see pkg/win32/README.txt.
-
-Support
--------
-
-See https://www.pgadmin.org/support/ for support options.
-
-Project info
-------------
-
-The source code repository can be found here:
-
-http://git.postgresql.org/gitweb/?p=pgadmin4.git;a=summary
-
-A Redmine project for pgAdmin 4 can be found at the address below. A PostgreSQL
-community account is required to access this site. Please note that at present
-only project developers can log bug and feature requests:
-
-https://redmine.postgresql.org/projects/pgadmin4
-
-If you wish to discuss pgAdmin 4, or contribute to the project, please use the
-pgAdmin Hackers mailing list:
-
-pgadmin-hackers@postgresql.org
-
--- 
-Dave Page
-pgAdmin Project Lead

README.md

@@ -0,0 +1,251 @@
+# pgAdmin 4 
+
+pgAdmin 4 is a rewrite of the popular pgAdmin3 management tool for the
+PostgreSQL (http://www.postgresql.org) database. 
+
+In the following documentation and examples, *$PGADMIN4_SRC/* is used to denote
+the top-level directory of a copy of the pgAdmin source tree, either from a
+tarball or a git checkout.
+
+## Architecture
+
+pgAdmin 4 is written as a web application in Python, using jQuery and Bootstrap
+for the client side processing and UI. On the server side, Flask is being
+utilised.
+
+Although developed using web technologies, pgAdmin 4 can be deployed either on
+a web server using a browser, or standalone on a workstation. The runtime/
+subdirectory contains an NWjs based runtime application intended to allow this,
+which will execute the Python server and display the UI.
+
+## Building the Runtime
+
+To build the runtime, the following packages must be installed:
+
+* NodeJS 12+
+* Yarn
+
+Change into the runtime directory, and run *yarn install*. This will install the
+dependencies required.
+
+In order to use the runtime in a development environment, you'll need to copy
+*dev_config.json.in* file to *dev_config.json*, and edit the paths to the Python
+executable and *pgAdmin.py* file, otherwise the runtime will use the default
+paths it would expect to find in the standard package for your platform.
+
+You can then execute the runtime by running something like:
+
+    node_modules/nw/nwjs/nw .
+
+or on macOS:
+
+    node_modules/nw/nwjs/nwjs.app/Contents/MacOS/nwjs .
+
+# Create Database Migrations
+
+In order to make changes to the SQLite DB, navigate to the 'web' directory:
+
+    (pgadmin4) $ cd $PGADMIN4_SRC/web
+
+Create a migration file with the following command:
+
+    (pgadmin4) $ FLASK_APP=pgAdmin4.py flask db revision
+
+This will create a file in: $PGADMIN4_SRC/web/migrations/versions/ .
+Add any changes to the 'upgrade' function.
+Increment the SCHEMA_VERSION in $PGADMIN4_SRC/web/pgadmin/model/__init__.py file.
+
+There is no need to increment the SETTINGS_SCHEMA_VERSION.
+
+# Configuring the Python Environment
+
+In order to run the Python code, a suitable runtime environment is required.
+Python version 3.6 and later are currently supported. It is recommended that a
+Python Virtual Environment is setup for this purpose, rather than using the
+system Python environment. On Linux and Mac systems, the process is fairly
+simple - adapt as required for your distribution:
+
+1. Install the virtualenv packages into the system Python environment
+
+       $ sudo pip install virtualenv virtualenvwrapper
+
+2. Source the virtualenv wrapper tools script. You may want to add this command
+   to your ~/.bash_profile file for future convenience:
+
+       $ source /usr/local/bin/virtualenvwrapper.sh
+
+3. Create a virtual environment:
+
+       $ mkvirtualenv pgadmin4
+
+   To make use of the virtual environment in the future, use the following
+   command to re-activate it:
+
+       $ workon pgadmin4
+
+4. Ensure that a PostgreSQL installation's bin/ directory is in the path (so
+   pg_config can be found for building psycopg2), and install the required
+   packages:
+
+       (pgadmin4) $ PATH=$PATH:/usr/local/pgsql/bin pip install -r $PGADMIN4_SRC/requirements.txt
+
+   If you are planning to run the regression tests, you also need to install
+   additional requirements from web/regression/requirements.txt:
+
+       (pgadmin4) $ pip install -r $PGADMIN4_SRC/web/regression/requirements.txt
+
+5. Create a local configuration file for pgAdmin. Edit
+   $PGADMIN4_SRC/web/config_local.py and add any desired configuration options
+   (use the config.py file as a reference - any settings duplicated in
+   config_local.py will override those in config.py). A typical development
+   configuration may look like:
+    ```python
+    from config import *
+
+    # Debug mode
+    DEBUG = True
+
+    # App mode
+    SERVER_MODE = True
+
+    # Enable the test module
+    MODULE_BLACKLIST.remove('test')
+
+    # Log
+    CONSOLE_LOG_LEVEL = DEBUG
+    FILE_LOG_LEVEL = DEBUG
+
+    DEFAULT_SERVER = '127.0.0.1'
+
+    UPGRADE_CHECK_ENABLED = True
+
+    # Use a different config DB for each server mode.
+    if SERVER_MODE == False:
+        SQLITE_PATH = os.path.join(
+            DATA_DIR,
+            'pgadmin4-desktop.db'
+        )
+    else:
+        SQLITE_PATH = os.path.join(
+            DATA_DIR,
+            'pgadmin4-server.db'
+        )
+   ```
+   This configuration allows easy switching between server and desktop modes
+   for testing.
+
+6. The initial setup of the configuration database is interactive in server
+   mode, and non-interactive in desktop mode. You can run it either by
+   running:
+
+       (pgadmin4) $ python $PGADMIN4_SRC/web/setup.py
+
+   or by starting pgAdmin 4:
+
+       (pgadmin4) $ python $PGADMIN4_SRC/web/pgAdmin4.py
+
+   Whilst it is possible to automatically run setup in desktop mode by running
+   the runtime, that will not work in server mode as the runtime doesn't allow
+   command line interaction with the setup program.
+
+At this point you will be able to run pgAdmin 4 from the command line in either
+server or desktop mode, and access it from a web browser using the URL shown in
+the terminal once pgAdmin has started up.
+
+Setup of an environment on Windows is somewhat more complicated unfortunately,
+please see *pkg/win32/README.txt* for complete details.
+
+Once a virtual environment has been created and enabled, setup can continue
+from step 4 above.
+
+## Building the Web Assets
+
+pgAdmin is dependent on a number of third party Javascript libraries. These,
+along with it's own Javascript code, SCSS/CSS code and images must be
+compiled into a "bundle" which is transferred to the browser for execution
+and rendering. This is far more efficient than simply requesting each
+asset as it's needed by the client.
+
+To create the bundle, you will need the 'yarn' package management tool to be
+installed. Then, you can run the following commands on a *nix system to
+download the required packages and build the bundle:
+
+    (pgadmin4) $ cd $PGADMIN4_SRC
+    (pgadmin4) $ make install-node
+    (pgadmin4) $ make bundle
+
+On Windows systems (where "make" is not available), the following commands
+can be used:
+
+    C:\> cd $PGADMIN4_SRC\web
+    C:\$PGADMIN4_SRC\web> yarn install
+    C:\$PGADMIN4_SRC\web> yarn run bundle
+
+## Creating pgAdmin themes
+
+To create a pgAdmin theme, you need to create a directory under
+*web/pgadmin/static/scss/resources*.
+Copy the sample file *_theme.variables.scss.sample* to the new directory and
+rename it to *_theme.variables.scss*. Change the desired hexadecimal values of
+the colors and bundle pgAdmin. You can also add a preview image in the theme
+directory with the name as *\<dir name>_preview.png*. It is recommended that the
+preview image should not be larger in size as it may take time to load on slow
+networks. Run the *yarn run bundle* and you're good to go. No other changes are
+required, pgAdmin bundle will read the directory and create other required
+entries to make them available in preferences.
+
+The name of the theme is derived from the directory name. Underscores (_) and
+hyphens (-) will be replaced with spaces and the result will be camel cased.
+
+# Building the documentation
+
+In order to build the docs, an additional Python package is required in the
+virtual environment. This can be installed with the pip package manager:
+
+    $ workon pgadmin4
+    (pgadmin4) $ pip install Sphinx
+    
+The docs can then be built using the Makefile in *$PGADMIN4_SRC*, e.g.
+
+    (pgadmin4) $ make docs
+
+The output can be found in *$PGADMIN4_SRC/docs/en_US/_build/html/index.html*
+
+# Building packages
+
+Most packages can be built using the Makefile in $PGADMIN4_SRC, provided all
+the setup and configuration above has been completed.
+
+To build a source tarball:
+
+    (pgadmin4) $ make src
+
+To build a PIP Wheel, activate either a Python 3 virtual environment, configured 
+with all the required packages, and then run:
+
+    (pgadmin4) $ make pip
+
+To build the macOS AppBundle, please see *pkg/mac/README*.
+
+To build the Windows installer, please see *pkg/win32/README.txt*.
+
+## Support
+
+See https://www.pgadmin.org/support/ for support options.
+
+## Project info
+
+The source code repository can be found here:
+
+http://git.postgresql.org/gitweb/?p=pgadmin4.git;a=summary
+
+A Redmine project for pgAdmin 4 can be found at the address below. A PostgreSQL
+community account is required to access this site. Please note that at present
+only project developers can log bug and feature requests:
+
+https://redmine.postgresql.org/projects/pgadmin4
+
+If you wish to discuss pgAdmin 4, or contribute to the project, please use the
+pgAdmin Hackers mailing list:
+
+pgadmin-hackers@postgresql.org

docs/en_US/backup_dialog.rst

@@ -4,7 +4,7 @@
 `Backup Dialog`:index:
 **********************
 
-Using the *pg_dump* utility, *pgAdmin* provides an easy way to create a backup
+*pgAdmin* uses the *pg_dump* utility to provide an easy way to create a backup
 in a plain-text or archived format.  You can then use a client application (like
 *psql* or the *Query Tool*) to restore a plain-text backup file, or use the
 Postgres *pg_restore* utility to restore an archived backup. The *pg_dump*
@@ -205,14 +205,15 @@ command:
 
 Use the **Stop Process** button to stop the Backup process.
 
-If the backup is successful, a popup window will confirm success. Click *Click
-here for details* on the popup window to launch the *Process Watcher*. The
-*Process Watcher* logs all the activity associated with the backup and provides
-additional information for troubleshooting.
+If the backup is successful, a popup window will confirm success. Click *More details* on the popup window to launch the *Process Watcher*. The *Process Watcher* logs all the activity associated with the backup and provides additional information for troubleshooting.
 
 .. image:: images/backup_process_watcher.png
     :alt:  Backup process watcher
     :align: center
 
 If the backup is unsuccessful, you can review the error messages returned by the
-backup command on the *Process Watcher*.
+backup command on the *Process Watcher*.
+
+.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
+
+.. |sm_icon| image:: images/sm_icon.png

docs/en_US/backup_globals_dialog.rst

@@ -50,4 +50,8 @@ additional information for troubleshooting.
     :align: center
 
 If the backup is unsuccessful, review the error message returned by the
-*Process Watcher* to resolve any issue.
+*Process Watcher* to resolve any issue.
+
+.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
+
+.. |sm_icon| image:: images/sm_icon.png

docs/en_US/backup_server_dialog.rst

@@ -135,4 +135,8 @@ additional information for troubleshooting.
     :align: center
 
 If the backup is unsuccessful, review the error message returned by the
-*Process Watcher* to resolve any issue.
+*Process Watcher* to resolve any issue.
+
+.. note:: If you are running *pgAdmin* in *Server Mode* you can click on the |sm_icon| icon in the process watcher window to open the file location in the Storage Manager. You can use the :ref:`Storage Manager <storage_manager>` to download the backup file on the client machine .
+
+.. |sm_icon| image:: images/sm_icon.png

docs/en_US/code_overview.rst

@@ -7,14 +7,14 @@
 The bulk of pgAdmin is a Python web application written using the Flask framework
 on the backend, and HTML5 with CSS3, Bootstrap and jQuery on the front end. A
 desktop runtime is also included for users that prefer a desktop application to
-a web application, which is written in C++ using the QT framework.
+a web application, which is written using NWjs (Node Webkit).
 
 Runtime
 *******
 
-The runtime is essentially a Python webserver and browser in a box. Found in the
-**/runtime** directory in the source tree, it is a relatively simple QT
-application that is most easily modified using the **QT Creator** application.
+The runtime is based on NWjs which integrates a browser and the Python server
+creating a standalone application. The source code can be found in the
+**/runtime** directory in the source tree.
 
 Web Application
 ***************
@@ -213,4 +213,4 @@ divided each module in small chunks as much as possible. Not all javascript
 modules are required to be loaded (i.e. loading a javascript module for
 database will make sense only when a server node is loaded completely.) Please
 look at the the javascript files node.js, browser.js, menu.js, panel.js, etc for
-better understanding of the code.
+better understanding of the code.

docs/en_US/code_review.rst

@@ -16,46 +16,46 @@ review process for any patches submitted for inclusion in pgAdmin.
   bulk updates every year). The start date should always be 2013, and the end year
   the current year, e.g.
 
-    Copyright (C) 2013 - 2020, The pgAdmin Development Team
- 
+    Copyright (C) 2013 - 2021, The pgAdmin Development Team
+
 * Ensure there's a blank line immediately following any copyright headers.
 
-* Include PyDoc comments for functions, classes and modules. Node modules should 
+* Include PyDoc comments for functions, classes and modules. Node modules should
   be """Implements the XXXX node""".
 
 * Ensure that any generated SQL does not have any leading or trailing blank lines
   and consistently uses 4 space indents for nice formatting.
 
-* Don't special-case any Slony objects. pgAdmin 4 will have no direct knowledge 
+* Don't special-case any Slony objects. pgAdmin 4 will have no direct knowledge
   of Slony, unlike pgAdmin 3.
 
-* If you copy/paste modules, please ensure any comments are properly updated. 
+* If you copy/paste modules, please ensure any comments are properly updated.
 
 * Read all comments, and ensure they make sense and provide useful commentary on
   the code.
 
-* Ensure that field labels both use PostgreSQL parlance, but also are descriptive. 
-  A good example is the "Init" field on an FTS Template - Init is the PG term, but 
+* Ensure that field labels both use PostgreSQL parlance, but also are descriptive.
+  A good example is the "Init" field on an FTS Template - Init is the PG term, but
   adding the word "Function" after it makes it much more descriptive.
 
 * Re-use code whereever possible, but factor it out into a suitably central
   location - don't copy and paste it unless modifications are required!
 
-* Format code nicely to make it readable. Break up logical chunks of code with 
-  blank lines, and comment well to describe what different sections of code are 
+* Format code nicely to make it readable. Break up logical chunks of code with
+  blank lines, and comment well to describe what different sections of code are
   for or pertain to.
 
-* Ensure that form validation works correctly and is consistent with other 
+* Ensure that form validation works correctly and is consistent with other
   dialogues in the way errors are displayed.
 
-* On dialogues with Schema or Owner fields, pre-set the default values to the 
-  current schema/user as appropriate. In general, if there are common or sensible 
-  default values available, put them in the fields for the user. 
+* On dialogues with Schema or Owner fields, pre-set the default values to the
+  current schema/user as appropriate. In general, if there are common or sensible
+  default values available, put them in the fields for the user.
 
-* 1 patch == 1 feature. If you need to fix/update existing infrastructure in 
+* 1 patch == 1 feature. If you need to fix/update existing infrastructure in
   your patch, it's usually easier if it's in a separate patch. Patches containing
   multiple new features or unrelated changes are likely to be rejected.
 
-* Ensure the patch is fully functional, and works! If a patch is being sent as 
-  a work in progress, not intended for commit, clearly state that it's a WIP, 
-  and note what does or does not yet work.
+* Ensure the patch is fully functional, and works! If a patch is being sent as
+  a work in progress, not intended for commit, clearly state that it's a WIP,
+  and note what does or does not yet work.

docs/en_US/coding_standards.rst

@@ -4,7 +4,7 @@
 `Coding Standards`:index:
 *************************
 
-pgAdmin uses multiple technologies and multiple languages, each of which have 
+pgAdmin uses multiple technologies and multiple languages, each of which have
 their own coding standards.
 
 General
@@ -16,24 +16,24 @@ lines wrapped where appropriate to ensure they can be read on smaller displays
 as it's quite wasteful on modern displays). Typically lines should not be longer
 than 120 characters.
 
-Comments should be included in all code where required to explain its 
+Comments should be included in all code where required to explain its
 purpose or how it works if not obvious from a quick review of the code itself.
 
 CSS 3
 *****
 
 CSS3 is used for styling and layout throughout the application. Extensive use is
-made of the Bootstrap Framework to aid in that process, however additional 
+made of the Bootstrap Framework to aid in that process, however additional
 styles must still be created from time to time.
 
 Most custom styling comes from individual modules which may advertise static
 stylesheets to be included in the module that is loading them via hooks.
 
-Styling overrides (for example, to alter the Bootstrap look and feel) will 
+Styling overrides (for example, to alter the Bootstrap look and feel) will
 typically be found in the **overrides.css** file in the main static file
 directory for the application.
 
-Styling should never be applied inline in HTML, always through an external 
+Styling should never be applied inline in HTML, always through an external
 stylesheet, which should contain comments as appropriate to explain the usage
 or purpose for the style.
 
@@ -48,16 +48,16 @@ Styles should be specified clearly, one per line. For example:
 
     /* Ensure the codemirror editor displays full height gutters when resized */
     .CodeMirror, .CodeMirror-gutters {
-        height: 100% !important; 
-    } 
+        height: 100% !important;
+    }
 
 All stylesheets must be CSS3 compliant.
 
 HTML 5
 ******
 
-HTML 5 is used for page structure throughout the application, in most cases 
-being rendered from templates by the Jinja2 template engine in Flask. 
+HTML 5 is used for page structure throughout the application, in most cases
+being rendered from templates by the Jinja2 template engine in Flask.
 
 All HTML must be HTML 5 compliant.
 
@@ -109,68 +109,20 @@ names.
 .. note:: From version 3.0 onwards, new or refactored code should be written using
      ES6 features and conventions.
 
-C++
-***
-
-C++ code is used in the desktop runtime for the application, primarily with the
-QT framework and an embedded Python interpreter. Note the use of hanging braces,
-which may be omitted if on a single statement is present:
-
-.. code-block:: c++
-
-    // Ping the application server to see if it's alive
-    bool PingServer(QUrl url)
-    {
-        QNetworkAccessManager manager;
-        QEventLoop loop;
-        QNetworkReply *reply;
-        QVariant redirectUrl;
-
-        url.setPath("/utils/ping");
-
-        do
-        {
-            reply = manager.get(QNetworkRequest(url));
-
-            QObject::connect(reply, SIGNAL(finished()), &loop, SLOT(quit()));
-            loop.exec();
-
-            redirectUrl = reply->attribute(QNetworkRequest::RedirectionTargetAttribute);
-            url = redirectUrl.toUrl();
-
-            if (!redirectUrl.isNull())
-                delete reply;
-
-        } while (!redirectUrl.isNull());
-
-        if (reply->error() != QNetworkReply::NoError)
-            return false;
-
-        QString response = reply->readAll();
-
-        if (response != "PING")
-        {
-            qDebug() << "Failed to connect, server response: " << response;
-            return false;
-        }
-
-        return true;
-    }
-
 Python
 ******
 
-Python is used for the backend web server. All code must be compatible with 
+Python is used for the backend web server. All code must be compatible with
 Python 2.7 and should include PyDoc comments whilst following the official
-Python coding standards defined in 
-`PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_. An example function along 
+Python coding standards defined in
+`PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_. An example function along
 with the required file header is shown below::
 
     ##########################################################################
     #
     # pgAdmin 4 - PostgreSQL Tools
     #
-    # Copyright (C) 2013 - 2020, The pgAdmin Development Team
+    # Copyright (C) 2013 - 2021, The pgAdmin Development Team
     # This software is released under the PostgreSQL Licence
     #
     ##########################################################################
@@ -185,12 +137,12 @@ with the required file header is shown below::
     def get_nodes():
         """Return a JSON document listing the server groups for the user"""
         groups = ServerGroup.query.filter_by(user_id=current_user.id)
-        
+
         value = ''
         for group in groups:
             value += '{"id":%d,"label":"%s","icon":"icon-server-group","inode":true},' \
                      % (group.id, group.name)
-             
+
         value = value[:-1]
-        
-        return value
+
+        return value

docs/en_US/conf.py

@@ -208,8 +208,8 @@ htmlhelp_basename = 'pgadmin4'
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index', 'pgadmin4.tex', u'pgAdmin 4 Documentation',
-     u'The pgAdmin Development Team', 'manual'),
+    ('index', 'pgadmin4.tex', 'pgAdmin 4 Documentation',
+     'The pgAdmin Development Team', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -247,6 +247,6 @@ latex_elements = {
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pgadmin4', u'pgAdmin 4 Documentation',
-     [u'The pgAdmin Development Team'], 1)
+    ('index', 'pgadmin4', 'pgAdmin 4 Documentation',
+     ['The pgAdmin Development Team'], 1)
 ]

docs/en_US/config_py.rst

@@ -5,7 +5,16 @@
 ***************************
 
 There are multiple configuration files that are read at startup by pgAdmin. These
-are as follows:
+files are used for configuration options that:
+
+* may be required to be set prior to startup of pgAdmin as they control how
+  the application will operate.
+* system administrators may wish to control across an organisation to enforce
+  security policies.
+* are so rarely or unlikely to be changed that it doesn't
+  make sense to allow them to be changed through the user interface.
+
+The configuration files are as follows:
 
 * ``config.py``: This is the main configuration file, and should not be modified.
   It can be used as a reference for configuration settings, that may be overridden
@@ -27,11 +36,14 @@ are as follows:
   intended for system administrators to include settings that are configured
   system-wide from a secure location that users cannot normally modify and that
   is outside of the pgAdmin installation. The location for this file varies
-  based on the platform, and only needs to be created if desired:
+  based on the platform, and only needs to be created if desired.
 
-  * Linux: ``/etc/pgadmin/config_system.py``
-  * macOS: ``/Library/Preferences/pgadmin/config_system.py``
-  * Windows: ``%CommonProgramFiles%\pgadmin\config_system.py``
+  .. csv-table::
+     :header: "**Platform**", "**File Location**"
+
+     Linux,/etc/pgadmin/config_system.py
+     macOS,/Library/Preferences/pgadmin/config_system.py
+     Windows,%CommonProgramFiles%\pgadmin\config_system.py
 
 .. note:: If the SERVER_MODE setting is changed in ``config_distro.py``,
      ``config_local.py``, or ``config_system.py`` you will most likely need to

docs/en_US/container_deployment.rst

@@ -17,11 +17,11 @@ maintenance functions to be executed. Multiple versions are included in the
 following directories to allow use with different versions of the database
 server:
 
-* PostgreSQL 9.5: */usr/local/pgsql-9.5*
 * PostgreSQL 9.6: */usr/local/pgsql-9.6*
 * PostgreSQL 10: */usr/local/pgsql-10*
 * PostgreSQL 11: */usr/local/pgsql-11*
 * PostgreSQL 12: */usr/local/pgsql-12*
+* PostgreSQL 13: */usr/local/pgsql-13*
 
 The most recent version of the utilities is used by default; this may be
 changed in the :ref:`preferences`.
@@ -41,6 +41,20 @@ to login to pgAdmin. This variable is required and must be set at launch time.
 This is the password used when setting up the initial administrator account to
 login to pgAdmin. This variable is required and must be set at launch time.
 
+**PGADMIN_DISABLE_POSTFIX**
+
+*Default: <null>*
+
+If left unset, a Postfix server will be started to deliver password reset
+emails.
+
+If set to any value, the Postfix server will not be started, and pgAdmin will
+need to be configured to use an external mail server using the *PGADMIN_CONFIG_*
+options below.
+
+This option is useful if you're running in an environment that prevents the use
+of sudo to start Postfix, or if you wish to use an external mail server.
+
 **PGADMIN_ENABLE_TLS**
 
 *Default: <null>*

docs/en_US/desktop_deployment.rst

@@ -8,13 +8,8 @@ pgAdmin may be deployed as a desktop application by configuring the application
 to run in desktop mode and then utilising the desktop runtime to host the
 program on a supported Windows, Mac OS X or Linux installation.
 
-The desktop runtime is a system-tray application that when launched, runs the
-pgAdmin server and launches a web browser to render the user interface. If
-additional instances of pgAdmin are launched, a new browser tab will be opened
-and be served by the existing instance of the server in order to minimise system
-resource utilisation. Clicking the icon in the system tray will present a menu
-offering options to open a new pgAdmin window, configure the runtime, view the
-server log and shut down the server.
+The desktop runtime is a standalone application that when launched, runs the
+pgAdmin server and opens a window to render the user interface.
 
 .. note:: Pre-compiled and configured installation packages are available for
      a number of platforms. These packages should be used by end-users whereever
@@ -24,7 +19,7 @@ server log and shut down the server.
 .. seealso:: For detailed instructions on building and configuring pgAdmin from
     scratch, please see the README file in the top level directory of the source code.
     For convenience, you can find the latest version of the file
-    `here <https://git.postgresql.org/gitweb/?p=pgadmin4.git;a=blob_plain;f=README>`_,
+    `here <https://git.postgresql.org/gitweb/?p=pgadmin4.git;a=blob;f=README.md>`_,
     but be aware that this may differ from the version included with the source code
     for a specific version of pgAdmin.
 
@@ -38,25 +33,53 @@ settings.
 
 See :ref:`config_py` for more information on configuration settings.
 
-Runtime
-*******
+Desktop Runtime Standalone Application
+======================================
 
-When executed, the runtime will automatically try to execute the pgAdmin Python
-application. If execution fails, it will prompt you to adjust the Python Path
-to include the directories containing the pgAdmin code as well as any additional
-Python dependencies. You can enter a list of paths by separating them with a
-semi-colon character, for example:
+The Desktop Runtime is based on `NWjs <https://nwjs.io/>`_ which integrates a
+browser and the Python server creating a standalone application.
 
-.. code-block:: bash
+.. image:: images/runtime_standalone.png
+    :alt: Runtime Standalone
+    :align: center
 
-     /Users/dpage/.virtualenvs/pgadmin4/lib/python2.7/site-packages/;/Users/dpage/python-libs/
+Runtime Menu
+------------
 
-The configuration settings are stored using the QSettings class in Qt, which
-will use an INI file on Unix systems (~/.config/pgadmin/pgadmin4.conf),
-a plist file on Mac OS X (~/Library/Preferences/org.pgadmin.pgadmin4.plist),
-and the registry on Windows (HKEY_CURRENT_USER\\Software\\pgadmin\\pgadmin4).
+.. image:: images/runtime_menu.png
+    :alt: Runtime Menu
+    :align: center
 
-The configuration settings:
+Use the *File Menu* to access the *Runtime Menu*:
+
++-------------------------+---------------------------------------------------------------------------------------------------------+
+| Option                  | Action                                                                                                  |
++=========================+=========================================================================================================+
+| *Configure...*          | Click to open configuration dialog to configure fixed port, port number and connection timeout.         |
++-------------------------+---------------------------------------------------------------------------------------------------------+
+| *View log...*           | Click to open the view log dialog to view the pgAdmin 4 logs.                                           |
++-------------------------+---------------------------------------------------------------------------------------------------------+
+| *Enter Full Screen*     | Click to enter/exit the full screen mode. Keyboard Shortcuts: OSX (Cmd + Ctrl + F), Other OS (F10).     |
++-------------------------+---------------------------------------------------------------------------------------------------------+
+| *Actual Size*           | Click to change the window size to it original size. Keyboard Shortcuts: OSX (Cmd + 0),                 |
+|                         | Other OS (Ctrl + 0).                                                                                    |
++-------------------------+---------------------------------------------------------------------------------------------------------+
+| *Zoom In*               | Click to increase the zoom level. Keyboard Shortcuts: OSX (Cmd + +), Other OS (Ctrl + +).               |
++-------------------------+---------------------------------------------------------------------------------------------------------+
+| *Zoom Out*              | Click to decrease the zoom level. Keyboard Shortcuts: OSX (Cmd + -), Other OS (Ctrl + -).               |
++-------------------------+---------------------------------------------------------------------------------------------------------+
+
+Configuration Dialog
+--------------------
+
+Use the *Runtime Menu* to access the *Configuration* dialog:
+
+.. image:: images/runtime_configuration.png
+    :alt: Runtime Configuration
+    :align: center
+
+Following are the details of the *Fixed port number?*, *Port Number*, and *Connection
+Timeout* configuration parameters:
 
 .. table::
    :class: longtable
@@ -65,18 +88,49 @@ The configuration settings:
    +--------------------------+--------------------+---------------------------------------------------------------+
    | Key                      | Type               | Purpose                                                       |
    +==========================+====================+===============================================================+
-   | ApplicationPath          | String             | The directory containing pgAdmin4.py                          |
-   +--------------------------+--------------------+---------------------------------------------------------------+
-   | BrowserCommand           | String             | An alternate command to run instead of the default browser.   |
-   +--------------------------+--------------------+---------------------------------------------------------------+
-   | ConnectionTimeout        | Integer            | The number of seconds to wait for application server startup. |
-   +--------------------------+--------------------+---------------------------------------------------------------+
    | FixedPort                | Boolean            | Use a fixed network port number rather than a random one.     |
    +--------------------------+--------------------+---------------------------------------------------------------+
-   | OpenTabAtStartup         | Boolean            | Open a browser tab at startup.                                |
-   +--------------------------+--------------------+---------------------------------------------------------------+
    | PortNumber               | Integer            | The port number to use, if using a fixed port.                |
    +--------------------------+--------------------+---------------------------------------------------------------+
-   | PythonPath               | String             | The Python module search path                                 |
+   | ConnectionTimeout        | Integer            | The number of seconds to wait for application server startup. |
    +--------------------------+--------------------+---------------------------------------------------------------+
 
+Log dialog
+----------
+
+Use the *Runtime Menu* to access the *Log* dialog:
+
+.. image:: images/runtime_view_log.png
+    :alt: Runtime View Log
+    :align: center
+
+Click on the *Reload* button at the bottom to view the latest logs of pgAdmin 4
+Server.
+
+When executed, the runtime will automatically try to execute the pgAdmin Python
+application. If execution fails, it will prompt you with error message
+displaying a *Configure* button at the bottom. You can configure a fixed port
+number to avoid clashes of the default random port number with other
+applications and a connection timeout if desired.
+
+.. image:: images/runtime_error.png
+    :alt: Runtime Error
+    :align: center
+
+If the error is related to Python Path or pgAdmin Python file then you need to
+create a file named 'dev_config.json' and specify the following entries:
+
+.. code-block:: json
+
+    {
+        "pythonPath": "/path/to/python.exe",
+        "pgadminFile": "/path/to/pgAdmin4.py"
+    }
+
+Note that the *dev_config.py* file should only be required by developers who are
+working outside of a standard installation.
+
+The configuration settings are stored in *runtime_config.json* file, which
+will be available on Unix systems (~/.local/share/pgadmin/),
+on Mac OS X (~/Library/Preferences/pgadmin),
+and on Windows (%APPDATA%/pgadmin).

docs/en_US/developer_tools.rst

@@ -15,3 +15,4 @@ PL/SQL code.
    query_tool
    editgrid
    schema_diff
+   erd_tool

docs/en_US/erd_tool.rst

@@ -0,0 +1,235 @@
+.. _erd_tool:
+
+*****************
+`ERD Tool`:index:
+*****************
+
+The Entity-Relationship Diagram (ERD) tool is a database design tool that provides a graphical representation of database tables, columns, and inter-relationships. ERD can give sufficient information for the database administrator to follow when developing and maintaining the database. The ERD Tool allows you to:
+
+* Design and visualize the database tables and their relationships.
+* Add notes to the diagram.
+* Auto-align the tables and links for cleaner visualization.
+* Save the diagram and open it later to continue working on it.
+* Generate ready to run SQL from the database design.
+* Generate the database diagram for an existing database.
+
+.. image:: images/erd_tool.png
+    :alt: ERD tool window
+    :align: center
+
+You can open multiple copies of the ERD tool in individual tabs simultaneously. To close a copy of the ERD tool, click the *X* in the upper-right hand corner of the tab bar.
+
+Toolbar
+*******
+
+The *ERD Tool* toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. The option is enabled for the highlighted icon and is disabled for the grayed-out icon.
+
+.. image:: images/erd_tool_toolbar.png
+    :alt: ERD tool toolbar
+    :align: center
+
+Hover over an icon on Toolbar to display a tooltip that describes the icon's functionality.
+
+File Options
+************
+
+.. table::
+   :class: longtable
+   :widths: 1 4 1
+
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | Icon                 | Behavior                                                                                          | Shortcut       |
+   +======================+===================================================================================================+================+
+   | *Open File*          | Click the *Open File* icon to load a previously saved diagram.                                    | Ctrl + O       |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Save*               | Click the *Save* icon to perform a quick-save of a previously saved diagram, or to save the       | Ctrl + S       |
+   |                      | diagram to a file.                                                                                |                |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Save as*            | Click the *Save As* to open a new browser dialog and specify a new location to save the diagram.  | Ctrl + Shift + |
+   |                      |                                                                                                   | S              |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+
+Export Options
+**************
+
+.. table::
+   :class: longtable
+   :widths: 1 4 1
+
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | Icon                 | Behavior                                                                                          | Shortcut       |
+   +======================+===================================================================================================+================+
+   | *Generate SQL*       | Click the *Generate SQL* icon to generate the DDL SQL for the diagram and open a query tool       | Option + Ctrl +|
+   |                      | with the generated SQL ready for execution.                                                       | S              |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Download image*     | Click the *Download image* icon to save the ERD diagram in a image formate                        | Option + Ctrl +|
+   |                      |                                                                                                   | I              |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+
+Editing Options
+***************
+
+.. table::
+   :class: longtable
+   :widths: 1 4 1
+
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | Icon                 | Behavior                                                                                          | Shortcut       |
+   +======================+===================================================================================================+================+
+   | *Add table*          | Click this button to add a new table to the diagram. On clicking, this will open a table dialog   | Option/Alt +   |
+   |                      | where you can put the table details.                                                              | Ctrl + A       |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Edit table*         | Click this button to edit a table on the diagram. On clicking, this will open a table dialog      | Option/Alt +   |
+   |                      | where you can change table details. This will enable when a table is selected.                    | Ctrl + E       |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Clone table*        | Click this button to clone the complete table structure, name it with a auto generated name and   | Option/Alt +   |
+   |                      | put it in the diagram.                                                                            | Ctrl + C       |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Drop table/link*    | You can drop a table or link using this button. You need to select a table or link and click on   | Option/Alt +   |
+   |                      | this button to drop it.                                                                           | Ctrl + D       |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+
+Table Relationship Options
+**************************
+
+.. table::
+   :class: longtable
+   :widths: 1 4 1
+
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | Icon                 | Behavior                                                                                          | Shortcut       |
+   +======================+===================================================================================================+================+
+   | *1M*                 | Click this button to open a one-to-many relationship dialog to add a relationship between the     | Option/Alt +   |
+   |                      | two tables. The selected table becomes the referencing table and will have the *many* endpoint of | Ctrl + O       |
+   |                      | the link.                                                                                         |                |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *MM*                 | Click this button to open a many-to-many relationship dialog to add a relationship between the    | Option/Alt +   |
+   |                      | two tables. This option will create a new table based on the selected columns for the two relating| Ctrl + M       |
+   |                      | tables and link them.                                                                             |                |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+
+Utility Options
+***************
+
+.. table::
+   :class: longtable
+   :widths: 1 4 1
+
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | Icon                 | Behavior                                                                                          | Shortcut       |
+   +======================+===================================================================================================+================+
+   | *Add/Edit note*      | Click this button to make notes on tables nodes while designing the database.                     | Option/Alt +   |
+   |                      |                                                                                                   | Ctrl + N       |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Auto align*         | Click this button to auto align all tables and links to make it look more cleaner.                | Option/Alt +   |
+   |                      |                                                                                                   | Ctrl + L       |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Show details*       | Click this button to toggle the column details visibility. It allows you to show few or more      | Option/Alt +   |
+   |                      | column details.                                                                                   | Shift + D      |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+
+Zoom Options
+************
+
+.. table::
+   :class: longtable
+   :widths: 1 4 1
+
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | Icon                 | Behavior                                                                                          | Shortcut       |
+   +======================+===================================================================================================+================+
+   | *Zoom to fit*        | Click this button to zoom in/out automatically and fit all the tables to the view.                | Option/Alt +   |
+   |                      |                                                                                                   | Shift + F      |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Zoom in*            | Click this button to zoom in the diagram.                                                         | Option/Alt +   |
+   |                      |                                                                                                   | Shift + "+"    |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+   | *Zoom out*           | Click this button to zoom out the diagram.                                                        | Option/Alt +   |
+   |                      |                                                                                                   | Shift + "-"    |
+   +----------------------+---------------------------------------------------------------------------------------------------+----------------+
+
+Table Dialog
+************
+
+.. image:: images/erd_table_dialog.png
+    :alt: ERD tool table dialog
+    :align: center
+
+The table dialog allows you to:
+
+* Change the table structure details.
+* It can be used edit an existing table or add a new one.
+* Refer :ref:`table dialog <table_dialog>` for information on different fields.
+
+Table Node
+**********
+
+.. image:: images/erd_table_node.png
+    :alt: ERD tool table node
+    :align: center
+
+The table node shows table details in a graphical representation:
+
+* The top bar has a *details toggle button* that is used to toggle column details visibility. There is also a *note button* that is visible only if there is some note added. you can click on this button to quickly change the note.
+* The first row shows the schema name of the table. Eg. *public* in above image.
+* The second row shows the table name. Eg. *users* in above image.
+* All other rows below the table name are the columns of the table along with data type. If the column is a primary key then it will have lock key icon eg. id is the primary key in above image. Otherwise, it will have column icon.
+* you can click on the node and drag to move on the canvas.
+* Upon double click on the table node or by clicking the edit button from the toolbar, the table dialog opens where you can change the table details. Refer :ref:`table dialog <table_dialog>` for information on different fields.
+
+The One to Many Link Dialog
+***************************
+
+.. image:: images/erd_1m_dialog.png
+    :alt: ERD tool 1M dialog
+    :align: center
+
+The one to many link dialog allows you to:
+
+* Add a foreign key relationship between two tables.
+* *Local Table* is the table that references a table and has the *many* end point.
+* *Local Column* the column that references.
+* *Referenced Table* is the table that is being referred and has the *one* end point.
+* *Referenced Column* the column that is being referred.
+
+The Many to Many Link Dialog
+****************************
+
+.. image:: images/erd_mm_dialog.png
+    :alt: ERD tool MM dialog
+    :align: center
+
+The many to many link dialog allows you to:
+
+* Add a many to many relationship between two tables.
+* It creates a relationship tables having columns derived from the two tables and link them to the tables.
+* *Left Table* is the first table that is to be linked. It will receive the *one* endpoint of the link with the new relation table.
+* *Left Column* the column of the first table, that will always be a primary key.
+* *Right Table* is the second table that is to be linked. It will receive the *one* endpoint of the link with the new relation table.
+* *Right Column* the column of the second table, that will always be a primary key.
+
+The Table Link
+**************
+
+.. image:: images/erd_table_link.png
+    :alt: ERD tool table link
+    :align: center
+
+The table link shows relationship between tables:
+
+* The single line endpoint of the link shows the column that is being referred.
+* The three line endpoint of the link shows the column that refers.
+* If one of the columns that is being referred or that refers is removed from the table then the link will get dropped.
+* you can click on the link and drag to move on the canvas.
+
+
+The Table Notes
+***************
+
+.. image:: images/erd_table_note.png
+    :alt: ERD tool table note
+    :align: center
+
+* You can use the notes popup to mark some notes while designing the database.
+* You open the pop-up using the toolbar note button.
+* If some note is added to a table then it will have notes button on the table node. You can click on the button to check/update notes.

docs/en_US/exclusion_constraint_dialog.rst

@@ -58,13 +58,15 @@ Click the *Columns* tab to continue.
     :alt: Exclusion constraint dialog columns tab
     :align: center
 
-Use the fields in the *Columns* tab to to specify the column(s) to which the
-constraint applies. Use the drop-down listbox next to *Column* to select a
-column and click the *Add* icon (+) to provide details of the action on the
-column:
+Use the fields in the *Columns* tab to specify the column(s) or expression(s)
+to which the constraint applies. Use the *Is expression ?* switch to enable
+expression text input. Use the drop-down listbox next to *Column*
+to select a column. Once the *Column* is selected or the *Expression* is
+entered then click the *Add* icon (+) to provide details of the action on the
+column/expression:
 
-* The *Column* field is populated with the selection made in the *Column*
-  drop-down listbox.
+* The *Col/Exp* field is populated with the selection made in the *Column*
+  drop-down listbox or the *Expression* entered.
 * If applicable, use the drop-down listbox in the *Operator class* to specify
   the operator class that will be used by the index for the column.
 * Move the *DESC* switch to *DESC* to specify a descending sort order. The

docs/en_US/getting_started.rst

@@ -35,7 +35,8 @@ Mode is pre-configured for security.
    login
    user_management
    change_user_password
-   enabling_ldap_authentication
+   ldap
+   kerberos
 
 
 .. note:: Pre-compiled and configured installation packages are available for