Обслуживание приложений Django с помощью uWSGI и Nginx в Ubuntu 14.04

Python, Ubuntu | Amber | Комментировать запись

Django – это производительный веб-фреймворк для разработки приложений или сайтов в Python. Django также предоставляет простой сервер разработки для локального тестирования кода.

Примечание: Для производства необходимо искать более безопасный и мощный веб-сервер, так как этот сервер не справится с трафиком на этапе производства.

Данное руководство поможет установить и настроить в Ubuntu 14.04 все компоненты, необходимые для поддержки приложения и обработки клиентских запросов. Для этого будет использоваться сервер приложений uWSGI и обратный прокси-сервер Nginx.

Требования

Для выполнения данного руководства нужно предварительно настроить сервер Ubuntu 14.04 и создать не-root пользователя с доступом к sudo. Подробные инструкции по начальной настройке сервера и создании пользователей можно найти здесь.

Фреймворк Django в данном руководстве будет установлен в два разных виртуальных окружения Python, что позволит удовлетворить все индивидуальные требования каждого приложения.

После запуска приложения нужно настроить сервер приложений uWSGI, который будет использоваться в качестве интерфейса приложения и переформатировать запросы HTTP в вызовы Python. После этого нужно настроить обратный прокси-сервер Nginx.

Установка и настройка VirtualEnv и VirtualEnvWrapper

Проекты Django будут установлены в индивидуальное виртуальное окружение. Для этого нужно установить инструменты virtualenv (создаёт виртуальную среду Python) и virtualenvwrapper (добавляет несколько полезных функций virtualenv).

Для установки инструментов используйте pip, пакетный менеджер Python. Установить pip можно из официального репозитория Ubuntu.

sudo apt-get update
sudo apt-get install python-pip

Примечание: В Python 3 нужно использовать pip3 вместо pip (пакет называется python3-pip).

Теперь выполните глобальную установку virtualenv и virtualenvwrapper.

sudo pip install virtualenv virtualenvwrapper

Теперь можно настроить оболочку с помощью сценария virtualenvwrapper. Все виртуальные окружения будут помещены в каталог Env в домашнем каталоге. Чтобы настроить это, используется переменная WORKON_HOME. Добавьте её в сценарий инициализации оболочки.

Примечание: При использовании Python 3 и pip3 нужно добавить дополнительную строку в сценарий инициализации.

echo "export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3" >> ~/.bashrc

Независимо от версии Python запустите следующие команды:

echo "export WORKON_HOME=~/Env" >> ~/.bashrc
echo "source /usr/local/bin/virtualenvwrapper.sh" >> ~/.bashrc

Чтобы иметь доступ к новым функциям в текущей сессии, выполните команду:

source ~/.bashrc

Теперь в домашнем каталоге есть каталог Env, в котором хранятся виртуальные окружения проектов.

Создание проекта Django

Теперь нужно создать два виртуальных окружения и запустить два проекта.

Создание первого проекта Django

Создайте виртуальное окружение с помощью команд, доступных благодаря инструменту virtualenvwrapper.

Чтобы создать первое виртуальное окружение, введите:

mkvirtualenv firstsite

Эта команда создаст виртуальное окружение по имени firstsite, а также установит локальную версию Python и pip, которые можно использовать для создания изолированной среды разработки проекта. Командная строка изменится, указывая, что текущей средой является виртуальная среда Python

(firstsite)user@hostname:~$

В скобках указано имя текущего виртуального окружения. Теперь всё программное обеспечение, загруженное с помощью pip, будет установлено в индивидуальное окружение первого проекта и никак не повлияет на общее состояние системы.

Сначала нужно установить Django:

pip install django

Теперь создайте первый тестовый проект:

cd ~
django-admin.py startproject firstsite

Эта команда создаст в домашнем каталоге каталог firstsite. В нём хранится сценарий для управления новым проектом и ещё один одноимённый каталог, в котором будет находиться код проекта.

Откройте каталог первого уровня:

cd ~/firstsite

Для начала нужно переместить БД, чтобы инициализировать базу данных SQLite для проекта.

Примечание: При желании можно создать базу данных для приложения самостоятельно, но это выходит за рамки данного руководства.

./manage.py migrate

Теперь в домашнем каталоге есть файл БД по имени db.sqlite3. Создайте администратора.

./manage.py createsuperuser

Выберите имя пользователя, укажите контактный адрес электронной почты, а затем выберите и подтвердите пароль.

Затем откройте файл настроек проекта:

nano firstsite/settings.py

Теперь нужно создать отдельный каталог для хранения статических файлов сайта. Так Nginx сможет обслуживать их напрямую, а это улучшит производительность. Поместите каталог static в корневом каталоге проекта. Добавьте в конец конфигурационного файла следующую строку:

STATIC_ROOT = os.path.join(BASE_DIR, "static/")

Сохраните и закройте файл. Соберите статические файлы в этом каталоге:

./manage.py collectstatic

В каталоге проекта появится новый каталог static. Теперь протестируйте проект, временно запустив сервер разработки.

./manage.py runserver 0.0.0.0:8080

Это запустит сервер разработки на порт 8080. В браузере посетите свой домен или IP:

http://server_domain_or_IP:8080

На экране должна появиться такая страница:

It worked!
Congratulations on your first Django-powered page. [...]

Добавьте в ссылку сегмент /admin, чтобы получить доступ к форме аутентификации администратора. Введите учётные данные администратора, и на экране появится панель управления.

После этого можно остановить сервер разработки. Нажмите CTRL-C в терминале. Теперь можно приступать к разработке второго проекта.

Разработка второго проекта

Второй проект создаётся точно так же, как первый.

Вернитесь в домашний каталог и создайте второе виртуальное окружение. Установите Django.

cd ~
mkvirtualenv secondsite
pip install django

После этого откроется окружение нового проекта.

Создайте второй проект и откройте его каталог:

django-admin.py startproject secondsite
cd ~/secondsite

Инициализируйте базу данных и создайте пользователя с правами администратора:

./manage.py migrate
./manage.py createsuperuser

Откройте файл settings:

nano secondsite/settings.py

Добавьте каталог статических файлов:

STATIC_ROOT = os.path.join(BASE_DIR, "static/")

Сохраните и закройте файл. Соберите статические файлы в этот каталог.

./manage.py collectstatic

Запустите сервер разработки:

./manage.py runserver 0.0.0.0:8080

Сайт будет доступен по ссылке:

http://server_domain_or_IP:8080

Ссылка на интерфейс администратора:

http://server_domain_or_IP:8080/admin

Чтобы остановить сервер, нажмите CTRL-C.

Отключение виртуального окружения

Теперь нужно отключить виртуальное окружение, поскольку разработка проектов завершена:

deactivate

Чтобы вернуться в виртуальное окружение любого из проектов, введите:

workon firstsite
или
workon secondsite

В дальнейшей работе виртуальное окружение не нужно, потому отключите его:

deactivate

Сервер приложений uWSGI

Теперь нужно настроить uWSGI – сервер приложений, взаимодействующий с приложениями с помощью простого интерфейса WSGI.

Примечание: Больше информации о uWSGI можно найти в этом руководстве.

Установка uWSGI

В данном руководстве нужно установить uWSGI глобально – так будет проще обрабатывать несколько проектов Django.

Установите зависимости сервера:

sudo apt-get install python-dev

Теперь установите uWSGI.

sudo pip install uwsgi

Чтобы быстро протестировать сервер, передайте ему данные одного из сайтов. Например, можно попробовать обслужить первый проект:

uwsgi --http :8080 --home /home/user/Env/firstsite --chdir /home/user/firstsite -w firstsite.wsgi

Теперь uWSGI использует виртуальное окружение каталога ~/Env, чтобы получить доступ к каталогу проекта и использовать файл wsgi.py для обслуживания проекта. Сервер обслуживает HTTP на порте 8080. Откройте доменное имя или IP-адрес сервера в браузере, укажите порт 8080 (статические элементы интерфейса, как CSS, например, не будут работать). Чтобы остановить сервер, нажмите CTRL-C.

Создание конфигурационного файла

Запуск uWSGI из командной строки хорошо подходит для тестирования, но в реальном развёртывании это очень неудобно. Запустите сервер в режиме Emperor mode, что позволяет ведущему процессу управлять отдельными приложениями автоматически. Для этого используются конфигурационные файлы.

Создайте каталог для хранения таких файлов и откройте его:

sudo mkdir -p /etc/uwsgi/sites
cd /etc/uwsgi/sites

Теперь нужно создать конфигурационный файл для каждого проекта. uWSGI может читать конфигурации разных форматов. В данном руководстве используется формат ini.

Создайте файл для первого проекта:

sudo nano firstsite.ini

Добавьте заголовок [uwsgi], под которым нужно поместить все настройки. Добавьте несколько переменных, чтобы сделать файл более универсальным. Сразу после заголовка добавьте переменную project с именем проекта. Переменная uid будет хранить имя пользователя с доступом к sudo. Затем добавьте переменную base, в которой нужно указать путь к домашнему каталогу.

[uwsgi] project = firstsite
base = /home/user

Теперь нужно настроить uWSGI для поддержки проекта. Измените корневой каталог проекта с помощью опции chdir. Скомбинировать указанный домашний каталог и имя проекта можно с помощью синтаксиса %(переменная). Во время чтения файла это значение будет заменено.

Затем импортируйте callable application из файла wsgi.py в каталоге проекта.

[uwsgi] project = firstsite
base = /home/user
chdir = %(base)/%(project)
home = %(base)/Env/%(project)
module = %(project).wsgi:application

Создайте главный процесс с 5 рабочими процессами.

[uwsgi] project = firstsite
base = /home/user
chdir = %(base)/%(project)
home = %(base)/Env/%(project)
module = %(project).wsgi:application
master = true
processes = 5

Теперь нужно настроить прослушивание соединений. Ранее для тестирования uWSGI использовались HTTP и сетевой порт, но есть варианты и получше. Например, вместо порта можно использовать сокет. Этот вариант безопаснее и обеспечивает более высокую производительность. Сокеты используют не HTTP, а uwsgi – быстрый бинарный протокол для взаимодействия uWSGI с другими серверами. Nginx имеет встроенную поддержку uwsgi при проксировании.

Также следует изменить права на сокет. Опция vacuum автоматически очистит файл сокета после остановки сервиса.

[uwsgi] project = firstsite
base = /home/user
chdir = %(base)/%(project)
home = %(base)/Env/%(project)
module = %(project).wsgi:application
master = true
processes = 5
socket = %(base)/%(project)/%(project).sock
chmod-socket = 664
vacuum = true

Настройка первого проекта завершена. Сохраните и закройте файл.

Преимущество переменных в конфигурационных файлах состоит в том, что их можно повторно использовать. Скопируйте файл первого проекта и используйте его в качестве шаблона для настройки второго сайта.

sudo cp /etc/uwsgi/sites/firstsite.ini /etc/uwsgi/sites/secondsite.ini

Откройте скопированный файл:

sudo nano /etc/uwsgi/sites/secondsite.ini

В файле нужно изменить только переменную project.

Сохраните и закройте файл.

Сценарий Upstart для uWSGI

Django-проекты обслуживаются сервером приложений. Теперь нужно автоматизировать этот процесс. Для этого создайте сценарий Upstart в каталоге /etc/init.

sudo nano /etc/init/uwsgi.conf

Добавьте описание сервиса uWSGI и определите уровни выполнения.

description "uWSGI application server in Emperor mode"
start on runlevel [2345] stop on runlevel [!2345]

Установите пользователя и группу, с помощью которых будет запускаться сервис. С помощью параметров сокета, указанных в конфигурационном файле uWSGI, веб-сервер сможет записывать данные в сокет.

description "uWSGI application server in Emperor mode"
start on runlevel [2345] stop on runlevel [!2345] setuid user
setgid www-data

Укажите команду, которую нужно выполнить. Чтобы запустить uWSGI в режиме Emperor mode и обслуживать файлы проектов, добавьте:

description "uWSGI application server in Emperor mode"
start on runlevel [2345] stop on runlevel [!2345] setuid user
setgid www-data
exec /usr/local/bin/uwsgi --emperor /etc/uwsgi/sites

Пока что запустить этот сервис невозможно, поскольку он зависит от пользователя www-data. Сервис будет доступен после установки и настройки Nginx.

Nginx как обратный прокси-сервер

Загрузите пакет Nginx из стандартного репозитория Ubuntu.

sudo apt-get install nginx

После установки Nginx создайте виртуальный хост (блок server) для каждого проекта.

sudo nano /etc/nginx/sites-available/firstsite

Теперь у вас есть конфигурационный файл для первого проекта. Добавьте в файл такой код:

server {
listen 80;
server_name firstsite.com www.firstsite.com;
}

Укажите местонахождение статических файлов.

server {
listen 80;
server_name firstsite.com www.firstsite.com;
location = /favicon.ico { access_log off; log_not_found off; }
location /static/ {
root /home/user/firstsite;
}
}

С помощью директивы uwsgi_pass направьте трафик на сокет. Файл сокета в конфигурации называется firstproject.sock и находится в каталоге проекта.

С помощью директивы include добавьте параметры uwsgi для обработки соединений:

server {
listen 80;
server_name firstsite.com www.firstsite.com;
location = /favicon.ico { access_log off; log_not_found off; }
location /static/ {
root /home/user/firstsite;
}
location / {
include         uwsgi_params;
uwsgi_pass      unix:/home/user/firstsite/firstsite.sock;
}
}

Сохраните виртуальный хост.

Используйте этот файл как шаблон для виртуального хоста второго проекта.

sudo cp /etc/nginx/sites-available/firstsite /etc/nginx/sites-available/secondsite

Откройте новый файл:

sudo nano /etc/nginx/sites-available/secondsite

Замените все данные о firstsite информацией о secondsite. Измените server_name, указав домен второго проекта. В результате должно получиться так:

server {
listen 80;
server_name secondsite.com www.secondsite.com;
location = /favicon.ico { access_log off; log_not_found off; }
location /static/ {
root /home/user/secondsite;
}
location / {
include         uwsgi_params;
uwsgi_pass      unix:/home/user/secondsite/secondsite.sock;
}
}

Сохраните и закройте файл.

Создайте ссылки на новые конфигурационные файлы в каталоге sites-enabled.

sudo ln -s /etc/nginx/sites-available/firstsite /etc/nginx/sites-enabled
sudo ln -s /etc/nginx/sites-available/secondsite /etc/nginx/sites-enabled

Проверьте файлы на наличие ошибок:

sudo service nginx configtest

Если ошибок нет, перезапустите сервис Nginx:

sudo service nginx restart

Теперь можно запустить сервер приложений uWSGI.

sudo service uwsgi start

Теперь оба проекта доступны по доменным именам. Проверьте работу проектов и интерфейсов.

Примечание: После настройки обратного прокси-сервера Nginx настоятельно рекомендуется защитить подключения при помощи сертификатов SSL/TLS. В противном случае все данные будут передаваться в виде простого текста и легко могут быть перехвачены злоумышленниками. Сервис Let’s Encrypt позволяет получить бесплатный сертификат. Подробнее об этом – здесь.

Заключение

Теперь сервер приложений uWSGI обслуживает два приложения Django, которые находятся в индивидуальных виртуальных окружениях.