始める前に
- 手元のマシンに Elixir。まだの場合は、Elixir 公式のインストールガイドに従ってください。
- Square Cloud のアカウント。メールアドレスまたは GitHub で登録できます。
- 有効なプラン。プランを確認し、プロジェクトに合うものを選んでください。
Square Cloud の設定
ダッシュボードからアプリケーションをアップロードする場合、このセクションは飛ばしてかまいません。ダッシュボードが
squarecloud.app 設定ファイルを自動で作成します。設定ファイルのリファレンス
squarecloud.app ファイルは、アプリケーションの実行方法を Square Cloud に伝えます。メインファイル、メモリ、ランタイムのバージョン、名前、そして Web サイトの場合はサブドメインを指定します。- ボットまたはワーカー
- ウェブサイトまたは API
squarecloud.app
Square Cloud が実行する内容
-
設定ファイルに
STARTフィールドが定義されていない場合、Square Cloud はmix run --no-haltを実行してプロジェクトを起動します。STARTフィールドが定義されている場合は、その値が直接実行されます。設定ファイルのパラメーターに関する詳細は、設定パラメーターをご覧ください。 -
STARTの前に、Square Cloud はhexおよびrebarツールをローカルにインストールし、mix deps.getでプロジェクトの依存関係を取得します。これらの手順のいずれかが失敗すると、アプリは起動しません。 -
MAINは、プロジェクトが Elixir で書かれていることを Square Cloud に伝えるためだけのものです。実在する.exまたは.exsファイル（例:mix.exs）を指定する必要がありますが、mix run --no-haltは Mix プロジェクト全体を実行します。
ウェブサイトと API のポートとホスト
Square Cloud は環境変数PORT を 80 に、HOST を 0.0.0.0 に設定します。ウェブサーバーはこのポートで、すべてのネットワークインターフェースをリッスンする必要があります。Phoenix は、生成される config/runtime.exs によって本番環境でこれを行います。Plug や Bandit の場合は、サーバーの起動時に System.get_env("PORT") を読み込んでください。
プロジェクトの準備
必要なファイル
- ZIP のルートに置いた
squarecloud.app。 mix.exs(必須): これがないアップロードはINVALID_DEPENDENCYで失敗します。mix.lock: サーバーが手元のマシンと同じバージョンの依存関係を取得するために使います。- ソースコード。通常は
lib/とconfig/にあります。
含めないもの
_build/: 手元のマシン向けにコンパイルされたファイルです。Square Cloud は Linux 上でプロジェクトをコンパイルします。deps/:mix deps.getがサーバー上で依存関係を取得し直します。
フレームワークガイド
Phoenix
デプロイ
ダッシュボード経由
1
アップロードページにアクセス
アップロードページにアクセスし、プロジェクトの zip ファイルをアップロードします。
2
環境を設定
zip をアップロードした後、プロジェクトの名前、メインファイルまたはランタイム環境、その他の設定を構成する必要があります。
ウェブプロジェクトをアップロードする場合は、必ず「Web Publication」を選択し、プロジェクトにサブドメインを設定してください。
ウェブプロジェクトをアップロードする場合は、必ず「Web Publication」を選択し、プロジェクトにサブドメインを設定してください。
3
プロジェクトをデプロイ
最後に「Deploy」ボタンをクリックして、プロジェクトを Square Cloud にホストします。
デプロイ後、ダッシュボードからプロジェクトのステータスとログを監視できます。
デプロイ後、ダッシュボードからプロジェクトのステータスとログを監視できます。
4
アプリが稼働していることを確認
最初のデプロイは、通常 1 分もかからずに完了します。ダッシュボードでアプリケーションのステータスが running になるのを待ち、起動時のエラーがないかログを確認してください。
ウェブサイトや API をデプロイした場合は、ブラウザで
ウェブサイトや API をデプロイした場合は、ブラウザで
https://<your-subdomain>.squareweb.app を開き、アプリケーションが応答することを確認してください。ボットをデプロイした場合は、コマンドを送信してオンラインになっていることを確認してください。
CLI 経由
この方法を使用するには、プロジェクトのルートにsquarecloud.app という名前の設定ファイルが必要です。このファイルは、アプリケーションの実行方法を Square Cloud に伝えます。
設定ファイルガイド
アプリケーションの環境を定義する
squarecloud.app 設定ファイルの作成方法を学びます。1
CLI をインストール
Square Cloud CLI をインストールします。すでにお持ちの場合は、同じコマンドを実行すると更新されます:
2
ログイン
次のコマンドを実行します。ブラウザが開くので、そこでログインを承認すれば CLI の準備は完了です。API キーをコピーする必要はありません。スクリプトや CI については、CLI の認証を参照してください。
3
プロジェクトをアップロード
プロジェクトのフォルダで次のコマンドを実行します。CLI は 自分で作成した zip をアップロードするには、
squarecloud.ignore に記載されたものを除いて現在のフォルダを zip にし、アップロードします:--file で指定します:4
アプリが稼働していることを確認
最初のデプロイは、通常 1 分もかからずに完了します。ターミナルから直接、アプリケーションのステータスとログを確認してください。ウェブサイトや API をデプロイした場合は、ブラウザで
https://<your-subdomain>.squareweb.app を開き、アプリケーションが応答することを確認してください。ボットをデプロイした場合は、コマンドを送信してオンラインになっていることを確認してください。
次のステップ
環境変数
シークレットや設定をコードから切り離し、実行時に読み込みます。
カスタムドメイン
Standard プラン以上で、独自ドメインからアプリを配信します。
トラブルシューティング
起動しないアプリや応答しないサイトを修正します。