1、前言
本篇文章是翻译 A Complete Beginner’s Guide to Django 系列的最后一篇文章 A Complete Beginner’s Guide to Django - Part 7,因为搜索找了很久都没有找到对应的中文翻译篇(如果有,就是我没有找到…),又因为这个系列真的非常的好,简单,容易,非常适配入门,所以就打算自已试试翻译,也当是自己学习入门的一步吧!
简介(Introduction)
欢迎来到我们教程系列的最后一部分!这篇文章,我们将把Django应用程序部署到生产服务器。我们还将为我们的服务器配置Email服务和HTTPS证书。
首先,我想到了给一个使用虚拟专用服务器(VPS)的例子,它更通用,然后使用一个平台比如 Heroku 服务。但它我写得太详细了,所以本教程我最终偏向关于VPS的内容。
我们的项目已经上线啦!您可以在阅读本文之前点击在线查看,这是我们本文要部署的应用程序:www.djangoboards.com。
版本控制(Version Control)
版本控制是软件开发中非常重要的话题。特别是在团队开发中同时开发多个功能,并一起维护项目代码时。无论是一个开发人员项目还是多个开发人员项目,每个项目都应该使用版本控制。
版本控制系统有几种选择。也许是因为GitHub的流行,Git 成为版本控制的实际标准。所以如果你不熟悉版本控制,Git是一个很好的入门起点。一般有很多相关的教程,课程和资源,因此遇到问题很容易找到帮助。
GitHub和Code School有一个关于Git的很棒的互动教程,这是一个非常好的介绍Git的网站。几年前我就开始从SVN转到Git。
这是一个非常重要的话题,我其实应该从第一个教程开始讲Git。但事实是我希望本教程系列的重点放在Django上。如果Git这东西对您来说都是新的,请不要担心。一步一步入门是很重要的。也许你的第一个项目并不完美。重要的是要坚持学习和慢慢提高你的技能,但要有恒心!
关于Git的一个非常好的事情是它不仅仅是一个版本控制系统。围绕它建立了丰富的工具和服务生态系统。一些很好的例子比如持续集成、部署、代码审查、代码质量和项目管理。
使用Git来支持Django项目的部署过程非常有用。这是从源代码存储库中拉取最新版本或在出现问题时回滚到特定版本的便捷方式。有许多服务使用Git来集成,以便执行自动化测试和部署。
如果您没有在本地计算机上安装Git,请从 https://git-scm.com/downloads 下载和安装。
Git 基本配置(Basic Setup)
首先,设置你电脑的Git身份:
1 | git config --global user.name "Vitor Freitas" |
译者注:
- git config –global user.name “xxx”: 设置git操作者名称
- git config –global user.email “email” 设置git操作者邮箱
这2个配置的名字和邮箱,会记录在git操作记录中。
在项目根目录(与manage.py相同的目录)中,初始化一个git存储库:
1 | git init |
1 | Initialized empty Git repository in /Users/vitorfs/Development/myproject/.git/ |
检查存储库的状态:
1 | git status |
1 | On branch master |
在继续添加源文件之前,请在项目根目录中创建名为**.gitignore**的新文件。这个特殊的文件将帮助我们保持Git仓库的干净,保证缓存文件或日志这样的不必要的文件不会添加到Git仓库中。
您可以从 GitHub 获取 Python项目的通用.gitignore文件。
确保将它从 Python.gitignore 重命名为 .gitignore(点很重要!)。
您可以补充 .gitignore 文件内容,告诉它(Git)忽略SQLite数据库文件,例如:
.gitignore 文件内容:
1 | __pycache__/ |
现在将文件添加到存储库:
1 | git add . |
请注意上面add
后面有一个点。上面的命令告诉Git 在当前目录中添加所有未跟踪的文件。(译者注,点表示所有,整句就表示添加所以文件到Git,除了.gitignore文件列出的要忽略。)
现在进行第一次提交:
1 | git commit -m "Initial commit" |
一定要写一个注释说明这个提交是什么,简要描述你改变了什么。
Git 远程仓库(Remote Repository)
现在让我们将 GitHub 设置为远程仓库。首先,在GitHub上创建一个免费帐户,然后在电子邮件中点击GitHub发来的验证链接确认您的电子邮件地址。然后您就能在GitHub上创建公开仓库(译者注:GitHub公开仓库是免费的,私有仓库收费。)。
现在,只需为仓库创建一个名称,不要勾选使用自述文件初始化它(initialize this repository with a README),也不要添加 Add .gitignore
或添加 Add a license
许可证。确保仓库开始为空:
创建仓库后,您应该看到如下内容:
现在让我们将其配置为我们的远程仓库:
1 | git remote add origin git@github.com:sibtc/django-boards.git |
现在将代码推送到远程服务器,即GitHub仓库:
1 | git push origin master |
我创建此仓库只是为了演示使用现有代码库创建远程仓库的过程。该项目的源代码正式托管在此仓库中:https://github.com/sibtc/django-beginners-guide。
项目配置(Project Settings)
无论代码是存储在公共或私有远程仓库中,都不应提交敏感信息并将其推送到远程仓库。这包括密钥,密码,API密钥等。
此时,我们必须在 settings.py 模块中处理两种特定类型的配置:
- 密钥和密码等敏感信息;
- 针对特定的环境配置。
密码和密钥可以存储在环境变量中或使用本地文件(未提交到远程仓库):
1 | # environment variables |
为此, 我在我开发的每个Django项目中都使用了一个名为 Python Decouple 的优秀实用功能库。它将搜索名为 .env 的本地文件以设置这配置变量,并将内容配置到环境变量。它还提供了一个定义默认值的接口,在适当时将数据转换为int,bool和list。
这不是强制性的,但我真的觉得它是一个非常有用的工具。它像Heroku这样的服务一样有魅力。
首先,让我们安装它:
1 | pip install python-decouple |
myproject/settings.py
1 | from decouple import config |
现在,我们可以将敏感信息放在一个名为**.env的特殊文件中(注意前面的点),该文件位于manage.py**文件所在的目录中:
1 | myproject/ |
.env 文件内容:
1 | SECRET_KEY=rqr_cjv4igscyu8&&(0ce(=sy=f2)p=f_wn&@0xsp7m$@!kp=d |
该**.ENV文件中忽略的.gitignore文件,所以每次我们要部署应用程序或在不同的机器上运行时,我们将创建一个.ENV**文件,并添加必要的配置。
现在让我们安装另一个库来帮助我们用简单一行代码来编写数据库连接。这样,在不同的环境中编写不同的数据库连接字符串会更容易:
1 | pip install dj-database-url |
目前,我们需要解耦的全部配置:
myproject/settings.py
1 | from decouple import config, Csv |
本地计算机的**.env**文件示例:
1 | SECRET_KEY=rqr_cjv4igscyu8&&(0ce(=sy=f2)p=f_wn&@0xsp7m$@!kp=d |
请注意,在DEBUG配置中我们给了一个默认值(True),因此在生产环境中我们可以忽略(注释)此配置,因此它将被自动设置为False,因为它生产环境应该是False的。
现在ALLOWED_HOSTS将被转换成一个列表**[‘.localhost’, ‘127.0.0.1’. ]。现在,这是在我们的本地机器上,为了生产,我们将其设置为类似于[‘.djangoboards.com’, ]**您拥有的任何域名。
这特定配置可确保您的应用程序仅提供给这个域名。
记录依赖库版本(Tracking Requirements)
跟踪项目的依赖关系是一个很好的做法,因此另一台机器上更容易安装它(依赖的环境)。
我们可以通过运行下面的命令来检查当前安装的Python依赖库:
1 | pip freeze |
在项目根目录中创建名为requirements.txt的文件,并在其中添加依赖项(就是上面 pip freeze
得到的项目所有的依赖库):
requirements.txt 文件内容:
1 | dj-database-url==0.4.2 |
我保留了pytz == 2017.2,因为它是由Django自动安装的。
您可以更新源代码仓库:
1 | git add . |
域名(Domain Name)
如果我们要正确部署Django应用程序,我们将需要一个域名(译者注:如果部署外网,给别人使用需要域名,但如果是内网使用,只有IP地址也可以访问。此处,作者意思要处理上线外网。)。拥有域名来为应用程序提供服务,配置电子邮件服务和配置https证书非常重要。
最近,我一直在使用 Namecheap 。您可以以8.88美元/年的价格获得.com域名,或者如果您只是尝试一下,您可以用 0.99美元/年 的价格注册.xyz域名。(译者注:在中国,可以注册阿里云、腾讯云等著名的注册商都有域名卖买,大家可自行搜索官网。)
无论如何,您可以自由使用任何注册商。为了演示部署过程,我注册了 www.DjangoBoards.com 域名。
部署策略(Deployment Strategy)
以下是我们将在本教程中使用的部署策略的概述:
云服务是使用 Digital Ocean 提供的虚拟专用服务器。您可以使用我的会员链接注册Digital Ocean以获得 免费的10美元信用额度(仅适用于新帐户)。(译者注:云服务商在中国可选择阿里云、腾讯云)
首先我们将使用 **NGINX**(译者注:Nginx是一个异步框架的 Web服务器,通常作为负载均衡器。),其商标是食人魔。NGINX将收到访问者对服务器的所有请求。但如果请求数据,它不会尝试做任何不聪明的事情(译者注:Nginx主要负责处理请求,并分发给文件系统或HTTP服务器等。)。它所要做的就是确定所请求的信息是否是一个可以自行提供的静态资源,或者它是否更复杂。如果是,它会将请求传递给 **Gunicorn**(译者注:Gunicorn“绿色独角兽”是一个被广泛使用的高性能的Python WSGI UNIX HTTP服务器,移植自Ruby的独角兽(Unicorn )项目,使用pre-fork worker模式,具有使用非常简单,轻量级的资源消耗,以及高性能等特点。)。
NGINX 还将配置 HTTPS证书。这意味着它只接受通过HTTPS的请求。如果客户端尝试通过HTTP请求,NGINX将首先将用户重定向到HTTPS,然后它才会决定如何处理请求链接。
我们还将安装此 certbot 以自动续订 Let’s Encrypt 的证书。(译者注:想了解更多内容,可阅读HTTPS 简介及使用官方工具 Certbot 配置 Let’s Encrypt SSL 安全证书详细教程 | Linux Story。)
Gunicorn是一个应用服务器。根据服务器拥有的CPU处理器数量,它可以通过生成多个同时工作的程序以并行处理多个请求。它管理工作负载并执行Python和Django代码。
Django是一个努力工作的代表。它可以访问数据库(PostgreSQL)或文件系统。但在大多数情况下,工作是在视图内部完成,渲染模板,以及过去几周我们编写过的所有内容。在Django处理请求之后,它会向Gunicorn返回一个响应,他将结果返回给NGINX,最终将响应传递给客户端。
我们还将安装**PostgreSQL**,一个优秀的数据库系统。由于Django的ORM系统,很容易切换数据库。(译者注:PostgreSQL被业界誉为“最先进的开源数据库”,面向企业复杂SQL处理的OLTP在线事务处理场景,支持NoSQL数据类型(JSON/XML/hstore)、支持GIS地理信息处理。)
最后一步是安装**Supervisor*。它是一个过程控制系统,它将密切关注Gunicorn和Django,以确保一切顺利进行。如果服务器重新启动,或者Gunicorn崩溃,它将自动重启。(译者注:Supervisor是一个Python开发的client/server系统,可以管理和监控nix上面的进程的工具。)
部署到VPS(Digital Ocean)(Deploying to a VPS (Digital Ocean))
您可以使用您喜欢的任何其他VPS(虚拟专用服务器)。配置应该非常相似,毕竟我们将使用Ubuntu 16.04 作为我们的服务器。
首先,让我们创建一个新的服务器(在Digital Ocean上,他们称之为“Droplet”)。选择Ubuntu 16.04:
选择尺寸。最小的空间就足够了:
然后为您的Droplet选择一个主机名(在我的例子为“django-boards”):
如果您有SSH密钥,则可以将其添加到您的帐户。然后,您将能够使用它登录服务器。否则,他们会通过电子邮件向您发送root密码。(译者注:SSH密钥可以不用输入密码就链接到服务器,具体可自行搜索了解更多。)
现在选择服务器的IP地址:
在我们登录服务器之前,让我们将域名指向此IP地址。这将节省一些时间,因为DNS设置通常需要几分钟才能传播。
所以这里我们添加了两条A记录,一条指向主域名“djangoboards.com”,另一条指向“www.djangoboards.com”。我们将使用NGINX配置规范URL。
现在让我们使用终端登录服务器:
1 | ssh root@45.55.144.54 |
然后你应该看到以下消息:
1 | You are required to change your password immediately (root enforced) |
设置新密码,然后开始配置服务器。
1 | sudo apt-get update |
如果在升级过程中收到任何提示,请选择”keep the local version currently installed”(保持当前安装的本地版本)选项。
Python 3.6
1 | sudo add-apt-repository ppa:deadsnakes/ppa |
PostgreSQL
1 | sudo apt-get -y install postgresql postgresql-contrib |
NGINX
1 | sudo apt-get -y install nginx |
Supervisor
1 | sudo apt-get -y install supervisor |
Virtualenv
1 | wget https://bootstrap.pypa.io/get-pip.py |
应用用户(Application User)
使用以下命令创建新用户:
1 | adduser boards |
通常,我只选择应用程序的名称。输入密码,并可选择在提示中添加一些额外信息。
现在将用户添加到sudoers列表:
1 | gpasswd -a boards sudo |
PostgreSQL数据库配置(PostgreSQL Database Setup)
首先切换到postgres用户:
1 | sudo su - postgres |
创建数据库用户:
1 | createuser u_boards |
创建一个新数据库并将用户设置为所有者:
1 | createdb django_boards --owner u_boards |
为用户定义一个强密码:
1 | psql -c "ALTER USER u_boards WITH PASSWORD 'BcAZoYWsJbvE7RMgBPzxOCexPRVAq'" |
我们现在可以退出postgres用户了:
1 | exit |
Django项目配置(Django Project Setup)
切换到应用程序用户:
1 | sudo su - boards |
开始前,我们先检查终端的位置:
1 | pwd |
首先,让我们用我们的代码克隆存储库:
1 | git clone https://github.com/sibtc/django-beginners-guide.git |
启动虚拟环境(virtualenv):
1 | virtualenv venv -p python3.6 |
初始化virtualenv:
1 | source venv/bin/activate |
安装依赖的库(译者注:从文件中读取依赖进行安装。):
1 | pip install -r django-beginners-guide/requirements.txt |
我们再添加两个额外的库,Gunicorn和PostgreSQL驱动程序:
1 | pip install gunicorn |
现在在**/home/boards/django-beginners-guide文件夹中,让我们创建一个.env**文件来存储数据库凭据,密钥和其他所有内容:
/home/boards/django-beginners-guide/.env
1 | SECRET_KEY=rqr_cjv4igscyu8&&(0ce(=sy=f2)p=f_wn&@0xsp7m$@!kp=d |
以下是数据库URL的语法:postgres://db_user
:db_password
@db_host
:db_port
/db_name
。
现在让我们迁移数据库,收集静态文件并创建一个超级用户:
1 | cd django-beginners-guide |
1 | python manage.py migrate |
现在静态文件:
1 | python manage.py collectstatic |
此命令将所有静态资产复制到外部目录,NGINX可以在该目录中为我们提供文件。稍后会详细介绍。
现在为应用程序创建一个超级用户:
1 | python manage.py createsuperuser |
配置Gunicorn(Configuring Gunicorn)
Gunicorn是负责在代理服务器后面执行Django代码的工具。
在**/home/boards中创建一个名为gunicorn_start**的新文件:
1 |
|
此脚本将启动应用程序服务器。我们提供了一些信息,例如Django项目的位置,用于运行服务器的应用程序用户等等。
现在让这个文件可执行:
1 | chmod u+x gunicorn_start |
创建两个空文件夹,一个用于套接字文件,另一个用于存储日志:
1 | mkdir run logs |
现在**/home/boards**里面的目录结构应该是这样的:
1 | django-beginners-guide/ |
其中staticfiles文件夹由创建collectstatic命令。
配置Supervisor(Configuring Supervisor)
首先,在 /home/boards/logs/ 文件夹中创建一个空的日志文件:
1 | touch logs/gunicorn.log |
现在创建一个新的supervisor文件:
1 | sudo vim /etc/supervisor/conf.d/boards.conf |
1 | [program:boards] |
保存文件并运行以下命令:
1 | sudo supervisorctl reread |
现在检查状态:
1 | sudo supervisorctl status boards |
1 | boards RUNNING pid 308, uptime 0:00:07 |
配置NGINX(Configuring NGINX)
下一步是设置NGINX服务器以提供静态文件并将请求传递给Gunicorn:
在 /etc/nginx/sites-available/ 中添加一个名为boards的新配置文件:
1 | upstream app_server { |
创建指向已启用站点的文件夹的引用链接:
1 | sudo ln -s /etc/nginx/sites-available/boards /etc/nginx/sites-enabled/boards |
删除默认的NGINX网站:
1 | sudo rm /etc/nginx/sites-enabled/default |
重启NGINX服务:
1 | sudo service nginx restart |
此时,如果DNS已经生效,则可能通过URL www.djangoboards.com 访问该网站。
配置电子邮件服务(Configuring an Email Service)
入门使用的最佳选择之一是 Mailgun。它提供了一个非常可靠的免费计划,每月包含12,000封电子邮件。
注册一个免费帐户。然后按照步骤操作,这非常简单。您必须与您注册域名的服务一起使用。在我的例子中,它是 Namecheap。
点击添加域以向您的帐户添加新域。按照说明操作,确保使用 “mg.” 子域名:
现在抓取第一组DNS记录,它是两个TXT记录:
使用您的注册商提供的网络界面将其添加到您的域中:
重复上述步骤,对MX记录做同样的事情:
将它们添加到域中:
现在这一步不是强制性的,但由于我们已经在这里,所以也配置一下:
添加所有DNS记录后,单击“立即检查DNS记录”按钮:
现在我们需要有一些耐心。有时需要一段时间来验证DNS。
同时,我们可以配置应用程序以接收连接参数。
myproject/settings.py
1 | EMAIL_BACKEND = config('EMAIL_BACKEND', default='django.core.mail.backends.smtp.EmailBackend') |
然后,我的本地计算机**.env**文件将如下所示:
1 | SECRET_KEY=rqr_cjv4igscyu8&&(0ce(=sy=f2)p=f_wn&@0xsp7m$@!kp=d |
我的线上(云服务器)**.env**文件看起来像这样:
1 | SECRET_KEY=rqr_cjv4igscyu8&&(0ce(=sy=f2)p=f_wn&@0xsp7m$@!kp=d |
您可以在Mailgun 的the Domain Information(域信息)部分中找到您的凭据。
- EMAIL_HOST: SMTP Hostname(SMTP主机名)
- EMAIL_HOST_USER: Default SMTP Login(默认SMTP登录)
- EMAIL_HOST_PASSWORD: Default Password(默认密码)
我们可以在线上服务器中测试新设置。在本地计算机上的settings.py文件中进行更改,将更改提交到远程仓库。然后,在服务器中拉出新代码并重新启动Gunicorn进程:
1 | git pull |
使用电子邮件凭据编辑**.env**文件。
然后重启Gunicorn进程:
1 | sudo supervisorctl restart boards |
现在我们可以尝试测试重置密码的邮件流程:
在Mailgun仪表板上,您可以获得有关电子邮件传递的一些统计信息:
配置HTTPS证书(Configuring HTTPS Certificate)
现在让我们使用 Let’s Encrypt 提供的一个很好的HTTPS证书来提高我们的应用程序的安全性。
设置HTTPS从未如此简单。更好的是,我们现在可以免费获得它。他们提供了一个名为certbot的解决方案 ,负责为我们安装和更新证书。这非常简单:
1 | sudo apt-get update |
现在安装证书:
1 | sudo certbot --nginx |
只需按照提示操作即可。当被问及:
1 | Please choose whether or not to redirect HTTP traffic to HTTPS, removing HTTP access. |
选择2
将所有HTTP流量重定向到HTTPS。
有了这个,该网站已经通过HTTPS提供服务:
设置证书的自动续订。运行以下命令编辑crontab文件:
1 | sudo crontab -e |
将以下行添加到文件末尾:
1 | 0 4 * * * /usr/bin/certbot renew --quiet |
该命令将每天凌晨4点运行。所有在30天内到期的证书将自动续订。
总结(Conclusions)
非常感谢所有关注本系列教程的人,给予评论和反馈!我真的很感激!这是该系列的最后一篇教程。我希望你喜欢它!
尽管这是教程系列的最后一部分,但我还是计划编写一些后续教程来探索其他有趣的主题,例如数据库优化以及在我们目前拥有的内容之上添加更多功能。
顺便说一句,如果您有兴趣为项目做出贡献,很少有人愿意免费提交pull
请求!该项目的源代码可在GitHub上获得:https://github.com/sibtc/django-beginners-guide/
另外,请告诉我您还想看到的其他内容!:-)
译者总结
翻译本文之前,从来没有翻译过技术文章。现在用一天时间翻译完,真的觉得翻译的工作很辛苦,以前看了很多翻译的文章,在这里感谢那些无私奉献的译者们!
在翻译过程中,有很多技术点,需要自已查一下资料,带出一些扩展;有一些技术知识,原作者一笔带过,又害怕读者看不懂,然后又想展开述;遇到一些自己不懂的技术,也是要硬头表去翻译;也有一些翻译的句子,反复多次斟酌文字,希望能够通俗易懂的描述出来。
最后,翻译只是第一步,理解了原作者的文章,并更好的学习到知识,简单明了的译文,是翻译的初心。当然,在这过程,也发现英文的重要性,希望大家也重视英文,为自己的技术视野更广,不断努力!正如文中作者说的,也许是你第一次遇到的知识,只有坚持,反复多看几次,慢慢的,你一定会懂的!恒心!
参考扩展
教程材料一共会被分为七个部分。
此教程将从安装、开发环境的准备,模型,视图,模板,URL到更高级的主题(如迁移,测试和部署)中详细探讨所有基本概念。
Vitor Freitas 原文系列:
公众号Python之禅 翻译:
- 一个完整的Django入门指南 - 第1部分
- Django入门指南-第2部分(系统设计)
- 一个完整的Django入门指南 - 第3部分:高级概念
- Django入门实践指南-第4章:模型设计
- Django入门实践指南-第5章:编写第一个视图函数
苍云横渡 翻译的Windows版本:
- 【第一部分-django论坛从搭建到部署】一个完整的Django入门指南 - 简书
- 【第二部分-django论坛从搭建到部署】一个完整的Django入门指南 - 简书
- 【第三部分-django论坛从搭建到部署】一个完整的Django入门指南 - 简书
- 【第四部分-django论坛从搭建到部署】一个完整的Django入门指南 - 简书
- 【第五部分-django论坛从搭建到部署】一个完整的Django入门指南 - 简书
- 【第六部分-django论坛从搭建到部署】一个完整的Django入门指南 - 简书
扩展阅读:
- git
- 关于Git的很棒的互动教程
- NGINX
- Gunicorn
- certbot
- HTTPS 简介及使用官方工具 Certbot 配置 Let’s Encrypt SSL 安全证书详细教程 | Linux Story
- PostgreSQL
- Supervisor
- 如有疑问,欢迎在评论区一起讨论!
- 如有不正确的地方,欢迎指导!
> 注:本文首发于 [iHTCboy's blog](https://iHTCboy.com),如若转载,请注来源