Ubuntu+Nginx+uwsgi+Django部署手册

最近学习了如何在Ubuntu服务器上使用Nginx部署Django项目，特在这里记录一下，供大家学习参考

---

版本配置

这里列出了我所主要使用的各软件版本，如果在配置过程中发现部分文件或内容与你的不同，那可能就是软件版本不同造成的

Ubunu系统：Ubuntu Server 20.04 LTS 64位
Nginx：1.19.6
uwsgi：2.0.19.1
Django：2.2
Python：3.8（Ubuntu20内置的默认版本）

---

一、Django安装及创建初始项目

因为我是在一个刚初始化的Ubuntu系统上进行的部署，因此需要提前更新及安装一些常用的工具。已经拥有的同学可以略过这部分内容

1.更新apt

运行命令sudo apt-get update：

2.安装pip3

运行命令sudo apt install python3-pip：

安装完成后输入命令pip3 -V，如果出现类似于下图的版本提示，则说明安装成功：

3.安装Django

运行命令sudo pip3 install Django==2.2来安装2.2版本的Django：

4.创建一个初始项目hello

当Django安装完毕以后，我们就可以使用命令django-admin.py startproject hello在当前目录下创建一个名叫hello的项目：

这个命令执行完毕后，Django就会在当前目录下新建一个叫hello的目录了，此目录为该项目的根目录。我们进入根目录以后，将会看到里面相应的内容。具体文件内容是用来做什么的，这里不是重点，感兴趣的同学可以自行去Django官网了解。

记录一下，我这里Django项目的根目录为/home/ubuntu/hello，这个路径在后续Nginx配置中还会用到

5.配置Django

打开/home/ubuntu/hello/hello/settings.py文件，修改为如下内容：

"""
Django settings for hello project.

Generated by 'django-admin startproject' using Django 2.2.

For more information on this file, see
https://docs.djangoproject.com/en/2.2/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.2/ref/settings/
"""

import os

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = '2t1#$vjv3o-p27s$o-1ns+3&wkrf&r6g-*zm%1h))gkl==1*@x'

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

# 修改1：
# 允许运行的主机地址，填入你自己服务器的ip
# 如果不限制，可以填入'*'，但是不建议这样做
ALLOWED_HOSTS = ['xx.xx.xx.xx']


# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

ROOT_URLCONF = 'hello.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        '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',
            ],
        },
    },
]

WSGI_APPLICATION = 'hello.wsgi.application'


# Database
# https://docs.djangoproject.com/en/2.2/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}


# Password validation
# https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]


# Internationalization
# https://docs.djangoproject.com/en/2.2/topics/i18n/

LANGUAGE_CODE = 'en-us'

TIME_ZONE = 'UTC'

USE_I18N = True

USE_L10N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.2/howto/static-files/

STATIC_URL = '/static/'

# 修改2：
# 静态资源的根目录，当执行python manage.py collectstatic命令时
# 将会把本项目的静态资源统一收集到这个目录下
# 注意：这个目录体现在后续的Nginx配置文件中
STATIC_ROOT = os.path.join(BASE_DIR, '/home/ubuntu/hello/mystatic')

保存文件。

6.收集静态资源

上一步中我们已经定义好了静态资源的根目录，现在让我们切换到Django项目根目录（/home/ubuntu/hello）中，执行收集静态资源目录命令python manage.py collectstatic：

7.尝试运行

在Django项目根目录（/home/ubuntu/hello）下运行命令python manage.py migrate实现项目的初始迁移：

接着运行命令python manage.py runserver，则可以试运行项目：

当出现类似上图的结果时，说明项目已经成功运行了。

按住Ctrl+c即可退出试运行，然后我们就可以进行下一步的部署操作。

---

二、uwsgi安装

uwsgi相当于沟通Nginx与Django的一个桥梁，我们可以认为uwsgi也是一个web服务器，用来托管Django程序，当Nginx接收到用户请求后，将非静态资源交给uwsgi处理。因此三者之间的部署其实只需要我们处理好他们的通信问题即可。前面我们已经安装好了Django，那么下面就来处理下它和uwsgi之间的通信问题

1.安装uwsgi

执行命令sudo pip3 uwsgi安装uwsgi：

2.验证uwsgi与Django的通信

在Django项目根目录（/home/ubuntu/hello）下执行下面的命令（注意命令里你需要把/home/ubuntu/hello和hello/wsgi.py替换为自己实际的情况）：

uwsgi --http :8000 --chdir /home/ubuntu/hello --wsgi-file hello/wsgi.py --master --processes 4 --threads 2 --stats 127.0.0.1:8001

当出现类似如下效果时则说明二者能够正常通信：

按住Ctrl+c即可退出试运行，然后我们就可以进行下一步的部署操作。

3.以更简便的方式实现uwsgi与Django的通信

上一步我们已经实现了二者间的通信，但是我们需要在命令中加上很多参数，这不利于我们后面的使用。因此在本步骤中我们将这些命令写进一个配置文件里（uwsgi.ini），以更简便的方式实现uwsgi托管Django。

首先在Django项目根目录下（/home/ubuntu/hello）新建一个uwsgi.ini文件，然后里面填入如下内容：

# uwsgi.ini 配置文件
[uwsgi]

# Django 项目执行端口号
socket = :8888

# Django 项目根目录
chdir = /home/ubuntu/hello

# Django 的wsgi文件
module = hello.wsgi

# 允许主进程存在
master = true

# 最大进程数
processes = 5

# 当服务器退出时自动清理环境
vacuum = true

保存，退出。现在uwsgi托管的相关参数我们就写进文件里了，让我们使用更简单的命令uwsgi --ini uwsgi.ini再次实现uwsgi与Django的通信（注意此时我们应当位于Django项目的根目录下执行这个命令）：

当出现上图类似的内容时说明我们已经可以以更简单的方式实现uwsgi与Django通信了~

按住Ctrl+c即可退出试运行，然后我们就可以进行下一步的部署操作。

---

三、Nginx安装

现在我们已经解决了uwsgi与Django之间的通信问题，现在，让我们解决一下Nginx与uwsgi之间的通信问题

1.安装Nginx

step1 安装相关依赖：

sudo apt install curl gnupg2 ca-certificates lsb-release

step2 为稳定的nginx包建立apt存储库：

echo "deb http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" \
    | sudo tee /etc/apt/sources.list.d/nginx.list

step3 导入一个正式的nginx签名密钥，这样apt就可以验证包的真实性：

curl -fsSL https://nginx.org/keys/nginx_signing.key | sudo apt-key add -

step4 验证密钥的正确性：

sudo apt-key fingerprint ABF5BD827BD9BF62

如果输出与下图一致，则说明验证通过：

step5 更新apt

sudo apt update

step6 安装Nginx

sudo apt install nginx

2.配置Nginx

我这个Nginx版本为1.18.0，默认的配置文件为路径/etc/nginx/conf.d下的default.conf：

打开这个文件，将其内容更改如下：

server {
    listen       80;
    # 修改1：
    # 配置为你自己服务器的ip地址
    server_name  xx.xx.xx.xx;
    
    #charset koi8-r;
    #access_log  /var/log/nginx/host.access.log  main;

	# 修改2：
	# 设置路由转发策略
	# 直接访问80端口的话Nginx将会把这一请求转给uwsgi来处理
	# 注意：8888端口号即为我们在uwsgi.ini文件中配置的
	#       Django 项目执行端口号
    location / {
        include uwsgi_params;
        uwsgi_pass 127.0.0.1:8888;
        uwsgi_read_timeout 2;
    }
	
	# 修改3：
	# 当访问路径为/static时Nginx将会自行处理
	# 这里的/home/ubuntu/hello/mystatic路径为静态资源存储地址
	# 注意：该路径与前面Django的settings.py文件里设置的一致
    location /static {
        expires 30d;
        autoindex on;
        add_header Cache-Control private;
        alias /home/ubuntu/hello/mystatic;
    }

    #error_page  404              /404.html;

    # redirect server error pages to the static page /50x.html
    #
    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
        root   /usr/share/nginx/html;
    }

    # proxy the PHP scripts to Apache listening on 127.0.0.1:80
    #
    #location ~ \.php$ {
    #    proxy_pass   http://127.0.0.1;
    #}

    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
    #
    #location ~ \.php$ {
    #    root           html;
    #    fastcgi_pass   127.0.0.1:9000;
    #    fastcgi_index  index.php;
    #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
    #    include        fastcgi_params;
    #}

    # deny access to .htaccess files, if Apache's document root
    # concurs with nginx's one
    #
    #location ~ /\.ht {
    #    deny  all;
    #}
}

保存文件。然后执行命令sudo /sbin/./nginx启动Nginx（如果Nginx已启动，可以使用命令sudo nginx -s reload实现重启）：

启动后，在浏览器中输入我们服务器的ip地址：

会发现报错了。这是因为我们只是启动了Nginx，uwsgi还没有启动呢！让我们返回Django项目的根目录（/home/ubuntu/hello），然后使用命令uwsgi --ini uwsgi.ini启动uwsgi。此时再次刷新浏览器页面：

小火箭成功出来啦！说明此刻我们的配置全部完成了~

---

四、Tips

有时候部署就是这样，会出现各种各样的问题。本节记录有我在部署过程中出现的问题以及解决方案

1.uwsgi启动时提示端口被占用

有时候在我们启动uwsgi时会出现下面的错误：

这种错误出现的原因是希望启动的端口已经被占用了，所以启动失败。解决方法是使用命令sudo fuser -k 8888/tcp关掉被占用的端口，然后再执行启动命令即可~

2.修改default.conf文件或settings.py文件后无效果

这种情况很有可能是你没有重启Nginx服务或uwsgi服务，重启一下就好啦~