PostgreSQL 用に pgAdmin 4 をホスティング

​

はじめに

• この記事では、Square Cloud 上で pgAdmin アプリケーションを作成してホスティングする手順を解説します。
• 始める前に、Square Cloud のアカウントを用意してください。アカウントはメールアドレスを使ってサインアップページから作成できます。
• 最後に、アカウントに有効なプランが必要です。利用可能なプランを比較し、ニーズに合ったものを選んでください。

​

プロジェクトの作成

• pgAdmin は Python 上で動作するため、プロジェクトには requirements.txt または pyproject.toml が必要です。 requirements.txt の作成方法を参照してください。
• requirements.txt には pgadmin4 と、それを配信するためのウェブサーバーを記載する必要があります。このチュートリアルでは gunicorn を使用します。

pgadmin4
gunicorn

• 次に、いくつかのパスを設定するための設定ファイル config_local.py が必要です。これらのパスは、pgAdmin に関する情報の保存先を定義します。

SERVER_MODE = True
MAX_LOGIN_ATTEMPTS = 3
"""
    CRITICAL 50
    ERROR    40
    WARNING  30
    SQL      25
    INFO     20
    DEBUG    10
    NOTSET    0
"""
CONSOLE_LOG_LEVEL = 10
DATA_DIR = "/application/.pgadmin/"
LOG_FILE = "/application/.pgadmin/logfile"
SQLITE_PATH = '/application/.pgadmin/pgadmin4.db'

​

ZIP に含めるファイル

• requirements.txt または pyproject.toml
• config_local.py
• squarecloud.app (下記の設定ファイル)

​

設定ファイル

• ダッシュボードからアップロードする場合は、ランタイムを手動で Python に設定し、起動コマンドに下記の START コマンドを使用します。squarecloud.app 設定ファイルでは次のようになります。

DISPLAY_NAME=App name
RUNTIME=python
MEMORY=1024
START=python -m gunicorn --bind 0.0.0.0:80 --workers=1 --threads=4 pgadmin4.pgAdmin4:app
VERSION=recommended
SUBDOMAIN=my-pgadmin-subdomain

• Gunicorn は、Square Cloud がサブドメインへのトラフィックを届けるポート 80 で、すべてのインターフェース (0.0.0.0) をリッスンします。ワーカーは 1 つ (--workers=1) のままにし、代わりにスレッドを増やしてください。ワーカーを増やすと、pgAdmin は CSRF エラーで失敗します。
• 次に、2 つの環境変数 PGADMIN_SETUP_EMAIL と PGADMIN_SETUP_PASSWORD を設定します。pgAdmin は初回起動時に、これらを使って最初のユーザーを作成します。

PGADMIN_SETUP_EMAIL=accessemail@example.com
PGADMIN_SETUP_PASSWORD=yourSecurePassword

• これらは、アップロードフォームの Advanced configuration、アプリケーションの Environment Variables ページ (設定後に再起動)、または squarecloud app env set で設定します。pgAdmin はプロジェクトのルートにある .env ファイルを読み込まないため、上のようなファイルは、Square Cloud がアプリケーションの起動時に読み込む .squarecloud/.env として置いた場合にのみ機能します (当社のリリースではこれを使っています)。環境変数を参照してください。

​

プロジェクトを Square Cloud にアップロードする

​

ダッシュボード経由

1

アップロードページにアクセス

アップロードページにアクセスし、プロジェクトの zip ファイルをアップロードします。

2

環境を設定

zip をアップロードした後、プロジェクトの名前、メインファイルまたはランタイム環境、その他の設定を構成する必要があります。
ウェブプロジェクトをアップロードする場合は、必ず「Web Publication」を選択し、プロジェクトにサブドメインを設定してください。

3

プロジェクトをデプロイ

最後に「Deploy」ボタンをクリックして、プロジェクトを Square Cloud にホストします。
デプロイ後、ダッシュボードからプロジェクトのステータスとログを監視できます。

4

アプリが稼働していることを確認

最初のデプロイは、通常 1 分もかからずに完了します。ダッシュボードでアプリケーションのステータスが running になるのを待ち、起動時のエラーがないかログを確認してください。
ウェブサイトや API をデプロイした場合は、ブラウザで https://<your-subdomain>.squareweb.app を開き、アプリケーションが応答することを確認してください。ボットをデプロイした場合は、コマンドを送信してオンラインになっていることを確認してください。

アプリが起動しませんか？よくある原因と修正方法はトラブルシューティングガイドを参照してください。

​

CLI 経由

curl -fsSL https://cli.squarecloud.app/install | bash

npm install -g @squarecloud/cli@latest

squarecloud auth login

squarecloud upload

squarecloud upload --file <path/to/zip>

squarecloud app status
squarecloud app logs

​

最後に

​

次のステップ

​

お問い合わせ