|
nginx+uWSGI+Python3. Установка и настройка, Ubuntu 16.04
Введение
В данном блоге приведу пример минимальной рабочей конфигурации, состоящей из связки nginx+uWSGI+Python3, необходимой для взаимодействия python-приложений с веб-сервером.
nginx — веб-сервер и почтовый прокси-сервер,использующий не потоковую, управляемую событиями архитектуру, работающий на Unix-подобных операционных системах. Начиная с версии 0.7.52 появилась экспериментальная сборка под Microsoft Windows.
WSGI (англ. Web Server Gateway Interface) — стандарт взаимодействия между Python-программой, выполняющейся на стороне сервера и веб-сервером. Тем самым, WSGI предоставляет простой и универсальный интерфейс между большинством веб-серверов и веб-приложениями или фреймворками.
uWSGI — веб-сервер и сервер веб-приложений, первоначально реализованный для запуска приложений Python через протокол WSGI. Используется как для разворачивания тестовой среды разработчика ПО, так и для управления облачными сервисами, предлагающими хостинг приложений на Python (и его фреймворках) и других языка программирования. Способен трансформировать запросы стандартного веб-сервера в формат, который может обработать приложение.
Протокол uwsgi (в нижнем регистре) является бинарной реализацией протокола WSGI, оптимизированном для ускорения взаимодействия сервера и приложений.
Подготовка рабочего места и настройка виртуального окружения Python3
Необходимо установить все все интересующие нас компоненты, инсталяцию которых мы выполним с помощью инструментов apt и pip3.
apt (advanced packaging tool) — программа для установки, обновления и удаления программных пакетов в операционных системах Debian и основанных на них (Ubuntu, Linux Mint и т. п.).
pip3 - это система управления пакетами, которая используется для установки и управления программными пакетами, написанными на Python (pip3 для версий Python 3+, pip для Python2).
Обновим пакеты и установим nginx:
| Bash | 1
2
| sudo apt-get update
sudo apt-get install nginx |
|
Теперь необходимо установить виртуальную среду Python. Главная задача виртуальной среды – создание изолированной среды для проектов Python (для избежания разного рода зависимостей пакетов, версий и т.д). Мы используем Python3, поэтому у нас уже есть модуль venv, установленный в стандартной библиотеке (Для Python2 - pip install virtualenv).
Приступим к созданию структуры приложения. В домашней директории текущего пользователя (~, /home/peoples) создадим папку, в которой мы развернём виртуальную среду и будем хранить точку входа приложения WSGI. И сразу же перейдём в созданную директорию:
| Bash | 1
2
| mkdir ~/cyb/
cd ~/cyb |
|
Далее здесь мы создадим виртуальную среду, которая будет называться xv:
Таким образом, в каталоге xv развёрнуто новое виртуально окружение Python. Активируем его работу:
Командная строка изменилась. Это говорит о том, что виртуальная среда успешно запущена:
Когда виртуальная среда активна, все устанавливаемые приложения Python будут помещены в иерархию этого каталога.
Установка uWSGI
Установим uWSGI сервер с помощью pip3:
Создание приложения согласно спецификации WSGI
WSGI приложения имеют достаточно точную структуру.
По стандарту, они должны удовлетворять следующим требованиям:- должны быть вызываемыми (callable) объектами (обычно это функции или методы)
- принимать два параметра:
- словарь переменных окружения (environ)[2]
- обработчик запроса (start_response)[3]
- вызывать обработчик запроса с кодом HTTP-ответа и HTTP-заголовками
- возвращать итерируемый объект с телом ответа
Создадим python-файл с названием wsgi.py в нашей директории:
Теперь поместим туда код WSGI приложения, согласно предъявляемым требованиям:
| Python | 1
2
3
| def application(env, start_response):
start_response('200 OK', [('Content-Type','text/html')])
return [b"Hellom, Cyber Forum!"] |
|
По умолчанию uWSGI будет искать точку входа application, потому функция имеет соответствующее название.
Зачастую, подобного рода файлы использоваться как ссылки на остальной код приложения( Django-проекты включают файл wsgi.py по умолчанию, Flask application и т.д.).
Приложение готово, деактивируем виртуальную среду:
Создание конфигурационного файла uWSGI
Для запуска сервера uWSGI создадим конфигурационный .ini-файл и заполним его:
| Code | 1
2
3
4
5
6
7
8
9
10
11
12
| [uwsgi]
module = wsgi:application # указывает точку входа приложения (файл-wsgi, функция - application)
master = true # указывает на то, что приложение является ведущим (мастер) процессом
processes = 5 # порождает 5 рабочих процессов
chdir = /home/peoples/cyb # Корневая папка проекта (полный путь)
home = /home/peoples/cyb/xv # полный путь к виртуальному окружению
socket = /hone/peoples/cyb/cyb.sock # полный путь к файлу сокета (по этому пути будет создан сокет)
chmod-socket = 777 # права доступа к файлу сокета (или отдельной командой в оболочке: sudo chmod 777 cyb.sock)
vacuum = true # очищать окружение от служебных файлов uwsgi по завершению
die-on-term = true # для поддержки файла Upstart
plugins = python3
touch-reload = /home/peoples/cyb/cyb_reload.log #если выполнить команду touch то произойдет перезапуск uwsgi демона |
|
Запустим сконфигурированный файл:
| Bash | 1
2
3
| cd /home/peoples/cyb
. xv/bin/activate
uwsgi --ini cyb.ini& |
|
Для того, чтобы обновить состояние файлов (после внесения изменений), которые видит сервер необходимо выполнить:
| Bash | 1
2
| uwsgi --ini xyi.ini&
sudo nginx -s reload |
|
Настройка nginx
Далее настроим nginx как обратный прокси-сервер. nginx будет проксировать запросы при помощи протокола uwsgi для взаимодействия с uWSGI.
Создадим и заполним новый конфигурационный файл в каталоге sites-available директории nginx (имя файла должно совпадать с именем приложения).
| Bash | 1
| sudo nano /etc/nginx/sites-available/cyb |
|
| Code | 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
| server {
listen 80; # порт, который будет слушать веб-сервер в ожидании запросов
server_name 127.0.0.1; # доменное имя или ip-адрес, по которому происходит обращение к серверу
# 127.0.0.1 - адрес локального хоста компьютера
# лог-файлы доступа и ошибок
access_log /var/log/nginx_access.log;
error_log /var/log/nginx_error.log;
root /home/peoples/cyb; # основная директория проекта
# все запросы перенаправляются в uwsgi-приложение
location / {
include uwsgi_params;
uwsgi_pass unix:/home/peoples/cyb/cyb.sock; # путь к сокету, созданному .ini файлом
}
} |
|
Это минимальная пригодная для работы конфигурация. Очевидно, что возможна настройка огромного количества аспектов, выходящих за рамки этой статьи. Далее создаём символьную ссылку на каталог sites-enabled:
| Bash | 1
| sudo ln -s /etc/nginx/sites-available/cyb /etc/nginx/sites-enabled |
|
Теперь проверим файл сервера на предмет ошибок:
После перезапустим nginx:
| Bash | 1
2
| sudo service nginx restart
# или sudo nginx -s reload |
|
Проверка работоспособности
Откроем любой браузер и в адресной строке введём и нажмём Enter:
[url]http://127.0.0.1[/url]
На экране появится веб-станица с надписью:
Hellom, Cyber Forum!
Следовательно, всё настроено правильно и корректно работает.
Если появилась какая-то ошибка, то детальнее её исследовать можно в лог-файлах nginx:
access_log /var/log/nginx_access.log;
error_log /var/log/nginx_error.log;
Или
access_log /var/log/nginx/nginx_access.log;
error_log /var/log/nginx/nginx_error.log;
Автозапуск cyb.ini
Для того чтобы каждый раз не выполнять запуск cyb.ini вручную, можно сделать небольшой bash-скрипт и добавить его в автозагрузку:
| Bash | 1
| sudo nano /etc/init.d/script |
|
| Bash | 1
2
3
4
5
6
| #!/bin/bash
start on runlevel [2345]
stop on runlevel [!2345]
cd /home/peoples/cyb
. xv/bin/activate
uwsgi --ini cyb.ini |
|
Или же
| Bash | 1
2
3
4
5
6
7
8
9
| description "Test scrip"
author "Your Name"
start on runlevel [2345]
stop on runlevel [!2345]
script
cd /home/peoples/cyb
. xv/bin/activate
uwsgi --ini cyb.ini
end script |
|
Добавим файлу права и добавим в автозагрузку:
| Bash | 1
2
| sudo chmod +x /etc/init.d/script
sudo update-rc.d script defaults 90 |
|
Или вы хотите убрать файл из автозагрузки, то перед его удаление выполните:
| Bash | 1
2
| sudo update-rc.d -f script remove
sudo rm /etc/init.d/script |
|
|