【Ubuntu】Apache2 / Flask 環境構築

Apache2 (Webサーバ) と Flask (Webアプリケーション) を連携させて HTTP でアクセスできる環境を構築します

2023年5月19日2025年4月29日

📌

動作確認環境

Ubuntu 24.04
- Apache 2.4.58
- Python 3.13.3
  - Flask 3.1.0

( 🐳 Docker コンテナを利用して動作確認)

🔗

関連リンク

Apache2 と Pythonの導入

まずは、ベースとなる環境を構築します

以下のようにして、Apache2 から導入します

sudo apt update && sudo apt install build-essential apache2

次に Python のセットアップを行います

Ubuntu の場合、Python3 はすでに導入されていると思われますが、 pip がない場合は以下のようにして導入します

sudo apt install python3-pip

そもそも Python がない場合やバージョンが気に入らない場合は、pyenv 等を用いて新たに環境構築してください

Apache2 の設定と起動

Apache2 に対しリバースプロキシの設定を行うことで 80(http) → 5000(Flask のデフォルト) ポートへの転送を行います

/etc/apache2/sites-available/000-default.conf に ProxyPreserveHost On 等の3行分を末尾に追記します

なお、Flask アプリケーションのポート番号が 5000 でない場合は、:5000 の部分を正しい番号に書き換えてください

<VirtualHost *:80>  ...
ProxyPreserveHost OnProxyPass / http://localhost:5000/ProxyPassReverse / http://localhost:5000/</VirtualHost>

設定が完了したら、Apache2 を起動します (すでに起動している場合は restart)

sudo service apache2 start

⚠️

Invalid command 'ProxyPreserveHost', perhaps misspelled or defined by a module not included in the server configuration エラー

このようなエラーが出る場合は、 Apache のモジュールが不足しています

以下のコマンドで必要な Apache のモジュールを追加しましょう

sudo a2enmod proxy_http

導入が完了したら、もう一度再起動して試してみてください

Apache2 の起動や停止など、よく使いそうなコマンドをまとめておきます

Apache2のステータス・起動・停止・再起動コマンド一覧

Flask の導入と起動

Python 環境に pip で Flask を導入します

pip3 install flask

⚠️

× This environment is externally managed エラー

Python 3.12 以降、他環境のパッケージを上書きしないよう、直接的なインストールの実行が非推奨となりました

このエラーを回避するには venv 等による仮想環境を構築する必要がありますが、少し大袈裟な気もするので、今回は --break-system-packages オプションをつけてお茶を濁します (無視してインストールします)

pip3 install flask --break-system-packages

以下を app.py としてカレントディレクトリに作成してください

from flask import Flaskapp = Flask(__name__)
@app.route('/')def hello_world():    return "<h1>Hello World!!!!</h1>"
if __name__ == '__main__':    app.run(port=5000)

以下のコマンドで Flask を起動します

python3 app.py

このように表示されれば起動成功です 🎉

ブラウザからサーバのグローバル IP アドレスを入力しアクセスして確認してみてください

  * Serving Flask app 'app'  * Debug mode: onWARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.  * Running on http://127.0.0.1:5000Press CTRL+C to quit

(http://127.0.0.1:5000 はループバックアドレスであり、グローバルIPアドレスではありません)

Flask を停止するには [Ctrl] + [c] で終了できます

テクニック＆トラブルシューティング

開発にあたり、Flask・Ubuntu 技術や、遭遇しそうなエラーについて、簡単に記しておきます

Service Unavailable (503)

Internal Server Error (500)

ロードが終わらない

pip でインストールされているモジュールを確認する・まとめてインストールする

以下のコマンドで一覧表示することができます

pip freeze

blinker==1.9.0click==8.1.8Flask==3.1.0Flask-HTTPAuth==4.8.0itsdangerous==2.2.0Jinja2==3.1.6MarkupSafe==3.0.2setuptools==68.1.2Werkzeug==3.1.3wheel==0.42.0

ちなみに、ファイルに出力しておけば、そのファイルを元にインストールすることも可能です

他人や他のマシンと環境を共有する際に有用です

ファイルに出力
```
pip freeze > requirements.txt
```
インストール時
```
pip install -r requirements.txt 
```

別ファイルの HTML／CSS／JavaScript を読み込む

app.py の肥大化を防ぐために、複数のファイルに分割して管理できます

以下のように HTML ファイルは templates、CSS や js、画像ファイル等は static フォルダに配置します

(root)|- app.py|- templates|  `- index.html`- static    |- style.css    `- script.js

index.html を読み込む際は、app.py を render_template.py を使って書き換えます

例えば、変数 (ここではdata) を渡すこともできます

from flask import Flask, render_templateapp = Flask(__name__) 
@app.route('/')def hello_world():    message = 'Hello world'    return render_template('index.html', data=message)

index.html は以下のように書いてみました (h1 内では Hello world と展開されます)

<html>  <body>    <h1>{{data}}</h1>  </body></html>

Flask では、HTML ファイルから static フォルダ内のファイルを読み込むことができます

static フォルダ内の style.css を適用したい場合、以下のように読み込むことができます

<link rel="stylesheet" href={{"static", filename="style.css"}}>

また、static フォルダ内の script.js を呼び出したい場合、以下のように読み込むことができます

<script src={{"static", filename="script.js"}}>

これで、ファイルを分割して読み込めるようになりました 🎉

Flask に Basic 認証を設定する

まず、追加でモジュールが必要なため、pipでインストールします

pip3 install flask_httpauth

次に Flask (app.py) のソースコードに Basic 認証設定のために追記します

users には、辞書型でユーザ名をキーに、パスワードを値にした認証情報を記述します (複数登録可)

この例ではユーザ名を user、パスワードを password にしていますが、脆弱なのでよく考えて設定しましょう

from flask import Flaskfrom flask_httpauth import HTTPBasicAuth
app = Flask(__name__)auth = HTTPBasicAuth()
users = {    "user": "password",}
@auth.get_passworddef get_pw(username):    return users.get(username) if username in users else None

そして、それぞれのrouteの下に @auth.login_required を追加します

⚠️ 追加しなかった route については、Basic 認証が設定されないので注意してください

@app.route('/')@auth.login_requireddef hello_world():    return "<h1>Hello World!!!!</h1>"

これで Basic 認証が求められるようになりました 🎉 (うまくいかない場合は Flask を再起動してください)

Flask を起動したままにする (バックグラウンド実行)

バックグラウンド実行を開始する

Ubuntu 上でバックグラウンド実行を行うには、2つ方法があります

(1つ目) シェルを終了しても Flask を起動したままにするには、最初に nohup 末尾に & を付けて実行します
```
nohup python3 app.py &
```
この場合、[Ctrl]+[c] や exit によりシェルを抜けたとしても、起動し続けます
(2つ目)まず通常通りに起動します
```
python3 app.py
```
[Ctrl]+[z] を入力することで、一時的に停止させることができます
```
[1]+  Stopped                 python3 app.py
```
今回の場合 [1] と表示されていることから、%1 と指定するとバックグラウンドで起動できます 🎉
```
bg %1 && disown %1
```

⚠️

SSH 接続等での注意点

SSH 接続中のみバックグラウンド実行できれば良い場合は、nohup や disown の付与は必要ありません

一方で、SSH 接続終了後もバックグラウンド実行を継続させたい場合は、シェル切断後に SIGNUP(1) シグナルが送信されてプロセスを終了させられてしまいます

これを回避するために、nohup や disown を使う必要があります

バックグラウンド実行の終了

バックグラウンドで起動したタスクを終了するには、以下のコマンドでジョブを見つけます

jobs

現在、起動中であったり一時停止中のジョブが一覧で表示されます

[1]+  Running                 python3 app.py &

このコマンドで表示された場合は 1、表示されない場合は 2 に進んでください

該当のプロセスが表示されている場合 (同一シェルで起動した場合)
今回の場合は [1] と表示されていることから、%1 と指定すると終了できます
```
kill %1
```
該当のプロセスが表示されていない場合 (一度SSHを切断したり、別のシェルから入った場合)
jobs は、Flask アプリを起動したシェルと同一のシェルで実行しないと表示されません
そのため、Flask を実行しているプロセスを ps コマンドを使って探します
aux は全てのプロセスとユーザを表示するオプションです。grep は検索するコマンドです
```
ps aux | grep python3
```
結果が以下のように表示されるので、該当プロセスを探します
```
koizumi   562111  1.6  2.8  34884 28356 pts/0    S    15:54   0:00 python3 app.pykoizumi   562115  0.0  0.0   4616   720 pts/0    S+   15:54   0:00 grep --color=auto python3
```
今回の場合は 562111 が該当のプロセス番号となるので、 kill コマンドで終了できます
```
kill 562111
```

これによりバックグラウンドで実行したプロセスを停止することができました 🎉

URLコピー

QRコード

X / Twitter

はてブ

支援 (GitHub Sponsors)