前書き
Djangoは強力なWebフレームワークであり、PythonアプリケーションまたはWebサイトの開発を支援します。 Djangoには、ローカルでコードをテストするための簡素化された開発サーバーが含まれていますが、わずかに生産関連の場合でも、より安全で強力なWebサーバーが必要です。
このガイドでは、Djangoアプリケーションをサポートおよび提供するために、Debian 8にいくつかのコンポーネントをインストールおよび構成する方法を示します。 デフォルトのSQLiteデータベースを使用する代わりに、PostgreSQLデータベースをセットアップします。 Gunicornアプリケーションサーバーを構成して、アプリケーションとインターフェイスします。 次に、GunicornにリバースプロキシするようにNginxを設定し、アプリを提供するためのセキュリティ機能とパフォーマンス機能にアクセスできるようにします。
前提条件と目標
このガイドを完了するには、 `+ sudo +`特権が設定された非rootユーザーを持つ新しいDebian 8サーバーインスタンスが必要です。 https://www.digitalocean.com/community/tutorials/initial-server-setup-with-debian-8 [初期サーバーセットアップガイド]を実行して、これを設定する方法を学ぶことができます。
仮想環境にDjangoをインストールします。 プロジェクト固有の環境にDjangoをインストールすると、プロジェクトとその要件を個別に処理できます。
データベースとアプリケーションを起動して実行したら、Gunicornアプリケーションサーバーをインストールして構成します。 これは、アプリケーションへのインターフェイスとして機能し、HTTPのクライアントリクエストをアプリケーションが処理できるPython呼び出しに変換します。 次に、Gunicornの前にNginxをセットアップして、高性能な接続処理メカニズムと実装しやすいセキュリティ機能を活用します。
始めましょう。
Debianリポジトリからパッケージをインストールする
プロセスを開始するには、必要なすべてのアイテムをDebianリポジトリからダウンロードしてインストールします。 Pythonパッケージマネージャー `+ pip +`を使用して、追加のコンポーネントを少し後でインストールします。
ローカルの `+ apt +`パッケージインデックスを更新してから、パッケージをダウンロードしてインストールする必要があります。 インストールするパッケージは、プロジェクトで使用するPythonのバージョンによって異なります。
-
Python 2 *を使用している場合は、次を入力します。
sudo apt-get update
sudo apt-get install python-pip python-dev libpq-dev postgresql postgresql-contrib nginx
-
Python 3 *を使用している場合は、次を入力します。
sudo apt-get update
sudo apt-get install python3-pip python3-dev libpq-dev postgresql postgresql-contrib nginx
これにより、 + pip +
、後でGunicornをビルドするために必要なPython開発ファイル、Postgresデータベースシステム、それと対話するために必要なライブラリ、およびNginx Webサーバーがインストールされます。
PostgreSQLデータベースとユーザーを作成する
Djangoアプリケーションのデータベースとデータベースユーザーをすぐに作成します。
デフォルトでは、Postgresはローカル接続に「ピア認証」と呼ばれる認証スキームを使用します。 基本的に、これはユーザーのオペレーティングシステムのユーザー名が有効なPostgresユーザー名と一致する場合、そのユーザーはそれ以上認証なしでログインできることを意味します。
Postgresのインストール中に、 + postgres +
PostgreSQL管理ユーザーに対応するために、 `+ postgres `という名前のオペレーティングシステムユーザーが作成されました。 このユーザーを使用して管理タスクを実行する必要があります。 sudoを使用して、ユーザー名を ` -u +`オプションで渡すことができます。
次のように入力して、インタラクティブなPostgresセッションにログインします。
sudo -u postgres psql
要件を設定できるPostgreSQLプロンプトが表示されます。
まず、プロジェクトのデータベースを作成します。
Note
CREATE DATABASE ;
OutputCREATE DATABASE
次に、プロジェクトのデータベースユーザーを作成します。 安全なパスワードを選択してください:
CREATE USER WITH PASSWORD '';
OutputCREATE ROLE
次に、作成したユーザーの接続パラメーターのいくつかを変更します。 これにより、データベース操作が高速化されるため、接続が確立されるたびに正しい値を照会および設定する必要がなくなります。
デフォルトのエンコーディングをUTF-8に設定していますが、これはDjangoが期待しています。 また、デフォルトのトランザクション分離スキームを「コミット済み読み取り」に設定しています。これは、コミットされていないトランザクションからの読み取りをブロックします。 最後に、タイムゾーンを設定しています。 デフォルトでは、Djangoプロジェクトは `+ UTC`を使用するように設定されます。 これらはすべてhttps://docs.djangoproject.com/en/1.10/ref/databases/#optimizing-postgresql-s-configuration[Djangoプロジェクト自体]の推奨事項です。
ALTER ROLE SET client_encoding TO 'utf8';
ALTER ROLE SET default_transaction_isolation TO 'read committed';
ALTER ROLE SET timezone TO 'UTC';
OutputALTER ROLE
ALTER ROLE
ALTER ROLE
これで、新しいユーザーに新しいデータベースを管理するアクセス権を与えることができます。
GRANT ALL PRIVILEGES ON DATABASE TO ;
OutputGRANT
終了したら、次を入力してPostgreSQLプロンプトを終了します。
\q
シェルセッションに戻る必要があります。
プロジェクト用のPython仮想環境を作成する
データベースができたので、残りのプロジェクト要件の準備を開始できます。 管理を容易にするために、仮想環境にPython要件をインストールします。
これを行うには、最初に `+ virtualenv `コマンドにアクセスする必要があります。 これは ` pip +`でインストールできます。
-
Python 2 *を使用している場合は、次を入力します。
sudo pip install virtualenv
-
Python 3 *を使用している場合は、次を入力します。
sudo pip3 install virtualenv
`+ virtualenv +`をインストールすると、プロジェクトの形成を開始できます。 プロジェクトファイルを保存できるディレクトリを作成して移動します。
mkdir ~/
cd ~/
プロジェクトディレクトリ内で、次のように入力してPython仮想環境を作成します。
virtualenv
これにより、「」ディレクトリ内に「」というディレクトリが作成されます。 内部では、Pythonのローカルバージョンと `+ pip +`のローカルバージョンがインストールされます。 これを使用して、プロジェクトの分離されたPython環境をインストールおよび構成できます。
プロジェクトのPython要件をインストールする前に、仮想環境をアクティブ化する必要があります。 次のように入力して、それを行うことができます。
source /bin/activate
プロンプトが変わり、Python仮想環境内で操作していることを示す必要があります。 次のようになります: +()@:〜/ $ +
。
仮想環境をアクティブにして、Django、Gunicorn、および + psycopg2 +
PostgreSQLアダプターをローカルインスタンスの `+ pip +`とともにインストールします。
Note
pip install django gunicorn psycopg2
これらのコンポーネントは、グローバルパッケージから分離された仮想環境内にインストールされます。
新しいDjangoプロジェクトを作成して構成する
Pythonコンポーネントをインストールすると、実際のDjangoプロジェクトファイルを作成できます。
Djangoプロジェクトを作成する
すでにプロジェクトディレクトリがあるので、ここでファイルをインストールするようDjangoに指示します。 これで、 `+ myproject +`ディレクトリ内でDjangoプロジェクトを開始できます。 これにより、コード自体を保持するために同じ名前の子ディレクトリが作成され、現在のディレクトリ内に管理スクリプトが作成されます。
django-admin.py startproject .
現在のディレクトリ構造は次のようになります。
.
└── ./myproject/
├── manage.py
├── myproject/
│ ├── __init__.py
│ ├── settings.py
│ ├── urls.py
│ └── wsgi.py
└── venv/
└── . . .
ご覧のとおり、 + manage.py`スクリプトを保持する親プロジェクトディレクトリ、内部プロジェクトディレクトリ、先ほど作成した
+ venv`仮想環境ディレクトリがあります。
プロジェクト設定を調整する
新しく作成したプロジェクトファイルで最初に行うべきことは、設定を調整することです。 テキストエディターで設定ファイルを開きます。
nano ~///settings.py
`+ ALLOWED_HOSTS +`ディレクティブを見つけることから始めます。 これは、Djangoインスタンスへの接続に使用できるアドレスまたはドメイン名のホワイトリストを定義します。 このリストにない* Host *ヘッダーを持つ着信リクエストは例外を発生させます。 Djangoでは、特定のクラスのセキュリティ脆弱性を防ぐために、これを設定する必要があります。
角括弧内に、Djangoサーバーに関連付けられているIPアドレスまたはドメイン名をリストします。 各項目は*引用符で*エントリを*コンマで区切ってリストする必要があります。 ドメインおよびサブドメインの要求に応答する場合は、エントリの先頭にピリオドを追加します。 以下のスニペットには、エントリをフォーマットする正しい方法を示すために使用されるコメントアウトされた例がいくつかあります。
〜/ myproject / myproject / settings.py
. . .
# The simplest case: just add the domain name(s) and IP addresses of your Django server
# ALLOWED_HOSTS = [ 'example.com', '203.0.113.5']
# To respond to 'example.com' and any subdomains, start the domain with a dot
# ALLOWED_HOSTS = ['.example.com', '203.0.113.5']
ALLOWED_HOSTS = ['', '', ]
次に、データベースアクセスを構成するセクションを見つけます。 `+ DATABASES +`で始まります。 ファイル内の構成は、SQLiteデータベース用です。 プロジェクト用にPostgreSQLデータベースをすでに作成しているため、設定を調整する必要があります。
PostgreSQLデータベース情報を使用して設定を変更します。 `+ pip `でインストールした ` psycopg2 `アダプタを使用するようDjangoに指示します。 データベース名、データベースユーザー名、データベースユーザーのパスワードを指定し、データベースがローカルコンピューターにあることを指定する必要があります。 ` PORT +`設定は空の文字列のままにしておくことができます:
〜/ myproject / myproject / settings.py
. . .
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.',
'NAME': '',
'USER': '',
'PASSWORD': '',
'HOST': 'localhost',
'PORT': '',
}
}
. . .
次に、ファイルの一番下まで移動し、静的ファイルを配置する場所を示す設定を追加します。 これは、Nginxがこれらのアイテムのリクエストを処理できるようにするために必要です。 次の行は、Djangoにベースプロジェクトディレクトリの `+ static +`というディレクトリに配置するように指示します。
〜/ myproject / myproject / settings.py
. . .
STATIC_URL = '/static/'
完了したら、ファイルを保存して閉じます。
初期プロジェクトのセットアップを完了する
これで、管理スクリプトを使用して初期データベーススキーマをPostgreSQLデータベースに移行できます。
cd ~/
./manage.py makemigrations
./manage.py migrate
次を入力して、プロジェクトの管理ユーザーを作成します。
./manage.py createsuperuser
ユーザー名を選択し、メールアドレスを入力し、パスワードを選択して確認する必要があります。
次のように入力して、すべての静的コンテンツを構成したディレクトリの場所に収集できます。
./manage.py collectstatic
操作を確認する必要があります。 静的ファイルは、プロジェクトディレクトリ内の「+ static +」というディレクトリに配置されます。
最後に、次のコマンドでDjango開発サーバーを起動して、プロジェクトをテストできます。
./manage.py runserver 0.0.0.0:8000
ウェブブラウザで、サーバーのドメイン名またはIPアドレスにアクセスし、その後に「:8000」を入力します。
http://:8000
デフォルトのDjangoインデックスページが表示されます。
image:https://assets.digitalocean.com/articles/django_gunicorn_nginx_1404/django_index.png [Django index page]
アドレスバーのURLの末尾に「+ / admin 」を追加すると、「 createsuperuser」コマンドで作成した管理ユーザー名とパスワードの入力を求められます。
画像:https://assets.digitalocean.com/articles/django_gunicorn_nginx_1404/admin_login.png [Django管理者ログイン]
認証後、デフォルトのDjango管理インターフェースにアクセスできます。
image:https://assets.digitalocean.com/articles/django_gunicorn_nginx_1404/admin_interface.png [Django管理インターフェース]
探索が終了したら、ターミナルウィンドウでCTRL-Cを押して、開発サーバーをシャットダウンします。
Gunicornのプロジェクト提供能力のテスト
仮想環境を離れる前にやりたい最後のことは、Gunicornをテストして、アプリケーションにサービスを提供できることを確認することです。 次のように入力することで、これを簡単に行うことができます。
cd ~/
gunicorn --bind 0.0.0.0:8000 .wsgi:application
これにより、Django開発サーバーが実行されていたのと同じインターフェースでGunicornが起動します。 戻ってアプリをもう一度テストできます。
Pythonのモジュール構文を使用して、アプリケーションへのエントリポイントであるDjangoの `+ wsgi.py `ファイルへの相対ディレクトリパスを指定して、Gunicornにモジュールを渡しました。 このファイルの内部には、アプリケーションとの通信に使用される「 application +」という関数が定義されています。 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 [こちら]。
テストが終了したら、ターミナルウィンドウでCTRL-Cを押してGunicornを停止します。
これで、Djangoアプリケーションの構成が完了しました。 次のように入力して、仮想環境からバックアウトできます。
deactivate
仮想環境プレフィックスは、シェルプロンプトから削除する必要があります。これは、仮想環境にいないことを示します。
Gunicorn systemdサービスファイルを作成する
GunicornがDjangoアプリケーションとやり取りできることをテストしましたが、アプリケーションサーバーを起動および停止するより堅牢な方法を実装する必要があります。 これを実現するために、systemdサービスファイルを作成します。
テキストエディタでGunicornのsystemdサービスファイルを作成し、 `+ sudo +`特権で開きます。
sudo nano /etc/systemd/system/gunicorn.service
メタデータと依存関係を指定するために使用される `+ [Unit] +`セクションから始めます。 ここにサービスの説明を入力し、ネットワーキングターゲットに到達した後にのみこれを開始するようにinitシステムに指示します。
/etc/systemd/system/gunicorn.service
[Unit]
Description=gunicorn daemon
After=network.target
次に、 `+ [Service] `セクションを開きます。 実行するために処理するユーザーとグループを指定します。 関連するすべてのファイルを所有しているため、通常のユーザーアカウントにプロセスの所有権を付与します。 NginxがGunicornと簡単に通信できるように、グループの所有権を「 www-data」グループに付与します。
次に、作業ディレクトリをマップし、サービスを開始するために使用するコマンドを指定します。 この場合、仮想環境内にインストールされているGunicorn実行可能ファイルへのフルパスを指定する必要があります。 Nginxは同じコンピューターにインストールされているため、プロジェクトディレクトリ内の_Unix socket_にバインドします。 これは、ネットワークポートを使用するよりも安全で高速です。 ここで、オプションのGunicorn調整を指定することもできます。 たとえば、この場合、3つのワーカープロセスを指定しました。
/etc/systemd/system/gunicorn.service
[Unit]
Description=gunicorn daemon
After=network.target
[Service]
User=
Group=www-data
WorkingDirectory=/home//
ExecStart=/home////bin/gunicorn --workers 3 --bind unix:/home///.sock myproject.wsgi:application
最後に、 `+ [Install] +`セクションを追加します。 これにより、ブート時に起動できるようにした場合、このサービスをリンクする対象がsystemdに指示されます。 通常のマルチユーザーシステムが稼働しているときにこのサービスを開始する必要があります。
/etc/systemd/system/gunicorn.service
[Unit]
Description=gunicorn daemon
After=network.target
[Service]
User=
Group=www-data
WorkingDirectory=/home//
ExecStart=/home////bin/gunicorn --workers 3 --bind unix:/home///.sock myproject.wsgi:application
[Install]
WantedBy=multi-user.target
これで、systemdサービスファイルが完成しました。 今すぐ保存して閉じます。
これで、作成したGunicornサービスを開始し、起動時に開始できるように有効化できます。
sudo systemctl start gunicorn
sudo systemctl enable gunicorn
OutputCreated symlink from /etc/systemd/system/multi-user.target.wants/gunicorn.service to /etc/systemd/system/gunicorn.service.
次のように入力して、サービスのステータスを確認します。
sudo systemctl status gunicorn
Output● gunicorn.service - gunicorn daemon
Loaded: loaded (/etc/systemd/system/gunicorn.service; disabled)
since Wed 2016-12-21 21:05:07 UTC; 49s ago
Main PID: 10154 (gunicorn)
CGroup: /system.slice/gunicorn.service
├─10154 /home/sammy/myproject/venv/bin/python3 /home/sammy/myproject/venv/bin/gunicorn --workers 3 --bind unix:/home/sammy/myproject/myproject.sock myproject.wsgi:application
├─10157 /home/sammy/myproject/venv/bin/python3 /home/sammy/myproject/venv/bin/gunicorn --workers 3 --bind unix:/home/sammy/myproject/myproject.sock myproject.wsgi:application
├─10158 /home/sammy/myproject/venv/bin/python3 /home/sammy/myproject/venv/bin/gunicorn --workers 3 --bind unix:/home/sammy/myproject/myproject.sock myproject.wsgi:application
└─10159 /home/sammy/myproject/venv/bin/python3 /home/sammy/myproject/venv/bin/gunicorn --workers 3 --bind unix:/home/sammy/myproject/myproject.sock myproject.wsgi:application
Dec 21 21:05:07 debian-512mb-nyc3-01 systemd[1]: Started gunicorn daemon.
Dec 21 21:05:07 debian-512mb-nyc3-01 gunicorn[10154]: [2016-12-21 21:05:07 +0000] [10154] [INFO] Starting gunicorn 19.6.0
Dec 21 21:05:07 debian-512mb-nyc3-01 gunicorn[10154]: [2016-12-21 21:05:07 +0000] [10154] [INFO] Listening at: unix:/home/sammy/myproject/myproject.sock (10154)
Dec 21 21:05:07 debian-512mb-nyc3-01 gunicorn[10154]: [2016-12-21 21:05:07 +0000] [10154] [INFO] Using worker: sync
Dec 21 21:05:07 debian-512mb-nyc3-01 gunicorn[10154]: [2016-12-21 21:05:07 +0000] [10157] [INFO] Booting worker with pid: 10157
Dec 21 21:05:07 debian-512mb-nyc3-01 gunicorn[10154]: [2016-12-21 21:05:07 +0000] [10158] [INFO] Booting worker with pid: 10158
Dec 21 21:05:07 debian-512mb-nyc3-01 gunicorn[10154]: [2016-12-21 21:05:07 +0000] [10159] [INFO] Booting worker with pid: 10159
探すべき最も重要なことは、ユニットがアクティブであることです。
これは、ソケットファイルが作成されたことを確認する良い機会でもあります。 `+〜/ +`ディレクトリの内容をリストすると、Unixソケットファイルが表示されるはずです。
ls -l ~/
Outputtotal 16
-rwxr-xr-x 1 sammy sammy 807 Dec 21 20:46 manage.py
drwxr-xr-x 3 sammy sammy 4096 Dec 21 20:54 myproject
drwxr-xr-x 3 sammy sammy 4096 Dec 21 20:54 static
drwxr-xr-x 5 sammy sammy 4096 Dec 21 20:41 venv
ご覧のとおり、ソケットはそこにあり、 `+ www-data`グループにはグループ所有権があります。
NunicornをGunicornにプロキシパスするように構成する
Gunicornがセットアップされたので、プロセスにトラフィックを渡すようにNginxを構成する必要があります。
Nginxの `+ sites-available +`ディレクトリに新しいサーバーブロックを作成して開くことから始めます。
sudo nano /etc/nginx/sites-available/
内部で、新しいサーバーブロックを開きます。 このブロックが通常のポート80でリッスンし、サーバーのドメイン名またはIPアドレスに応答するように指定することから始めます。
/ etc / nginx / sites-available / myproject
server {
listen 80;
server_name ;
}
次に、ファビコンが見つからない場合、エラーを無視するようにNginxに指示できます。 また、 `+〜// static +`ディレクトリで収集した静的アセットの場所を指定します。 これらのファイルにはすべて「/ static」の標準URIプレフィックスが付いているため、これらの要求に一致する場所ブロックを作成できます。
/ etc / nginx / sites-available / myproject
server {
listen 80;
server_name ;
location = /favicon.ico { access_log off; log_not_found off; }
location /static/ {
root /home//;
}
}
最後に、他のすべてのリクエストに一致するように、 `+ location / {} `ブロックを作成します。 この場所の中に、Nginxインストールに含まれる標準の ` proxy_params +`ファイルを含め、Gunicornプロセスが作成したソケットにトラフィックを渡します。
/ etc / nginx / sites-available / myproject
server {
listen 80;
server_name ;
location = /favicon.ico { access_log off; log_not_found off; }
location /static/ {
root /home//;
}
location / {
include proxy_params;
proxy_pass http://unix:/home///.sock;
}
}
完了したら、ファイルを保存して閉じます。 これで、 `+ sites-enabled +`ディレクトリにリンクすることでファイルを有効にできます:
sudo ln -s /etc/nginx/sites-available/ /etc/nginx/sites-enabled
次のように入力して、構文エラーのNginx設定をテストします。
sudo nginx -t
Outputnginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful
エラーが報告されていない場合は、次のように入力してNginxを再起動します。
sudo systemctl restart nginx
これで、ポートを指定せずにサーバーのドメインまたはIPアドレスにアクセスしてアプリケーションを表示できるようになります。
Note
結論
このガイドでは、独自の仮想環境でDjangoプロジェクトを設定しました。 Djangoがクライアントリクエストを処理できるように、クライアントリクエストを変換するようにGunicornを設定しました。 その後、Nginxを設定してリバースプロキシとして機能し、クライアント接続を処理し、クライアントのリクエストに応じて正しいプロジェクトを提供します。
Djangoは、多くの共通部分を提供することでプロジェクトとアプリケーションの作成を簡単にし、独自の要素に集中できるようにします。 この記事で説明した一般的なツールチェーンを活用することで、単一のサーバーから作成したアプリケーションを簡単に提供できます。