Django + Gunicorn + Nginx 部署之路

前言

最近，我已經成功將個人我的網站從 Flask 遷移到 Django 了，最先接觸 Django 的時候大概是在 4 年前，我記得那個時候 Django 中的路由配置使用 正則 來進行的，可是我有特別煩這個東西，因此就果斷棄坑了。而後今年年初的時候，我用 Flask 寫了一個個人我的網站，剛開始的時候功能仍是比較簡單，看着路由配置和部署規則都很方便，就果斷採用了。可是後來我想添加的功能愈來愈多的時候，我發現我已經愈來愈難掌控它了，正好最近我稍微看了一下 Django 這幾年的變化，最新的 2.2 版本仍是很不錯的，路由規則和 Flask 已經一致了，因此我就從新入坑了。

目前個人我的網站基本功能已經遷移完畢。可是在部署的時候，我遇到了一些問題，在網上看了一些解決方法，要麼太亂，要麼太舊，我的以爲都已經不太適用了。因此在這裏記錄一下個人部署過程。

部署

網上有不少都是用 UWSGI 的方式來部署，可是我我的比較喜歡 Gunicorn，因此如下內容我只是記錄了 Django + Gunicorn + Nginx 在 Ubuntu 上的部署方式相關內容。

步驟一

上傳網站源碼至目標服務器

因爲個人源碼是用 Github 來託管的，因此我直接執行下述命令來克隆個人網站源碼到服務器便可。

git clone https://github.com/your-name/repo-name.git

# 進入項目目錄
cd repo-name

# 建立並激活虛擬環境
python3 -m virtualenv venv
source venv/bin/activate

# 安裝項目依賴
pip install -r requirements.txt

目前個人網站採用的相關依賴包以下：

autopep8
Django
django-bootstrap4
django-ckeditor
gunicorn
Markdown
Pillow
python-slugify
requests

這裏有個坑須要注意，若是你使用了 awesome-slugify，請嘗試使用 python-slugify，由於有的服務器可能沒法正常安裝 awesome-slugify，具體 BUG 可參考：Clashes with python-slugify package。

步驟二

修改項目相關配置，並進行靜態資源收集

因爲我須要將個人網站部署到生產環境，因此我須要關閉 Django 的調試模式，並修改靜態資源相關配置，示例配置以下所示：

• settings.py

SECRET_KEY = os.environ.get('DJANGO_SECRET_KEY')

DEBUG = os.environ.get('DJANGO_DEBUG', False)

TEMPLATE_DEBUG = os.environ.get('DJANGO_TEMPLATE_DEBUG', False)

ALLOWED_HOSTS = ["*"]

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'static'),
]

MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

而後執行以下命令進行靜態資源收集：

python manage.py collectstatic

以後，我還須要建立一個 Gunicorn 進程的相關配置，示例配置以下所示：

• gunicorn.conf.py

# 安裝
# sudo pip3 install gunicorn

import sys
import os
import logging
import logging.handlers
from logging.handlers import WatchedFileHandler
import multiprocessing

BASE_DIR = '/home/hippie/hippiezhou.fun/src'
sys.path.append(BASE_DIR)

LOG_DIR = os.path.join(BASE_DIR, 'log')
if not os.path.exists(LOG_DIR):
    os.makedirs(LOG_DIR)

# 綁定的ip與端口
bind = "0.0.0.0:8000"

# 以守護進程的形式後臺運行
daemon = True

# 最大掛起的鏈接數，64-2048
backlog = 512

# 超時
timeout = 30

# 調試狀態
debug = False

# gunicorn要切換到的目的工做目錄
chdir = BASE_DIR

# 工做進程類型(默認的是 sync 模式，還包括 eventlet, gevent, or tornado, gthread, gaiohttp)
worker_class = 'sync'

# 工做進程數
workers = multiprocessing.cpu_count()

# 指定每一個工做進程開啓的線程數
threads = multiprocessing.cpu_count() * 2

# 日誌級別，這個日誌級別指的是錯誤日誌的級別(debug、info、warning、error、critical)，而訪問日誌的級別沒法設置
loglevel = 'info'

# 日誌格式
access_log_format = '%(t)s %(p)s %(h)s "%(r)s" %(s)s %(L)s %(b)s %(f)s" "%(a)s"'
# 其每一個選項的含義以下：
'''
h          remote address
l          '-'
u          currently '-', may be user name in future releases
t          date of the request
r          status line (e.g. ``GET / HTTP/1.1``)
s          status
b          response length or '-'
f          referer
a          user agent
T          request time in seconds
D          request time in microseconds
L          request time in decimal seconds
p          process ID
'''

# 訪問日誌文件
accesslog = os.path.join(LOG_DIR, 'gunicorn_access.log')
# 錯誤日誌文件
errorlog = os.path.join(LOG_DIR, 'gunicorn_error.log')
# pid 文件
pidfile = os.path.join(LOG_DIR, 'gunicorn_error.pid')

# 訪問日誌文件，"-" 表示標準輸出
accesslog = "-"
# 錯誤日誌文件，"-" 表示標準輸出
errorlog = "-"

# 進程名
proc_name = 'hippiezhou_fun.pid'

# 更多配置請執行：gunicorn -h 進行查看

以後可用經過以下方式啓動咱們的網站：

# 啓動方式(首先須要切換到項目根目錄，即和 manage.py 在同級目錄下)：

gunicorn -c gunicorn.conf.py website.wsgi:application

# 或
gunicorn website.wsgi:application -b 0.0.0.0:8000 -w 4 -k gthread

# 或
gunicorn website.wsgi:application -b 0.0.0.0:8000 -w 4 -k gthread  --thread 40 --max-requests 4096 --max-requests-jitter 512

# 查看進程
ps aux | grep gunicorn

# 退出 gunicorn
pkill gunicorn

步驟三

配置 Nginx

經過前兩步，咱們能夠成功將咱們的網站跑起來，可是目前還只能在內部訪問，因此咱們須要經過 Nginx 來作反向代理，供外網訪問。

執行下述命令進行安裝和配置

sudo apt-get install nginx

sudo service nginx start

# 備份默認配置
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.bak

# 啓動 Vim 修改咱們的網站配置
sudo vim /etc/nginx/sites-available/default

示例配置以下所示：

server{
        ...
        server_name hippiezhou.fun *.hippiezhou.fun;
        access_log /var/log/nginx/access.log;
        error_log /var/log/nginx/error.log;
        ...

        location / {
                # First attempt to serve request as file, then
                # as directory, then fall back to displaying a 404.
                # try_files $uri $uri/ =404;
                proxy_pass         http://127.0.0.1:8000; #此處要和你 gunicore 的 ip 和端口保持一致
                proxy_redirect     off;

                proxy_set_header   Host                 $host;
                proxy_set_header   X-Real-IP            $remote_addr;
                proxy_set_header   X-Forwarded-For      $proxy_add_x_forwarded_for;
                proxy_set_header   X-Forwarded-Proto    $scheme;
        }

        location /static {
                alias /root/hippiezhou.fun/src/staticfiles; # 這次須要配置爲你的網站對應的靜態資源的絕對路徑
        }

        location /media {
                alias /root/hipiezhou.fun/src/media; # 若是你的網站有上傳功能，須要配置該結點並指向目標路徑
        }

        ...
}

配置完成後執行下述操做便可將咱們的網站運行起來

# 若網站未啓動執行該命令
gunicorn -c gunicorn.conf.py website.wsgi:application

sudo nginx -t
sudo service nginx restart

若是不出意外，網站應該是能夠正常訪問，若是靜態資源依然不能訪問，打開網站的 開發者工具看一下是什麼錯誤。

• 若是是 404 的問題，請確保你的 settings 相關配置和我上面列出來的是一致的；
• 若是是 403 的問題，應該是 Nginx 無權訪問你指定的靜態資源，你須要修改 Nginx 的用戶類型，親執行下述命令

sudo vim /etc/nginx/nginx.conf

將 user 後面的值修改成 root，而後重啓 Nginx 便可。

最後，關於如何配置 HTTPS，這裏就不過多介紹了，直接列出相關示例腳本：

sudo apt-get update
sudo apt-get install software-properties-common
sudo add-apt-repository universe
sudo add-apt-repository ppa:certbot/certbot
sudo apt-get update
sudo apt-get install certbot python-certbot-nginx

sudo certbot --nginx

# sudo certbot renew --dry-run

sudo ufw allow https

sudo systemctl restart nginx

總結

在部署的過程當中，其實遇到最多的問題就是關於靜態資源沒法問題的問題，可是看到網上不少文章，都不同，而且有的寫的仍是錯誤的。因此這裏就總結一些。還好，一切順利。算是填了 4 年前的一個坑吧。

最後，打個廣告，歡迎訪問個人我的網站： hippiezhou.fun