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

教學

Nginx Python Ubuntu

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

介紹

在本指南中，您將使用 Flask 微框架在 Ubuntu 22.04 上構建一個 Python 應用程序。本教程的大部分內容將涉及如何設置 Gunicorn 應用服務器，以及如何啟動應用程序並配置 Nginx 作為前端反向代理。

先決條件

在開始本指南之前，您應該擁有：

已安裝 Ubuntu 22.04 並擁有具有 sudo 權限的非根用戶的服務器。請參考我們的初始服務器設置指南進行指引。
已安裝 Nginx，按照在 Ubuntu 22.04 上安裝 Nginx 的第 1 和第 2 步進行操作。
配置指向您服务器的域名。您可以在Namecheap购买一个，或者在Freenom上免费获取一个。您可以通过查阅相关的域名和DNS文档了解如何将域名指向DigitalOcean。确保创建以下DNS记录：
- 一个A记录，指向您服务器的公共IP地址your_domain。
- 一个A记录，指向您服务器的公共IP地址www.your_domain。
熟悉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'

現在，您應該能夠在網頁瀏覽器中導航到您服務器的域名：

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

這將運行 certbot 並使用 --nginx 插件，使用 -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 的應用程序服務器都可以與之接口，然後配置了 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 虛擬環境

第三步 — 設置 Flask 應用程式

創建示範應用程式

建立 WSGI 入口點

第 4 步 — 配置 Gunicorn

步驟 5 — 配置 Nginx 以代理請求

第6步-保護應用程序

結論