如何在服务器模式下安装和配置pgAdmin 4

在本教程中,我们将介绍在Ubuntu 18.04服务器上安装和配置最新版本的pgAdmin,通过Web浏览器访问pgAdmin,并将其连接到服务器上的PostgreSQL数据库的过程。

介绍

pgAdmin是PostgreSQL及其相关数据库管理系统的开源管理和开发平台。 用Python和jQuery编写,它支持PostgreSQL中的所有功能。 您可以使用pgAdmin执行从编写基本SQL查询到监视数据库和配置高级数据库体系结构的所有操作。

在本教程中,我们将介绍在Ubuntu 18.04服务器上安装和配置最新版本的pgAdmin,通过Web浏览器访问pgAdmin,并将其连接到服务器上的PostgreSQL数据库的过程。

先决条件

要完成本教程,您需要:

第1步 - 安装pgAdmin及其依赖项

在撰写本文时,最新版本的pgAdmin是pgAdmin 4,而通过官方Ubuntu存储库提供的最新版本是pgAdmin 3.不再支持pgAdmin 3,项目维护人员建议安装pgAdmin 4.在此步骤中,我们将介绍在虚拟环境中安装最新版本的pgAdmin 4的过程(根据项目开发团队的建议)并使用apt安装其依赖项。

首先,如果您最近没有这样做,请更新服务器的包索引:

sudo apt update

接下来,安装以下依赖项。 这些包括libgmp3-dev ,一个多精度算术库; libpq-dev ,包括头文件和一个有助于与PostgreSQL后端通信的静态库; libapache2-mod-wsgi-py3 ,一个Apache模块,允许您在Apache中托管基于Python的Web应用程序:

sudo apt install libgmp3-dev libpq-dev libapache2-mod-wsgi-py3

在此之后,创建一些目录,其中pgAdmin将存储其会话数据,存储数据和日志:

sudo mkdir -p /var/lib/pgadmin4/sessions
sudo mkdir /var/lib/pgadmin4/storage
sudo mkdir /var/log/pgadmin4

然后,将这些目录的所有权更改为非root用户和组。 这是必要的,因为它们目前由root用户拥有,但我们将从非root用户拥有的虚拟环境安装pgAdmin,安装过程涉及在这些目录中创建一些文件。 但是,在安装之后,我们会将所有权更改为www-data用户和组,以便将其提供给Web:

sudo chown -R sammy:sammy /var/lib/pgadmin4
sudo chown -R sammy:sammy /var/log/pgadmin4

接下来,打开您的虚拟环境。 导航到编程环境所在的目录并激活它。 遵循必备Python 3教程的命名约定,我们将转到environments目录并激活my_env环境:

cd environments/
source my_env/bin/activate

然后,将pgAdmin 4源代码下载到您的计算机上。 要查找最新版本的源代码,请导航至pgAdmin 4(Python Wheel)下载页面 ,然后单击最新版本的链接(v3.4,撰写本文时)。 这将带您进入PostgreSQL网站上的下载页面。 在那里,复制以.whl结尾的文件链接 - 用于Python发行版的标准构建包格式。 然后返回终端并运行以下wget命令,确保将链接替换为您从PostgreSQL站点复制的链接,该链接将.whl文件下载到您的服务器:

wget https://ftp.postgresql.org/pub/pgadmin/pgadmin4/v3.4/pip/pgadmin4-3.4-py2.py3-none-any.whl

接下来安装wheel组件,参考执行车轮包装标准。 这个包是一个Python库,用作构建轮子的扩展,包括一个用于处理.whl文件的命令行工具:

python -m pip install wheel

然后使用以下命令安装pgAdmin 4软件包:

python -m pip install pgadmin4-3.4-py2.py3-none-any.whl 

这需要安装pgAdmin及其依赖项。 但是,在将其连接到数据库之前,您需要对程序的配置进行一些更改。

第2步 - 配置pgAdmin 4

虽然已在服务器上安装了pgAdmin,但仍需要执行几个步骤,以确保它具有允许其正确提供Web界面所需的权限和配置。

pgAdmin的主配置文件config.py在任何其他配置文件之前读取。 其内容可以用作可以在pgAdmin的其他配置文件中指定的进一步配置设置的参考点,但是为了避免无法预料的错误,您不应该编辑config.py文件本身。 我们将对名为config_local.py的新文件添加一些配置更改,该文件将在主文件之后读取。

现在使用首选文本编辑器创建此文件。 在这里,我们将使用nano

nano my_env/lib/python3.6/site-packages/pgadmin4/config_local.py

在您的编辑器中,添加以下内容:

环境/ my_env / lib中/ python3.6 /站点包/ pgadmin4 / config_local.py
LOG_FILE = '/var/log/pgadmin4/pgadmin4.log'
SQLITE_PATH = '/var/lib/pgadmin4/pgadmin4.db'
SESSION_DB_PATH = '/var/lib/pgadmin4/sessions'
STORAGE_DIR = '/var/lib/pgadmin4/storage'
SERVER_MODE = True

以下是这五个指令的作用:

  • LOG_FILE :这定义了将存储pgAdmin日志的文件。
  • SQLITE_PATH :pgAdmin将用户相关数据存储在SQLite数据库中,该指令将pgAdmin软件指向此配置数据库。 由于此文件位于持久目录/var/lib/pgadmin4/ ,因此升级后用户数据不会丢失。
  • SESSION_DB_PATH :指定将用于存储会话数据的目录。
  • STORAGE_DIR :定义pgAdmin将存储其他数据的位置,例如备份和安全证书。
  • SERVER_MODE :将此指令设置为True pgAdmin在服务器模式下运行,而不是桌面模式。

请注意,每个文件路径都指向您在第1步中创建的目录。

添加这些行后,保存并关闭文件(按CTRL + X ,然后按Y ,然后按ENTER )。 使用这些配置后,运行pgAdmin安装脚本以设置登录凭据:

python my_env/lib/python3.6/site-packages/pgadmin4/setup.py

运行此命令后,您将看到一个提示,询问您的电子邮件地址和密码。 当您稍后访问pgAdmin时,这些将作为您的登录凭据,因此请务必记住或记下您在此处输入的内容:

. . .
Enter the email address and password to use for the initial pgAdmin user account:

Email address: sammy@example.com
Password: 
Retype password:

在此之后,停用您的虚拟环境:

deactivate 

回想一下您在config_local.py文件中指定的文件路径。 这些文件保存在您在第1步中创建的目录中,这些目录当前归非root用户所有。 但是,它们必须可由运行Web服务器的用户和组访问。 默认情况下,在Ubuntu 18.04上,这些是www-data用户和组,因此更新以下目录的权限,以便为这两个目录提供www-data所有权:

sudo chown -R www-data:www-data /var/lib/pgadmin4/
sudo chown -R www-data:www-data /var/log/pgadmin4/

这样,pgAdmin就完全配置了。 但是,该程序尚未从您的服务器提供,因此它仍然无法访问。 要解决此问题,我们将配置Apache以提供pgAdmin,以便您可以通过Web浏览器访问其用户界面。

第3步 - 配置Apache

Apache Web服务器使用虚拟主机来封装配置详细信息,并从单个服务器托管多个域。 如果您遵循先决条件Apache教程,则可能已在example.com.conf名称下设置了示例虚拟主机文件,但在此步骤中,我们将创建一个新的文件,我们可以从中为pgAdmin Web界面提供服务。

首先,请确保您位于根目录中:

cd /

然后在/sites-available/目录中创建一个名为pgadmin4.conf的新文件。 这将是您服务器的虚拟主机文件:

sudo nano /etc/apache2/sites-available/pgadmin4.conf

将以下内容添加到此文件中,确保更新突出显示的部分以与您自己的配置一致:

/etc/apache2/sites-available/pgadmin4.conf
<VirtualHost *>
    ServerName your_server_ip

    WSGIDaemonProcess pgadmin processes=1 threads=25 python-home=/home/sammy/environments/my_env
    WSGIScriptAlias / /home/sammy/environments/my_env/lib/python3.6/site-packages/pgadmin4/pgAdmin4.wsgi

    <Directory "/home/sammy/environments/my_env/lib/python3.6/site-packages/pgadmin4/">
        WSGIProcessGroup pgadmin
        WSGIApplicationGroup %{GLOBAL}
        Require all granted
    </Directory>
</VirtualHost>

保存并关闭虚拟主机文件。 接下来,使用a2dissite脚本禁用默认虚拟主机文件000-default.conf

sudo a2dissite 000-default.conf

注意:如果您遵循先决条件Apache教程,则可能已禁用000-default.conf并设置示例虚拟主机配置文件(在先决条件中名为example.com.conf )。 如果是这种情况,则需要使用以下命令禁用example.com.conf虚拟主机文件:

sudo a2dissite example.com.conf

然后使用a2ensite脚本启用pgadmin4.conf虚拟主机文件。 这将创建从/sites-available/目录中的虚拟主机文件到/sites-enabled/目录的符号链接:

sudo a2ensite pgadmin4.conf

在此之后,测试您的配置文件的语法是否正确:

apachectl configtest

如果您的配置文件全部按顺序排列,您将看到Syntax OK 如果在输出中看到错误,请重新打开pgadmin4.conf文件并仔细检查您的IP地址和文件路径是否都正确,然后重新运行configtest

在输出中看到Syntax OK后,重新启动Apache服务,以便它读取新的虚拟主机文件:

sudo systemctl restart apache2

pgAdmin现已完全安装和配置。 接下来,我们将讨论如何在将浏览器连接到PostgreSQL数据库之前从浏览器访问pgAdmin。

第4步 - 访问pgAdmin

在本地计算机上,打开首选的Web浏览器并导航到服务器的IP地址:

http://your_server_ip

到达后,您将看到一个类似于以下内容的登录屏幕:

pgAdmin登录界面

输入您在第2步中定义的登录凭据,然后您将进入pgAdmin欢迎屏幕:

pgAdmin欢迎页面

现在您已经确认可以访问pgAdmin界面,剩下要做的就是将pgAdmin连接到PostgreSQL数据库。 不过,在此之前,您需要对PostgreSQL超级用户的配置进行一次小的更改。

第5步 - 配置PostgreSQL用户

如果您遵循先决条件PostgreSQL教程 ,您应该已经在服务器上安装了PostgreSQL,并设置了新的超级用户角色和数据库。

默认情况下,在PostgreSQL中,您使用“标识协议”或“ident”身份验证方法作为数据库用户进行身份验证。 这涉及PostgreSQL获取客户端的Ubuntu用户名并将其用作允许的数据库用户名。 在许多情况下,这可以提高安全性,但是在您希望外部程序(例如pgAdmin)连接到其中一个数据库的情况下,它也会导致问题。 要解决此问题,我们将为此PostgreSQL角色设置一个密码,该密码将允许pgAdmin连接到您的数据库。

在终端上,以超级用户角色打开PostgreSQL提示符:

sudo -u sammy psql

在PostgreSQL提示符下,更新用户配置文件以获得您选择的强密码:

ALTER USER sammy PASSWORD 'password';

然后退出PostgreSQL提示符:

\q

接下来,返回浏览器中的pgAdmin 4界面,找到左侧的“ 浏览器”菜单。 右键单击“ 服务器”以打开上下文菜单,将鼠标悬停在“ 创建”上 ,然后单击“ 服务器...”

创建Server上下文菜单

这将导致在浏览器中弹出一个窗口,您将在其中输入有关服务器,角色和数据库的信息。

在“ 常规”选项卡中,输入此服务器的名称。 这可以是您想要的任何内容,但您可能会发现使其具有描述性是有帮助的。 在我们的示例中,服务器名为Sammy-server-1

创建服务器 - 常规选项卡

接下来,单击“ 连接”选项卡。 主机名/地址字段中,输入localhost 默认情况下, 端口应设置为5432 ,这将适用于此设置,因为这是PostgreSQL使用的默认端口。

在“ 维护数据库”字段中,输入要连接的数据库的名称。 请注意,必须已在服务器上创建此数据库。 然后,分别输入您在“ 用户名”和“ 密码”字段中配置的PostgreSQL用户名和密码。

创建服务器 - 连接选项卡

其他选项卡中的空白字段是可选的,只有在您需要特定设置时才需要填写它们。 单击“ 保存”按钮,数据库将显示在“ 浏览器”菜单中的“ 服务器”下。

您已成功将pgAdmin4连接到PostgreSQL数据库。 您可以使用pgAdmin仪表板中的任何内容来完成PostgreSQL提示。 为了说明这一点,我们将创建一个示例表,并通过Web界面使用一些示例数据填充它。

第6步 - 在pgAdmin仪表板中创建表

从pgAdmin仪表板中,找到窗口左侧的“ 浏览器”菜单。 单击Servers(1)旁边的加号( + 以展开其中的树状菜单。 接下来,单击您在上一步中添加的服务器左侧的加号(在我们的示例中为Sammy-server-1 ),然后展开Databases ,您添加的数据库的名称(在我们的示例中为sammy ),然后架构(1) 您应该看到如下树状菜单:

扩展的浏览器树菜单

右键单击Tables列表项,然后将光标悬停在Create上并单击Table ....

创建表上下文菜单

这将打开一个Create-Table窗口。 在此窗口的“ 常规”选项卡下,输入表的名称。 这可以是你想要的任何东西,但为了简单起见,我们将其称为table-01

创建表 - 常规选项卡

然后导航到Columns选项卡并单击窗口右上角的+号以添加一些列。 添加列时,您需要为其指定名称数据类型 ,如果您选择的数据类型需要,则可能需要选择长度

此外, PostgreSQL官方文档指出,向表中添加主键通常是最佳做法。 主键是一个约束,指示可以用作表中行的特殊标识符的特定列或列集。 这不是必需的,但如果您要将一个或多个列设置为主键,请将最右侧的开关从“ ”切换为“ 是”

单击“ 保存”按钮以创建表。

创建表 - 已打开主键的列选项卡

到目前为止,您已经创建了一个表并为其添加了几列。 但是,列尚未包含任何数据。 要将数据添加到新表,请在“ 浏览器”菜单中右键单击表的名称,将光标悬停在“ 脚本”上 ,然后单击“ 插入脚本”

INSERT脚本上下文菜单

这将在仪表板上打开一个新面板。 在顶部,您将看到一个部分完成的INSERT语句,其中包含相应的表和列名称。 继续使用一些虚拟数据替换问号( ),确保您添加的数据与您为每列选择的数据类型一致。 请注意,您还可以通过在一组新括号中添加每一行来添加多行数据,每组括号用逗号分隔,如以下示例所示。

如果您愿意,可以使用此示例INSERT语句替换部分完成的INSERT脚本:

INSERT INTO public."table-01"(
    col1, col2, col3)
    VALUES ('Juneau', 14, 337), ('Bismark', 90, 2334), ('Lansing', 51, 556);

示例INSERT语句

单击闪电图标( )以执行INSERT语句。 要查看表格及其中的所有数据,请再次在“ 浏览器”菜单中右键单击表格名称,将光标悬停在“ 查看/编辑数据”上 ,然后选择“ 所有行”

查看/编辑数据,所有行上下文菜单

这将打开另一个新面板,在该面板下方的数据输出选项卡中,您可以查看该表中保存的所有数据。

查看数据 - 示例数据输出

有了这个,您已经成功创建了一个表,并通过pgAdmin Web界面填充了一些数据。 当然,这只是一种可以通过pgAdmin创建表的方法。 例如,可以使用SQL创建和填充表,而不是使用此步骤中描述的基于GUI的方法。

结论

在本指南中,您学习了如何从Python虚拟环境安装pgAdmin 4,配置它,使用Apache将其提供给Web,以及如何将其连接到PostgreSQL数据库。 此外,本指南介绍了一种可用于创建和填充表的方法,但pgAdmin不仅可用于创建和编辑表。

有关如何充分利用pgAdmin所有功能的更多信息,我们建议您查看项目文档 您还可以通过我们关于该主题的社区教程了解有关PostgreSQL的更多信息。