如何在 Ubuntu 22.04 上使用 Gunicorn 和 Nginx 提供 Flask 应用

教程

Nginx Python Ubuntu

A previous version of this tutorial was written by Kathleen Juell.

介绍

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

先决条件

开始本指南之前，您应该具备以下条件：

已安装Ubuntu 22.04的服务器，并拥有具有sudo特权的非root用户。请参考我们的初始服务器设置指南进行操作。
已安装Nginx，请按照在Ubuntu 22.04上安装Nginx的步骤1和2进行操作。
配置为指向您服务器的域名。您可以在Namecheap购买一个，或在Freenom免费获取一个。您可以通过查阅相关的域和DNS文档了解如何将域指向DigitalOcean。请确保创建以下DNS记录：
- 一个A记录，将your_domain指向您服务器的公共IP地址。
- 一个A记录，将www.your_domain指向您服务器的公共IP地址。
熟悉WSGI规范，Gunicorn服务器将使用它与您的Flask应用程序进行通信。这个讨论详细介绍了WSGI。

步骤2 — 创建Python虚拟环境

接下来，您将设置一个虚拟环境，以将Flask应用程序与系统上的其他Python文件隔离开来。

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

sudo apt install python3-venv

接下来，为您的Flask项目创建一个父目录。创建完成后，使用cd命令进入该目录：

mkdir ~/myproject
cd ~/myproject

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

python3 -m venv myprojectenv

这将在您的项目目录中安装一个名为myprojectenv的目录中安装一个本地的Python副本和pip。

在虚拟环境中安装应用程序之前，您需要激活它。通过输入以下命令来激活：

source myprojectenv/bin/activate

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

步骤 5 — 配置 Nginx 代理请求

您的 Gunicorn 应用服务器现在应该已经启动并正在运行，等待在项目目录中的套接字文件上接收请求。现在您可以通过对其配置文件进行一些小的修改，来配置 Nginx 将 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;
}

接下来，添加一个匹配每个请求的位置块。在此块内，您将包含指定一些需要设置的通用代理参数的 proxy_params 文件。然后，您将使用 proxy_pass 指令将请求传递到您定义的套接字：

/etc/nginx/sites-available/myproject

server {
    listen 80;
    server_name your_domain www.your_domain;

    location / {
        include proxy_params;
        proxy_pass http://unix:/home/sammy/myproject/myproject.sock;
    }
}

完成后保存并关闭文件。

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

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

将文件放在该目录中后，您可以测试语法错误：

sudo nginx -t

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

sudo systemctl restart nginx

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

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

您现在应该能够在Web浏览器中导航到您服务器的域名：

http://your_domain

您应该能够看到您应用程序的输出：

注意：如果Nginx无法访问gunicorn的套接字文件，您将收到HTTP 502网关错误。通常情况下，这是因为用户的主目录不允许其他用户访问其中的文件。

如果您的套接字文件名为/home/sammy/myproject/myproject.sock，请确保/home/sammy至少具有0755权限。您可以使用chmod这样更改权限：

sudo chmod 755 /home/sammy

然后重新加载页面，查看HTTP 502错误是否消失。

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

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应用程序的Gunicorn日志。

步骤6 —— 安全应用程序

为了确保您服务器的流量保持安全，让我们为您的域名获取一个SSL证书。有多种方法可以实现这一点，包括从Let’s Encrypt获取免费证书，生成自签名证书，或者从其他提供商购买证书并按照《在Ubuntu 22.04上为Nginx创建自签名SSL证书的步骤2到6》进行配置Nginx来使用它。为了迅速起见，我们将选择第一种选项（Let’s Encrypt）。

使用apt安装Certbot的Nginx包：

sudo apt install 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

您应该再次看到您的应用输出，以及您浏览器的安全指示器，该指示器应该表明该站点已经安全。

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

Flask 是一个非常简单但极其灵活的框架，旨在为您的应用程序提供功能，而不限制结构和设计。您可以使用本指南中描述的通用堆栈来提供您设计的 Flask 应用程序。

Source:
https://www.digitalocean.com/community/tutorials/how-to-serve-flask-applications-with-gunicorn-and-nginx-on-ubuntu-22-04

如何在 Ubuntu 22.04 上使用 Gunicorn 和 Nginx 提供 Flask 应用

介绍

先决条件

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

步骤2 — 创建Python虚拟环境

第3步 — 设置Flask应用程序

创建一个示例应用

创建WSGI入口点

第四步 —— 配置Gunicorn

步骤 5 — 配置 Nginx 代理请求

步骤6 —— 安全应用程序

结论