用uWSGI和nginx设置Django和你的web服务器
本教程针对想要设置生产Web服务器的Django用户。它将指导您完成设置Django所需的步骤,以便与uWSGI和nginx完美配合。它涵盖了所有三个组件,提供了完整的Web应用程序和服务器软件堆栈。
Django是一个高级Python Web框架,鼓励快速开发和清晰,实用的设计。
nginx(发音为engine-x)是一个免费的,开源的,高性能的HTTP服务器和反向代理,以及一个IMAP / POP3代理服务器。
关于本教程的一些注意事项
注意
这是一个教程。它并非旨在为部署主题提供参考指南,更不用说详尽的参考。
nginx和uWSGI是Django部署的不错选择,但它们不是唯一的,也不是“官方”的。两者都有很好的替代方案,我们鼓励您对它们进行调查。
我们在这里部署的Django的方式是一个很好的方式,但它不是的唯一途径; 出于某些目的,它甚至可能不是最好的方式。
然而,这是一种可靠而简单的方法,这里介绍的材料将向您介绍熟悉用于部署Django的软件所需的概念和过程。通过为您提供工作设置,并排练您必须采取的步骤,它将为您提供探索实现此目标的其他方法的基础。
注意
本教程对您使用的系统做了一些假设。
假设您使用的是类Unix系统,并且它具有类似aptitude的包管理器。但是,如果您需要提出诸如“在Mac OS X上相当于aptitude的内容?”之类的问题,您将能够非常轻松地找到这种帮助。
虽然本教程假设Django 1.4或更高版本,它将在您的新项目中自动创建一个wsgi模块,但这些说明适用于早期版本。您将需要自己获取Django wsgi模块,并且您可能会发现Django项目目录结构略有不同。
概念
Web服务器面向外部世界。它可以直接从文件系统提供文件(HTML,图像,CSS等)。但是,它无法直接与Django应用程序对话; 它需要运行应用程序的东西,从Web客户端(例如浏览器)提供请求并返回响应。
Web服务器网关接口 - WSGI - 完成这项工作。WSGI是Python标准。
uWSGI是一个WSGI实现。在本教程中,我们将设置uWSGI,以便创建一个Unix套接字,并通过uwsgi协议提供对Web服务器的响应。最后,我们完整的组件堆栈将如下所示:
the web client <-> the web server <-> the socket <-> uwsgi <-> Django
在开始设置uWSGI之前
的virtualenv
确保您对我们需要安装的软件有所了解(我们将在后面介绍如何安装系统级uwsgi):
virtualenv uwsgi-tutorial
cd uwsgi-tutorial
source bin/activate
Django的
将Django安装到virtualenv中,创建一个新项目,并cd
进入项目:
pip install Django
django-admin.py startproject mysite
cd mysite
关于域和端口
在本教程中,我们将调用您的域名example.com
。替换您自己的FQDN或IP地址。
在整个过程中,我们将使用端口8000为Web服务器发布,就像Django runserver默认情况下那样。您当然可以使用您想要的任何端口,但我选择了这个端口,因此它不会与Web服务器可能已经做的任何事情冲突。
基本的uWSGI安装和配置
将uWSGI安装到virtualenv中
pip install uwsgi
当然还有其他方法可以安装uWSGI,但是这个方法和其他方法一样好。请记住,您需要安装Python开发包。对于Debian或Debian派生的系统(如Ubuntu),您需要安装的是pythonX.Y-dev
XY,即您的Python版本。
基础测试
创建一个名为的文件test.py
:
# test.py
def application(env, start_response):
start_response('200 OK', [('Content-Type','text/html')])
return [b"Hello World"] # python3
#return ["Hello World"] # python2
注意
考虑到Python 3的要求bytes()
。
运行uWSGI:
uwsgi --http :8000 --wsgi-file test.py
选项意味着:
http :8000
:使用协议http,端口8000wsgi-file test.py
:加载指定的文件test.py
这应该直接向端口8000上的浏览器发送“hello world”消息。访问:
http://example.com:8000
去检查。如果是这样,则表示以下堆栈组件有效:
the web client <-> uWSGI <-> Python
测试你的Django项目
现在我们希望uWSGI做同样的事情,但要运行Django站点而不是 test.py
模块。
如果您还没有这样做,请确保您的mysite
项目确实有效:
python manage.py runserver 0.0.0.0:8000
如果可行,请使用uWSGI运行它:
uwsgi --http :8000 --module mysite.wsgi
module mysite.wsgi
:加载指定的wsgi模块
将浏览器指向服务器; 如果该网站出现,则意味着uWSGI能够从您的virtualenv为您的Django应用程序提供服务,并且此堆栈可以正常运行:
the web client <-> uWSGI <-> Django
现在我们通常不会让浏览器直接与uWSGI对话。这是网络服务器的工作,它将充当中间人。
基本nginx的
安装nginx的
sudo apt-get install nginx
sudo /etc/init.d/nginx start # start nginx
现在通过在端口80上的Web浏览器中访问它来检查nginx是否正在服务 - 您应该从nginx收到消息:“欢迎使用nginx!”。这意味着完整堆栈的这些组件正在协同工作:
the web client <-> the web server
如果别的东西是已经服务的80端口,你想有使用nginx的,你就必须重新配置nginx的服务于不同的端口上。但是对于本教程,我们将使用端口8000。
为您的网站配置nginx的
您将需要该uwsgi_params
文件,该文件nginx
位于uWSGI发行版的目录中,或者来自https://github.com/nginx/nginx/blob/master/conf/uwsgi_params
将其复制到项目目录中。稍后我们将告诉nginx引用它。
现在在/ etc / nginx / sites-available /目录中创建一个名为mysite_nginx.conf的文件,并将其放入其中:
# mysite_nginx.conf
# the upstream component nginx needs to connect to
upstream django {
# server unix:///path/to/your/mysite/mysite.sock; # for a file socket
server 127.0.0.1:8001; # for a web port socket (we'll use this first)
}
# configuration of the server
server {
# the port your site will be served on
listen 8000;
# the domain name it will serve for
server_name example.com; # substitute your machine's IP address or FQDN
charset utf-8;
# max upload size
client_max_body_size 75M; # adjust to taste
# Django media
location /media {
alias /path/to/your/mysite/media; # your Django project's media files - amend as required
}
location /static {
alias /path/to/your/mysite/static; # your Django project's static files - amend as required
}
# Finally, send all non-media requests to the Django server.
location / {
uwsgi_pass django;
include /path/to/your/mysite/uwsgi_params; # the uwsgi_params file you installed
}
}
这个conf文件告诉nginx从文件系统提供媒体和静态文件,以及处理需要Django干预的请求。对于大型部署,让一个服务器处理静态/媒体文件,另一个处理Django应用程序被认为是一种好习惯,但是现在,这样做会很好。
从/ etc / nginx / sites-enabled打开此文件的符号链接,以便nginx可以看到它:
sudo ln -s ~/path/to/your/mysite/mysite_nginx.conf /etc/nginx/sites-enabled/
部署静态文件
在运行nginx之前,您必须收集静态文件夹中的所有Django静态文件。首先你需要编辑mysite / settings.py添加:
STATIC_ROOT = os.path.join(BASE_DIR, "static/")
然后跑
python manage.py collectstatic
基本的nginx测试
重启nginx:
sudo /etc/init.d/nginx restart
要检查的媒体文件被送达正确,添加一个名为图像 media.png
的,然后访问http://example.com:8000/media/media.png -如果这个工程,你就会知道,至少这是nginx的文件服务正确。/path/to/your/project/project/media directory
值得的不仅仅是重新启动nginx,而是实际停止然后再次启动它,这将通知您是否存在问题,以及它的位置。
nginx的和uWSGI和test.py了
让我们让nginx与“hello world” test.py
应用程序对话。
uwsgi --socket :8001 --wsgi-file test.py
这几乎和以前一样,除了这次选项之一是不同的:
socket :8001
:使用协议uwsgi,端口8001
nginx同时已配置为在该端口上与uWSGI通信,并与外部世界在端口8000上进行通信。访问:
去检查。这是我们的堆栈:
the web client <-> the web server <-> the socket <-> uWSGI <-> Python
同时,您可以尝试查看http://example.com:8001上的uswgi输出 - 但很可能,它不起作用,因为您的浏览器会说http,而不是uWSGI,尽管您应该看到来自uWSGI的输出你的终端。
使用Unix套接字而不是端口
到目前为止,我们已经使用了TCP端口套接字,因为它更简单,但实际上使用Unix套接字比使用端口更好 - 开销更少。
编辑mysite_nginx.conf
,将其更改为匹配:
server unix:///path/to/your/mysite/mysite.sock; # for a file socket
# server 127.0.0.1:8001; # for a web port socket (we'll use this first)
并重新启动nginx。
再次运行uWSGI:
uwsgi --socket mysite.sock --wsgi-file test.py
这次socket
选项告诉uWSGI使用哪个文件。
在浏览器中尝试http://example.com:8000/。
如果那不起作用
检查你的nginx错误日志(/var/log/nginx/error.log)。如果你看到类似的东西:
connect() to unix:///path/to/your/mysite/mysite.sock failed (13: Permission
denied)
那么可能你需要管理套接字上的权限,以便允许nginx使用它。
尝试:
uwsgi --socket mysite.sock --wsgi-file test.py --chmod-socket=666 # (very permissive)
要么:
uwsgi --socket mysite.sock --wsgi-file test.py --chmod-socket=664 # (more sensible)
您可能还需要将您的用户添加到nginx的组(可能是www-data),反之亦然,这样nginx就可以正确地读取和写入您的套接字。
值得保持nginx日志的输出在终端窗口中运行,以便在故障排除时轻松引用它。
用uwsgi和nginx运行Django应用程序
让我们运行我们的Django应用程序:
uwsgi --socket mysite.sock --module mysite.wsgi --chmod-socket=666
现在uWSGI和nginx应该不仅仅是一个“Hello World”模块,而是你的Django项目。
配置uWSGI以使用.ini文件运行
我们可以将与uWSGI一起使用的相同选项放入文件中,然后让uWSGI运行该文件。它使管理配置变得更容易。
创建一个名为的文件`mysite_uwsgi.ini`
:
# mysite_uwsgi.ini file
[uwsgi]
# Django-related settings
# the base directory (full path)
chdir = /path/to/your/project
# Django's wsgi file
module = project.wsgi
# the virtualenv (full path)
home = /path/to/virtualenv
# process-related settings
# master
master = true
# maximum number of worker processes
processes = 10
# the socket (use the full path to be safe
socket = /path/to/your/project/mysite.sock
# ... with appropriate permissions - may be needed
# chmod-socket = 664
# clear environment on exit
vacuum = true
并使用此文件运行uswgi:
uwsgi --ini mysite_uwsgi.ini # the --ini option is used to specify a file
再一次,测试Django站点是否按预期工作。
安装uWSGI全系统
到目前为止,uWSGI仅安装在我们的virtualenv中; 我们需要在系统范围内安装它以进行部署。
停用你的virtualenv:
deactivate
并在系统范围内安装uWSGI:
sudo pip install uwsgi
# Or install LTS (long term support).
pip install https://projects.unbit.it/downloads/uwsgi-lts.tar.gz
uWSGI wiki描述了几个安装过程。在系统范围内安装uWSGI之前,值得考虑选择哪个版本以及最合适的安装方式。
再次检查您仍然可以像以前一样运行uWSGI:
uwsgi --ini mysite_uwsgi.ini # the --ini option is used to specify a file
皇帝模式
uWSGI可以在'emperor'模式下运行。在这种模式下,它会密切关注uWSGI配置文件的目录,并为每个找到的实例生成实例('vassals')。
每当修改配置文件时,皇帝都会自动重启附庸。
# create a directory for the vassals
sudo mkdir /etc/uwsgi
sudo mkdir /etc/uwsgi/vassals
# symlink from the default config directory to your config file
sudo ln -s /path/to/your/mysite/mysite_uwsgi.ini /etc/uwsgi/vassals/
# run the emperor
uwsgi --emperor /etc/uwsgi/vassals --uid www-data --gid www-data
您可能需要使用sudo运行uWSGI:
sudo uwsgi --emperor /etc/uwsgi/vassals --uid www-data --gid www-data
选项意味着:
emperor
:在哪里寻找附庸(配置文件)uid
:进程启动后的用户标识gid
:进程启动后的组ID
检查网站; 它应该运行。
让uWSGI启动系统引导时
最后一步是在系统启动时自动完成所有操作。
对于许多系统,最简单(如果不是最好)的方法是使用该rc.local
文件。
编辑/etc/rc.local
并添加:
/usr/local/bin/uwsgi --emperor /etc/uwsgi/vassals --uid www-data --gid www-data --daemonize /var/log/uwsgi-emperor.log
在“退出0”行之前。
这应该是它!
进一步的配置
重要的是要了解这是一个教程,以帮助您入门。你也需要阅读nginx的和uWSGI文件,并研究在生产环境中部署之前可用的选项。
nginx和uWSGI都受益于友好社区,他们能够提供有关配置和使用的宝贵建议。
nginx的
nginx的一般配置不在本教程的范围内,尽管您可能希望它在生产网站上侦听端口80而不是8000。
您还应该配置一个单独的nginx位置块来提供非Django文件。例如,通过uWSGI提供静态文件效率很低。相反,直接从Nginx提供服务并完全绕过uWSGI。
uWSGI
uWSGI支持多种配置方式。请参阅uWSGI的文档和 示例。
本教程中提到了一些uWSGI选项; 您应该查看生产中的部署包括的其他内容(此处列出了示例设置):
env = DJANGO_SETTINGS_MODULE=mysite.settings # set an environment variable
safe-pidfile = /tmp/project-master.pid # create a pidfile
harakiri = 20 # respawn processes taking more than 20 seconds
limit-as = 128 # limit the project to 128 MB
max-requests = 5000 # respawn processes after serving 5000 requests
daemonize = /var/log/uwsgi/yourproject.log # background the process & log