【Ubuntu（ラズパイ）】Django＋Nginx＋uWSGI構成のWebアプリケーション開発

Nginx

NginxとはOSS（Open Source Software）のWebサーバーソフトウェアです。

近年WebサーバーとしてNginxを利用する人が急増しており、現在ではApacheに次いで２位のシェアを誇ります。
＊2020年８月にNetcraftという会社が出した調査によるとNginxがApacheを抜きシェア１位になったみたいです。

Nginxの詳しい設定ファイルについては以下記事をご参照ください。

【Nginx】設定ファイルとは（nginx.conf、conf.d、sites-available、uwsgi_paramsなど）

uWSGI

DjangoやFlaskといったWebアプリケーションフレームワークを利用する際、WebサーバーとWebアプリケーションフレームワークを繋ぐインターフェースが必要となります。

このインターフェースの定義をWSGI（Web Server Gateway Interface）といいます。

そしてWSGIをサポートするサーバーの一つがuWSGIです。

uWSGIは通信方法として、UNIXドメインソケットまたはHTTPでの通信をサポートしています。

Django

DjangoはPythonによるWebフレームワークの一つです。Webアプリケーション開発を簡単にする様々な機能を有します。

PythonWebフレームワークの中では人気・知名度が最も高いです。Djangoについてより詳しい説明は以下記事をご参照ください。

【django】Webサイト・アプリを作成するまでの一連の流れ

Nginxのインストール

Nginxは2004年にリリースされたWebサーバーであり、Apacheと共に非常に人気があります。NginxはApacheよりも高速であり、大量の処理が得意です。

本記事ではWebサーバーにNginx（エンジンエックス）をubuntuにインストールします。

$ sudo apt install nginx

UbuntuにNginxをインストールする方法は以下記事で詳しく解説しております。

【Ubuntu】Nginxをインストールする方法（特徴と利用用途）

Pythonのインストール

Ubuntu Server 20.04.3 LTSには最初からPython3.8.10がインストールされています。

$ Python3 -V
Python 3.8.10

そのためPythonを別途インストールする必要がありませんが、Pythonライブラリをインストールするためのpip3を以下コマンドを実行してインストールしましょう。

$ sudo apt install python3-pip

インストールしたpip3を以下コマンドを実行してアップグレードします。

$ pip3 install –-upgrade pip

pyvenvのインストール

仮想環境を作成するためのpyvenvをインストールします。

$ sudo apt install python3-venv

仮想環境については以下記事をご参照ください。

【Python】仮想環境の構築と有効化の方法

仮想環境の生成には対象のディレクトリに移動後、次のコマンドを実行します。ここでは仮想環境の名前をvenvとします。

$ python3 -m venv venv

仮想環境を生成したら、仮想環境を有効化するために以下コマンドを実行します。

$ source venv/bin/activate

ターミナルの先頭に(venv)が付けば、仮想環境が有効になっていることを意味します。

Djangoのインストールと設定

仮想環境内にdjangoパッケージをインストールします。以下コマンドは仮想環境を有効化した状態で実行してください。

(venv) $ pip3 install django

次にプロジェクトを作成します。ここではmyprojectというプロジェクトを作成します。現在のディレクトリ位置に注意してください。

(venv)$ pwd
/home/ubuntu

ここでは上記のディレクトリで以下コマンドを実行してプロジェクトを作成します。

(venv) $ django-admin startproject myproject .

次にmyprojectディレクトリに移動して、settings.pyを編集します。

(venv) $ cd myproject
(venv) $ sudo vim settings.py

# settings.py
# すべてのホストを許可
ALLOWED_HOSTS = ['*']

settings.pyのALLOWED_HOSTSにすべてのホストを許可する「*」（アスタリスク）を指定しました。
ALLOWED_HOSTSについて詳しく知りたい方は以下記事をご参照ください。

【Django】settings.py：ALLOWED_HOSTSとは（開発・本番環境）

開発用サーバーとして立ち上がるか確認するために、ポート8000番を開放します。

$ sudo ufw allow 8000

次にDjangoを開発サーバーで起動します。

(venv)$ python manage.py runserver 0.0.0.0:8000

同じネットワーク内の端末からラズパイのIPアドレス:8000にアクセスし、ブラウザからWebアプリにアクセスできるか確認します。

IPアドレス:8000/

きちんと起動していれば次の画像が表示されます。

uWSGIのインストール

次にuWSGIをインストールします。

uWSGIをインストールする前にwheelをpipでインストールします。wheelはuWSGIに必要なパッケージです。

(venv) $ pip install wheel

次にuWSGIをpipでインストールします。

(venv)$ pip install uwsgi

uWSGIを起動してuWSGI経由でDjangoプロジェクトを呼び出してみます。この際にプロジェクト内のwsgi.py（wsgiモジュール）を使用します。

(venv)$ uwsgi --http :8000 --module myproject.wsgi

上記コマンドはhttpプロトコルで通信を行い8000番ポートを使用、モジュールのmyproject配下のwsgiモジュールを使用、という意味です。

これで再度IPアドレス:8000にブラウザから接続して、先ほどと同じ画面が表示すればuWSGI経由でDjangoアプリと通信ができたことを意味します。

今の構成としては、以下のようにブラウザとWebアプリケーション（Django）はアプリケーションサーバ（uWSGI）を通して通信を行っています。

ブラウザ ＜―＞ アプリケーションサーバ（uWSGI）＜―＞　Webアプリケーション（Django）

次にブラウザとuWSGIの間にNginx（Webサーバー）を上記構成に組み込みます。

Nginxの起動

現在仮想環境に入ったままなので、一旦deactivateコマンドで仮想環境から抜けます。

(venv)$ deactivate

NginxはすでにUbuntuにインストールしていますので、Nginxを起動してみましょう。

$ sudo /etc/init.d/nginx start

Nginxが起動できたらIPアドレス:80にアクセスしてください。「Welcome to nginx!」のページが表示されれば無事Nginxが起動されています。

uwsgi_paramsのコピー

/etc/nginxディレクトリにuwsgi_paramsというファイルがあります。これはuWSGI用のパラメータ定義ファイルです。

中身は次のようになっています。

uwsgi_param  QUERY_STRING       $query_string;
uwsgi_param  REQUEST_METHOD     $request_method;
uwsgi_param  CONTENT_TYPE       $content_type;
uwsgi_param  CONTENT_LENGTH     $content_length;

uwsgi_param  REQUEST_URI        $request_uri;
uwsgi_param  PATH_INFO          $document_uri;
uwsgi_param  DOCUMENT_ROOT      $document_root;
uwsgi_param  SERVER_PROTOCOL    $server_protocol;
uwsgi_param  REQUEST_SCHEME     $scheme;
uwsgi_param  HTTPS              $https if_not_empty;

uwsgi_param  REMOTE_ADDR        $remote_addr;
uwsgi_param  REMOTE_PORT        $remote_port;
uwsgi_param  SERVER_PORT        $server_port;
uwsgi_param  SERVER_NAME        $server_name;

それをプロジェクトディレクトリ（ここでは/home/ubuntu/myproject）にコピーします。

cp /etc/nginx/uwsgi_params /home/ubuntu/myproject/

設定ファイルの作成（confファイル）

次にmyproject用の設定ファイルmyproject_nginx.confを作成します。conf設定ファイルはNginx起動時に読み込まれます。

/etc/nginxディレクトリ配下のsites-availableディレクトリにconf設定ファイルを作成します。

sites-availableディレクトリとは、独自の設定ファイルを置くディレクトリです。

myproject_nginx.confは以下のように作成します。

$ cd /etc/nginx/sites-available
$ sudo vim myproject_nginx.conf

# myproject_nginx.conf
upstream django {
    server 192.168.0.54:8001;
}

server {
    listen      8000;
    location / {
        uwsgi_pass  django;
        include     /home/ubuntu/myproject/uwsgi_params;
    }
}

上記設定はご自身の設定に応じて適宜書き換えてください。ここではラズパイのipアドレスが192.168.0.54と想定して作成しています。

この設定によりポート番号8000に対してアクセスがきた際に、192.168.0.54:8001に通信を渡します。この後の設定で8001番ポートではuWSGIを動かします。
つまりnginxはuWSGIとの通信に8001番ポートを使うということです。

次に作成したconfファイルはプロジェクト内に複製します。

cp /etc/nginx/sites-available/myproject_nginx.conf /home/ubuntu/myproject

この複製したconf設定ファイルのシンボリックリンクを/etc/nginx/sites-enabledに作成します。sites-enabledディレクトリとは、独自設定ファイルのシンボリックリンクを格納するディレクトリです。

$ sudo ln -s /home/ubuntu/myproject/myproject_nginx.conf /etc/nginx/sites-enabled/

シンボリックリンクをsites-enabledディレクトリに格納することにより、Nginxが起動した際に作成した独自設定ファイルが読み込まれるようになります。

ここで一旦Nginxを再起動しておきましょう。

$ sudo /etc/init.d/nginx restart

uWSGIでDjangoアプリを呼び出す

最後にNginxとWebアプリケーションをつなぐ役割をするuWSGIを起動します。

次のようにuWSGIを起動してください。

$ cd /home/ubuntu
$ source venv/bin/activate
(venv)$ uwsgi --socket :8001 --module myproject.wsgi

これによりNginxからuWSGIを通してDjangoと通信を行えるようになりました。
これでipアドレス:8000にアクセスしてDjangoアプリが表示されれば問題なくWebサーバーの構築が完成したことを意味します。