如何在Ubuntu20.04上使用uWSGI和Nginx服务Flask应用程序

本教程的先前版本由 Justin Ellingwood 编写

介绍

在本指南中，您将在 Ubuntu 20.04 上使用 Flask 微框架构建 Python 应用程序。本文的大部分内容将介绍如何设置 uWSGI 应用程序服务器以及如何启动应用程序并配置 Nginx 作为前端反向代理。

先决条件

在开始本指南之前，您应该具备：

安装了 Ubuntu 20.04 的服务器和具有 sudo 权限的非 root 用户。请按照我们的初始服务器设置指南获取指导。
按照如何在 Ubuntu 20.04 上安装 Nginx 的 步骤 1 到 3 安装 Nginx。
配置为指向您的服务器的域名。您可以在 Namecheap 上购买一个或在 Freenom 上免费获得一个。您可以通过遵循有关域和 DNS 的相关文档来了解如何将域指向 DigitalOcean。本教程假设您已创建以下 DNS 记录：
- 带有 your_domain 的 A 记录指向您服务器的公共 IP 地址。
- 带有 www.your_domain 的 A 记录指向您服务器的公共 IP 地址。

此外，熟悉 uWSGI、您将在本指南中设置的应用程序服务器以及 WSGI 规范可能会有所帮助。这个定义和概念的讨论详细讨论了两者。

第 1 步 — 从 Ubuntu 存储库安装组件

您的第一步是从 Ubuntu 存储库中安装您需要的所有部件。您需要安装的包包括 pip，Python 包管理器，用于管理您的 Python 组件。您还将获得构建 uWSGI 所需的 Python 开发文件。

首先，更新本地包索引：

sudo apt update

然后安装允许您构建 Python 环境的软件包。这些将包括 python3-pip，以及其他一些强大的编程环境所需的包和开发工具：

sudo apt install python3-pip python3-dev build-essential libssl-dev libffi-dev python3-setuptools

有了这些包，您就可以继续为您的项目创建虚拟环境了。

第 2 步 — 创建 Python 虚拟环境

Python 虚拟环境是一个独立的项目目录，其中包含特定版本的 Python 和给定项目所需的 Python 模块。这对于通过分别管理每个应用程序的依赖关系来将同一系统上的一个应用程序与其他应用程序隔离开来很有用。在这一步中，您将设置一个 Python 虚拟环境，您将从中运行您的 Flask 应用程序。

首先安装 python3-venv 包，它将安装 venv 模块：

sudo apt install python3-venv

接下来，为您的 Flask 项目创建一个父目录：

mkdir ~/myproject

创建后进入目录：

cd ~/myproject

通过键入以下命令创建一个虚拟环境来存储 Flask 项目的 Python 需求：

python3.8 -m venv myprojectenv

这会将 Python 和 pip 的本地副本安装到项目目录中名为 myprojectenv 的目录中。

在虚拟环境中安装应用程序之前，您需要激活它。通过键入：

source myprojectenv/bin/activate

您的提示将更改以指示您现在正在虚拟环境中操作。它看起来像这样：(myprojectenv)user@host:~/myproject$。

第 3 步 — 设置 Flask 应用程序

现在您已进入虚拟环境，您可以安装 Flask 和 uWSGI，然后开始设计您的应用程序。

首先，将 wheel 与 pip 的本地实例一起安装，以确保即使您的软件包缺少车轮档案也能安装：

pip install wheel

注意：无论你使用的是哪个版本的Python，在激活虚拟环境时，都应该使用pip命令（不是pip3）。

接下来，安装 Flask 和 uWSGI：

pip install uwsgi flask

创建示例应用程序

现在您有了可用的 Flask，您可以创建一个示例应用程序。 Flask 是一个微框架。它不包括功能更全面的框架可能提供的许多工具，主要作为一个模块存在，您可以将其导入项目以帮助您初始化 Web 应用程序。

虽然您的应用程序可能更复杂，但在此示例中，您将在一个名为 myproject.py 的文件中创建 Flask 应用程序：

nano ~/myproject/myproject.py

应用程序代码将存在于该文件中。它将导入 Flask 并实例化一个 Flask 对象。您可以使用它来定义在请求特定路由时要运行的功能：

~/myproject/myproject.py

from flask import Flask
app = Flask(__name__)

@app.route("/")
def hello():
    return "<h1 style='color:blue'>Hello There!</h1>"

if __name__ == "__main__":
    app.run(host='0.0.0.0')

本质上，这定义了向访问根域的任何人呈现的内容。完成后保存并关闭文件。如果您使用 nano 编辑文件，如上例所示，请按 CTRL + X、Y，然后按 ENTER。

如果您遵循初始服务器设置指南，则应该启用 UFW 防火墙。要测试应用程序，您需要允许访问端口 5000：

sudo ufw allow 5000

现在，您可以通过键入以下内容来测试您的 Flask 应用程序：

python myproject.py

您将看到如下输出，包括一个有用的警告，提醒您不要在生产中使用此服务器设置：

Output* Serving Flask app "myproject" (lazy loading)
 * Environment: production
   WARNING: Do not use the development server in a production environment.
   Use a production WSGI server instead.
 * Debug mode: off
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

在 Web 浏览器中访问服务器的 IP 地址，然后访问 :5000：

http://your_server_ip:5000

你会看到这样的东西：

完成后，在终端窗口中点击 CTRL + C 以停止 Flask 开发服务器。

创建 WSGI 入口点

接下来，创建一个文件作为应用程序的入口点。这将告诉你的 uWSGI 服务器如何与之交互。

调用文件 wsgi.py：

nano ~/myproject/wsgi.py

在此文件中，从您的应用程序中导入 Flask 实例，然后运行它：

~/myproject/wsgi.py

from myproject import app

if __name__ == "__main__":
    app.run()

完成后保存并关闭文件。

第 4 步 — 配置 uWSGI

现在，您的应用程序已编写并建立了一个入口点。您可以继续配置 uWSGI。

测试 uWSGI 是否可以为应用程序服务

作为第一步，测试以确保 uWSGI 可以通过将入口点的名称传递给它来正确地为您的应用程序提供服务。这是由模块的名称（减去 .py 扩展名）加上应用程序中可调用的名称构成的。在本教程的上下文中，入口点的名称是 wsgi:app。

此外，指定套接字，以便它将在公开可用的接口上启动，以及协议，以便它将使用 HTTP 而不是 uwsgi 二进制协议。使用您之前打开的相同端口号 5000：

uwsgi --socket 0.0.0.0:5000 --protocol=http -w wsgi:app

再次在 Web 浏览器的末尾添加 :5000 访问服务器的 IP 地址：

http://your_server_ip:5000

您将再次看到应用程序的输出：

当您确认它运行正常后，在您的终端窗口中按 CTRL + C。

您现在已经完成了虚拟环境，因此您可以停用它：

deactivate

任何 Python 命令现在都将再次使用系统的 Python 环境。

创建 uWSGI 配置文件

您已经测试了 uWSGI 能够为您的应用程序提供服务，但最终您将需要更健壮的东西以供长期使用。您可以为此创建一个带有相关选项的 uWSGI 配置文件。

将该文件放在您的项目目录中，并将其命名为 myproject.ini：

nano ~/myproject/myproject.ini

在内部，使用 [uwsgi] 标头启动文件，以便 uWSGI 知道应用设置。在此之下，指定模块本身——通过引用 wsgi.py 文件减去扩展名——以及文件中的可调用对象 app：

~/myproject/myproject.ini

[uwsgi]
module = wsgi:app

接下来，告诉 uWSGI 以主模式启动并生成五个工作进程来服务实际请求：

~/myproject/myproject.ini

[uwsgi]
module = wsgi:app

master = true
processes = 5

当您进行测试时，您在网络端口上暴露了 uWSGI。但是，您将使用 Nginx 来处理实际的客户端连接，然后将请求传递给 uWSGI。由于这些组件在同一台计算机上运行，因此最好使用 Unix 套接字，因为它更快、更安全。调用套接字 myproject.sock 并将其放在此目录中。

接下来，更改套接字的权限。稍后您将授予 uWSGI 进程的 Nginx 组所有权，因此您需要确保套接字的组所有者可以从中读取信息并对其进行写入。另外，添加 vacuum 选项并将其设置为 true；这将在进程停止时清理套接字：

~/myproject/myproject.ini

[uwsgi]
module = wsgi:app

master = true
processes = 5

socket = myproject.sock
chmod-socket = 660
vacuum = true

最后要做的是设置 die-on-term 选项。这有助于确保 init 系统和 uWSGI 对每个进程信号的含义有相同的假设。设置此项可以对齐两个系统组件，实现预期的行为：

~/myproject/myproject.ini

[uwsgi]
module = wsgi:app

master = true
processes = 5

socket = myproject.sock
chmod-socket = 660
vacuum = true

die-on-term = true

您可能已经注意到，这些行没有像您在命令行中那样指定协议。这是因为默认情况下，uWSGI 使用 uwsgi 协议，这是一种旨在与其他服务器通信的快速二进制协议。 Nginx 可以原生地使用这个协议，所以最好使用它而不是通过 HTTP 强制通信。

完成后，保存并关闭文件。

这样，uWSGI 就在你的系统上配置好了。为了让您更灵活地管理 Flask 应用程序，您现在可以将其配置为作为 systemd 服务运行。

第 5 步 — 创建一个 systemd 单元文件

Systemd 是一套工具，为管理系统服务提供了一个快速灵活的初始化模型。创建一个 systemd 单元文件将允许 Ubuntu 的 init 系统在服务器启动时自动启动 uWSGI 并为 Flask 应用程序提供服务。

在/etc/systemd/system目录下创建一个以.service结尾的单元文件开始：

sudo nano /etc/systemd/system/myproject.service

在里面，从 [Unit] 部分开始，它用于指定元数据和依赖项。然后在此处添加服务描述，并告诉 init 系统仅在达到网络目标后才启动此服务：

/etc/systemd/system/myproject.service

[Unit]
Description=uWSGI instance to serve myproject
After=network.target

接下来，打开 [Service] 部分。这将指定您希望进程在其下运行的用户和组。让您的常规用户帐户拥有该过程的所有权，因为它拥有所有相关文件。然后将组所有权授予 www-data 组，以便 Nginx 可以轻松地与 uWSGI 进程通信。请记住将此处的用户名替换为您的用户名：

/etc/systemd/system/myproject.service

[Unit]
Description=uWSGI instance to serve myproject
After=network.target

[Service]
User=sammy
Group=www-data

接下来，绘制工作目录并设置 PATH 环境变量，以便 init 系统知道该进程的可执行文件位于您的虚拟环境中。此外，指定启动服务的命令。 Systemd 要求您提供安装在虚拟环境中的 uWSGI 可执行文件的完整路径。在这里，我们传递您在项目目录中创建的 .ini 配置文件的名称。

请记住用您自己的信息替换用户名和项目路径：

/etc/systemd/system/myproject.service

[Unit]
Description=uWSGI instance to serve myproject
After=network.target

[Service]
User=sammy
Group=www-data
WorkingDirectory=/home/sammy/myproject
Environment="PATH=/home/sammy/myproject/myprojectenv/bin"
ExecStart=/home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini

最后，添加一个 [Install] 部分。如果您启用它在启动时启动，这将告诉 systemd 将该服务链接到什么。在这种情况下，将服务设置为在常规多用户系统启动并运行时启动：

/etc/systemd/system/myproject.service

[Unit]
Description=uWSGI instance to serve myproject
After=network.target

[Service]
User=sammy
Group=www-data
WorkingDirectory=/home/sammy/myproject
Environment="PATH=/home/sammy/myproject/myprojectenv/bin"
ExecStart=/home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini

[Install]
WantedBy=multi-user.target

这样，您的 systemd 服务文件就完成了。现在保存并关闭它。

您现在可以启动您创建的 uWSGI 服务：

sudo systemctl start myproject

然后启用它，使其在启动时启动：

sudo systemctl enable myproject

检查状态：

sudo systemctl status myproject

你会看到这样的输出：

Output● myproject.service - uWSGI instance to serve myproject
     Loaded: loaded (/etc/systemd/system/myproject.service; enabled; vendor preset: enabled)
     Active: active (running) since Wed 2020-05-20 13:21:39 UTC; 8h ago
   Main PID: 22146 (uwsgi)
      Tasks: 6 (limit: 2345)
     Memory: 25.5M
     CGroup: /system.slice/myproject.service
             ├─22146 /home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini
             ├─22161 /home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini
             ├─22162 /home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini
             ├─22163 /home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini
             ├─22164 /home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini
             └─22165 /home/sammy/myproject/myprojectenv/bin/uwsgi --ini myproject.ini

如果您发现任何错误，请务必在继续本教程之前解决它们。否则，您可以继续配置您的 Nginx 安装以将请求传递到 myproject.sock 套接字。

第 6 步 — 配置 Nginx 以代理请求

您的 uWSGI 应用程序服务器现在已启动并运行，等待项目目录中套接字文件的请求。在这一步中，您将配置 Nginx 以使用 uwsgi 协议将 Web 请求传递到该套接字。

首先在 Nginx 的 sites-available 目录中创建一个新的服务器块配置文件。为了与指南的其余部分保持一致，以下示例将此称为 myproject：

sudo nano /etc/nginx/sites-available/myproject

打开一个服务器块并告诉 Nginx 监听默认端口 80。此外，告诉它使用此块来请求您的服务器域名：

/etc/nginx/sites-available/myproject

server {
    listen 80;
    server_name your_domain www.your_domain;
}

接下来，添加一个匹配每个请求的位置块。在此块中，包含 uwsgi_params 文件，该文件指定需要设置的一些通用 uWSGI 参数。然后将请求传递给您使用 uwsgi_pass 指令定义的套接字：

/etc/nginx/sites-available/myproject

server {
    listen 80;
    server_name your_domain www.your_domain;

    location / {
        include uwsgi_params;
        uwsgi_pass unix:/home/sammy/myproject/myproject.sock;
    }
}

完成后保存并关闭文件。

要启用您刚刚创建的 Nginx 服务器块配置，请将文件链接到 sites-enabled 目录：

sudo ln -s /etc/nginx/sites-available/myproject /etc/nginx/sites-enabled

安装 Nginx 时，进程会自动在 sites-available 目录下建立一个名为 default 的服务器块配置文件，然后在该文件和 sites-enabled 目录之间创建符号链接. 如果您保留此符号链接，default 配置将阻止您的站点加载。您可以使用以下命令删除链接：

sudo unlink /etc/nginx/sites-enabled/default

之后，您可以通过键入以下内容来测试语法错误：

sudo nginx -t

如果返回没有任何问题，请重新启动 Nginx 进程以读取新配置：

sudo systemctl restart nginx

最后，再次调整防火墙。您不再需要通过端口 5000 进行访问，因此您可以删除该规则。然后，您可以允许访问 Nginx 服务器：

sudo ufw delete allow 5000
sudo ufw allow 'Nginx Full'

您现在可以在 Web 浏览器中导航到服务器的域名：

http://your_domain

您将看到您的应用程序输出：

如果您遇到任何错误，请尝试检查以下内容：

sudo less /var/log/nginx/error.log：检查 Nginx 错误日志。
sudo less /var/log/nginx/access.log：检查 Nginx 访问日志。
sudo journalctl -u nginx：检查 Nginx 进程日志。
sudo journalctl -u myproject：检查 Flask 应用的 uWSGI 日志。

第 7 步 — 保护应用程序

为确保到您的服务器的流量保持安全，请为您的域获取 SSL 证书。有多种方法可以做到这一点，包括从 Let's Encrypt 获取免费证书、生成自签名证书或从商业提供商处购买。为了方便起见，本教程解释了如何从 Let's Encrypt 获取免费证书。

首先，使用 apt 安装 Certbot 及其 Nginx 插件：

sudo apt install certbot python3-certbot-nginx

Certbot 提供了多种通过插件获取 SSL 证书的方式。 Nginx 插件将负责重新配置 Nginx 并在必要时重新加载配置。要使用此插件，请键入以下内容：

sudo certbot --nginx -d your_domain -d www.your_domain

这将使用 --nginx 插件运行 certbot，使用 -d 指定您希望证书有效的名称。

如果这是您第一次在此服务器上运行 certbot，系统将提示您输入电子邮件地址并同意服务条款。完成此操作后，certbot 将与 Let's Encrypt 服务器通信，然后运行质询以验证您是否控制了要为其请求证书的域。

如果成功，certbot 将询问您希望如何配置 HTTPS 设置：

OutputPlease choose whether or not to redirect HTTP traffic to HTTPS, removing HTTP access.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
1: No redirect - Make no further changes to the webserver configuration.
2: Redirect - Make all requests redirect to secure HTTPS access. Choose this for
new sites, or if you're confident your site works on HTTPS. You can undo this
change by editing your web server's configuration.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Select the appropriate number [1-2] then [enter] (press 'c' to cancel):

选择您的选择，然后点击 ENTER。配置将被更新，Nginx 将重新加载以获取新设置。 certbot 将以一条消息结束，告诉您该过程已成功以及您的证书存储在哪里：

OutputIMPORTANT NOTES:
 - Congratulations! Your certificate and chain have been saved at:
   /etc/letsencrypt/live/your_domain/fullchain.pem
   Your key file has been saved at:
   /etc/letsencrypt/live/your_domain/privkey.pem
   Your cert will expire on 2020-08-18. To obtain a new or tweaked
   version of this certificate in the future, simply run certbot again
   with the "certonly" option. To non-interactively renew *all* of
   your certificates, run "certbot renew"
 - Your account credentials have been saved in your Certbot
   configuration directory at /etc/letsencrypt. You should make a
   secure backup of this folder now. This configuration directory will
   also contain certificates and private keys obtained by Certbot so
   making regular backups of this folder is ideal.
 - If you like Certbot, please consider supporting our work by:

   Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate
   Donating to EFF:                    https://eff.org/donate-le

如果您按照先决条件中的 Nginx 安装说明进行操作，您将不再需要多余的 HTTP 配置文件：

sudo ufw delete allow 'Nginx HTTP'

要验证配置，请使用 https:// 再次导航到您的域：

https://your_domain

您将再次看到您的应用程序输出，以及浏览器的安全指示器，这应该表明该站点是安全的。

结论

在本指南中，您在 Python 虚拟环境中创建并保护了一个基本的 Flask 应用程序。然后，您创建了一个 WSGI 入口点，以便任何支持 WSGI 的应用程序服务器都可以与其交互，然后配置 uWSGI 应用程序服务器以提供此功能。之后，您创建了一个 systemd 服务文件以在启动时自动启动应用程序服务器。您还创建了一个 Nginx 服务器块，它将 Web 客户端流量传递到应用程序服务器，从而中继外部请求，并使用 Let's Encrypt 保护到服务器的流量。

Flask 是一个简单而灵活的框架，旨在为您的应用程序提供功能，而不会对结构或设计过于严格。您可以使用本指南中描述的通用堆栈来为您设计的烧瓶应用程序提供服务。