Ubuntu 14.04でuWSGIとNginxを使用してFlaskアプリケーションを提供する方法

前書き

このガイドでは、Ubuntu 14.04でFlaskマイクロフレームワークを使用して簡単なPythonアプリケーションをセットアップします。 この記事の大部分は、uWSGIアプリケーションサーバーをセットアップしてアプリケーションを起動し、Nginxをフロントエンドリバースプロキシとして機能させる方法について説明します。

前提条件

このガイドを開始する前に、サーバーで非rootユーザーを構成する必要があります。 このユーザーは、管理機能を実行できるように「+ sudo +」権限が必要です。 これを設定する方法については、https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-14-04 [初期サーバーセットアップガイド]に従ってください。

uWSGI、アプリケーションサーバー、WSGI仕様の詳細については、https://www.digitalocean.com/community/tutorials/how-to-set-up-uwsgi-and-nginx-toのリンクセクションを参照してください。 -serve-python-apps-on-ubuntu-14-04#definitions-and-concepts [このガイド]。 これらの概念を理解すると、このガイドを理解しやすくなります。

続行する準備ができたら、読み進めてください。

Ubuntuリポジトリからコンポーネントをインストールする

最初のステップは、リポジトリから必要なすべてのピースをインストールすることです。 Pythonコンポーネントをインストールおよび管理するために、Pythonパッケージマネージャーである `+ pip +`をインストールします。 また、uWSGIをビルドするために必要なPython開発ファイルも取得し、Nginxもインストールします。

ローカルパッケージインデックスを更新してから、次のように入力してパッケージをインストールします。

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

Python仮想環境を作成する

次に、Flaskアプリケーションをシステム上の他のPythonファイルから分離するために、仮想環境を設定します。

+ pip`を使用して + virtualenv`パッケージをインストールすることから始めます。

sudo pip install virtualenv

これで、Flaskプロジェクトの親ディレクトリを作成できます。 作成後、ディレクトリに移動します。

mkdir ~/
cd ~/

次を入力して、FlaskプロジェクトのPython要件を保存する仮想環境を作成できます。

virtualenv

これにより、Pythonと `+ pip `のローカルコピーがプロジェクトディレクトリ内の `+`というディレクトリにインストールされます。

仮想環境内にアプリケーションをインストールする前に、アクティブ化する必要があります。 これを行うには、次のように入力します。

source /bin/activate

プロンプトが変わり、仮想環境内で操作していることが示されます。 この `+()@:〜/ $ +`のようになります。

Flaskアプリケーションのセットアップ

仮想環境にいるので、FlaskとuWSGIをインストールして、アプリケーションの設計を開始できます。

FlaskとuWSGIをインストールする

`+ pip +`のローカルインスタンスを使用して、FlaskとuWSGIをインストールできます。 次のコマンドを入力して、これらの2つのコンポーネントを取得します。

pip install uwsgi flask

サンプルアプリを作成する

Flaskが使用可能になったので、簡単なアプリケーションを作成できます。 フラスコはマイクロフレームワークです。 より多くのフル機能のフレームワークが提供するツールの多くは含まれておらず、主にプロジェクトにインポートしてWebアプリケーションの初期化を支援できるモジュールとして存在します。

アプリケーションはもっと複雑かもしれませんが、Flaskアプリを単一のファイルで作成し、 `+ myproject.py +`と呼びます:

nano ~//.py

このファイル内に、アプリケーションコードを配置します。 基本的に、フラスコをインポートし、Flaskオブジェクトをインスタンス化する必要があります。 これを使用して、特定のルートが要求されたときに実行する必要がある機能を定義できます。 コード「+ application +」でFlaskアプリケーションを呼び出して、WSGI仕様で見つかる例を複製します。

from flask import Flask
application = Flask(__name__)

@application.route("/")
def hello():
   return "<h1 style='color:blue'>Hello There!</h1>"

if __name__ == "__main__":
   application.run(host='0.0.0.0')

これは基本的に、ルートドメインにアクセスしたときに表示するコンテンツを定義します。 完了したら、ファイルを保存して閉じます。

次のように入力して、Flaskアプリをテストできます。

python .py

サーバーのドメイン名またはIPアドレスにアクセスしてから、Webブラウザーのターミナル出力で指定されたポート番号(ほとんどの場合は「:5000」)にアクセスします。 このようなものが見えるはずです。

image:https://assets.digitalocean.com/articles/nginx_uwsgi_wsgi_1404/test_app.png [Flaskサンプルアプリ]

終了したら、ターミナルウィンドウでCTRL-Cを数回押して、Flask開発サーバーを停止します。

WSGIエントリポイントを作成する

次に、アプリケーションのエントリポイントとして機能するファイルを作成します。 これは、アプリケーションと対話する方法をuWSGIサーバーに伝えます。

ファイルを `+ wsgi.py +`と呼びます:

nano ~//wsgi.py

ファイルは非常にシンプルで、アプリケーションからFlaskインスタンスをインポートして実行するだけです。

from  import application

if __name__ == "__main__":
   application.run()

完了したら、ファイルを保存して閉じます。

uWSGIを構成する

これでアプリケーションが作成され、エントリポイントが確立されました。 uWSGIに進むことができます。

uWSGIサービングのテスト

最初に行うことは、uWSGIがアプリケーションを提供できることを確認するテストです。

これを行うには、エントリポイントの名前を渡すだけです。 また、公開されているインターフェイスで開始されるようにソケットを指定し、 `+ uwsgi +`バイナリプロトコルの代わりにHTTPを使用するようにプロトコルを指定します。

uwsgi --socket 0.0.0.0:8000 --protocol=http -w wsgi

ウェブブラウザの末尾に「:8000」が追加されたサーバーのドメイン名またはIPアドレスにアクセスすると、次のようなページが表示されます。

image:https://assets.digitalocean.com/articles/nginx_uwsgi_wsgi_1404/test_app.png [Flaskサンプルアプリ]

正しく機能していることを確認したら、ターミナルウィンドウでCTRL-Cを押します。

これで仮想環境が完成したので、非アクティブ化できます。

deactivate

これで、すべての操作はシステムのPython環境に対して実行されます。

uWSGI構成ファイルの作成

uWSGIがアプリケーションを提供できることをテストしましたが、長期間の使用に対してより堅牢なものが必要です。 必要なオプションを使用してuWSGI構成ファイルを作成できます。

それをプロジェクトディレクトリに配置して、 `+ myproject.ini +`と呼びます。

nano ~//.ini

内部では、uWSGIが設定を適用することを認識できるように、 `+ [uwsgi] `ヘッダーから始めます。 モジュールを指定するには、 ` wsgi.py +`ファイルから拡張子を除いたものを参照します。

[uwsgi]
module = wsgi

次に、uWSGIにマスターモードで起動し、5つのワーカープロセスを生成して実際のリクエストを処理するように指示します。

[uwsgi]
module = wsgi

master = true
processes = 5

テスト中に、ネットワークポートでuWSGIを公開しました。 ただし、実際のクライアント接続を処理するためにNginxを使用し、uWSGIにリクエストを渡します。 これらのコンポーネントは同じコンピューター上で動作するため、より安全で高速なUnixソケットが推奨されます。 ソケットを「+ myproject.sock +」と呼び、このディレクトリに配置します。

また、ソケットのアクセス許可を変更する必要があります。 Nginxグループに、uWSGIプロセスの所有権を後で与えるため、ソケットのグループ所有者がそこから情報を読み取り、書き込みできることを確認する必要があります。 また、「vacuum」オプションを追加して、プロセスが停止したときにソケットをクリーンアップします。

[uwsgi]
module = wsgi

master = true
processes = 5

socket = .sock
chmod-socket = 660
vacuum = true

最後に行う必要があるのは、 `+ die-on-term +`オプションを設定することです。 これは、Upstart initシステムとuWSGIが異なるプロセスシグナルの意味について異なるアイデアを持っているために必要です。 これを設定すると、2つのシステムコンポーネントが調整され、予想される動作が実装されます。

[uwsgi]
module = wsgi

master = true
processes = 5

socket = .sock
chmod-socket = 660
vacuum = true

die-on-term = true

お気付きかもしれませんが、コマンドラインからのようにプロトコルを指定していません。 デフォルトでは、uWSGIは他のサーバーと通信するために設計された高速バイナリプロトコルである `+ uwsgi +`プロトコルを使用して話すためです。 Nginxはこのプロトコルをネイティブに話すことができるため、HTTPによる通信を強制するよりもこれを使用する方が適切です。

終了したら、ファイルを保存して閉じます。

Upstartスクリプトを作成する

次に注意する必要があるのは、Upstartスクリプトです。 Upstartスクリプトを作成すると、Ubuntuの初期化システムが自動的にuWSGIを起動し、サーバーが起動するたびにFlaskアプリケーションを提供できるようになります。

開始するには、 `+ / etc / init `ディレクトリ内に ` .conf +`で終わるスクリプトファイルを作成します。

sudo nano /etc/init/.conf

内部では、スクリプトの目的の簡単な説明から始めます。 すぐに、このスクリプトがシステムによって開始および停止される条件を定義します。 通常のシステムランタイム番号は2、3、4、5であるため、システムがこれらのランレベルのいずれかに達したときにスクリプトを開始するように指示します。 他のランレベルで停止するように指示します(サーバーの再起動時、シャットダウン時、シングルユーザーモードなど)。

description "uWSGI server instance configured to serve "

start on runlevel [2345]
stop on runlevel [!2345]

次に、uWSGIを実行するユーザーとグループを定義する必要があります。 プロジェクトファイルはすべて自分のユーザーアカウントによって所有されているため、実行するユーザーとして自分自身を設定します。 Nginxサーバーは `+ www-data`グループの下で実行されます。 Nginxがソケットファイルを読み書きできるようにする必要があるため、このグループにプロセスの所有権を与えます。

description "uWSGI server instance configured to serve "

start on runlevel [2345]
stop on runlevel [!2345]

setuid
setgid www-data

次に、ファイルを正しく見つけて処理できるようにプロセスを設定する必要があります。 すべてのPythonコンポーネントを仮想環境にインストールしたため、これをパスとして環境変数を設定する必要があります。 また、プロジェクトディレクトリに変更する必要があります。 その後、uWSGI実行可能ファイルを呼び出して、作成した構成ファイルを渡すことができます。

description "uWSGI server instance configured to serve "

start on runlevel [2345]
stop on runlevel [!2345]

setuid
setgid www-data

env PATH=/home////bin
chdir /home//
exec uwsgi --ini .ini

完了したら、ファイルを保存して閉じます。

次のように入力して、すぐにプロセスを開始できます。

sudo start

リクエストをプロキシするためのNginxの構成

これで、uWSGIアプリケーションサーバーが起動して実行され、プロジェクトディレクトリのソケットファイルに対する要求を待機します。 `+ uwsgi +`プロトコルを使用してそのソケットにWebリクエストを渡すようにNginxを設定する必要があります。

Nginxの `+ sites-available `ディレクトリに新しいサーバーブロック構成ファイルを作成することから始めます。 残りのガイドに合わせて、この「 myproject +」と呼ぶだけです。

sudo nano /etc/nginx/sites-available/

サーバーブロックを開き、Nginxにデフォルトのポート80でリッスンするように指示します。 また、サーバーのドメイン名またはIPアドレスのリクエストにこのブロックを使用するように指示する必要があります。

server {
   listen 80;
   server_name ;
}

追加する必要がある他の唯一のものは、すべての要求に一致するロケーションブロックです。 このブロック内に、設定する必要があるいくつかの一般的なuWSGIパラメーターを指定する `+ uwsgi_params `ファイルを含めます。 次に、 ` uwsgi_pass +`ディレクティブを使用して定義したソケットにリクエストを渡します。

server {
   listen 80;
   server_name ;

   location / {
       include uwsgi_params;
       uwsgi_pass unix:/home///.sock;
   }
}

実際にアプリケーションを提供するために必要なのはそれだけです。 完了したら、ファイルを保存して閉じます。

作成したNginxサーバーブロック構成を有効にするには、ファイルを `+ sites-enabled +`ディレクトリにリンクします:

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

そのディレクトリにあるファイルで、次のように入力して構文エラーをテストできます。

sudo nginx -t

問題が発生せずにこれが返された場合、Nginxプロセスを再起動して新しい構成を読み取ることができます。

sudo service nginx restart

これで、Webブラウザでサーバーのドメイン名またはIPアドレスにアクセスして、アプリケーションを表示できるようになります。

image:https://assets.digitalocean.com/articles/nginx_uwsgi_wsgi_1404/test_app.png [Flaskサンプルアプリ]

結論

このガイドでは、Python仮想環境内にシンプルなFlaskアプリケーションを作成しました。 WSGI対応のアプリケーションサーバーがインターフェイスできるようにWSGIエントリポイントを作成し、この機能を提供するようにuWSGIアプリサーバーを構成します。 その後、起動時にアプリケーションサーバーを自動的に起動するUpstartスクリプトを作成しました。 Webクライアントトラフィックをアプリケーションサーバーに渡し、外部リクエストを中継するNginxサーバーブロックを作成しました。

Flaskは非常にシンプルですが、非常に柔軟なフレームワークであり、構造や設計に制限をかけすぎることなく、アプリケーションに機能を提供することを目的としています。 このガイドで説明されている一般的なスタックを使用して、設計したフラスコアプリケーションを提供できます。

前の投稿:DOMを変更する方法
次の投稿:Ubuntu 16.04でStrongSwanを使用してIKEv2 VPNサーバーをセットアップする方法