始める前に
- 手元のマシンに Ruby。まだの場合は、Ruby 公式サイトからダウンロードするか、rbenv や rvm などのバージョンマネージャーを使用してください。
- Square Cloud のアカウント。メールアドレスまたは GitHub で登録できます。
- 有効なプラン。プランを確認し、プロジェクトに合うものを選んでください。
Square Cloud の設定
ダッシュボードからアプリケーションをアップロードする場合、このセクションは飛ばしてかまいません。ダッシュボードが
squarecloud.app 設定ファイルを自動で作成します。設定ファイルのリファレンス
squarecloud.app ファイルは、アプリケーションの実行方法を Square Cloud に伝えます。メインファイル、メモリ、ランタイムのバージョン、名前、そして Web サイトの場合はサブドメインを指定します。- ボットまたはワーカー
- ウェブサイトまたは API
squarecloud.app
Square Cloud が実行する内容
-
設定ファイルに
STARTフィールドが定義されていない場合、Square Cloud はruby MAINを実行します。ここでMAINで指定されたファイルが Ruby ファイル(例:main.rb)です。STARTフィールドが定義されている場合は、その値が直接実行されます。STARTをbundle exec ruby main.rbなどの適切な起動コマンドとして定義するのが一般的です。設定ファイルのパラメータについての詳細は、設定パラメータをご覧ください。 -
アプリを起動する前に、Square Cloud は
bundle installを実行してGemfileに記載された gem をインストールします。 -
ランタイムは
RACK_ENV=productionを設定するため、Rails や Sinatra などの Rack アプリは本番モードで起動します。
Bundler は設定を環境変数から読み込みます。環境変数は
bundle install の実行前に読み込まれます。本番環境で不要な gem グループを除外するには、変数 BUNDLE_WITHOUT=development:test を設定してください。ウェブサイトと API のポートとホスト
Square Cloud は環境変数PORT を 80 に、HOST を 0.0.0.0 に設定します。サーバーはこのポートで、すべてのネットワークインターフェースをリッスンする必要があります。Rails は本番環境では変更なしでこれを行います。Puma や Sinatra の場合は、ENV.fetch("PORT", 80) を読み込んで 0.0.0.0 にバインドしてください。
プロジェクトの準備
必要なファイル
- ZIP のルートに置いた
squarecloud.app。 main.rb、またはMAINに設定したファイル: Ruby のエントリーポイントです。Gemfile(必須): これがないアップロードはINVALID_DEPENDENCYで失敗します。- Bundler が生成する
Gemfile.lock: サーバーが同じバージョンの gem をインストールするように含めてください。
含めないもの
vendor/bundleと.bundle: 手元のマシン向けにインストールされた gem です。Square Cloud はサーバー上でbundle installを実行します。log/とtmp/(アプリが作成する場合)。
フレームワークガイド
Ruby on Rails
デプロイ
ダッシュボード経由
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 プラン以上で、独自ドメインからアプリを配信します。
トラブルシューティング
起動しないアプリや応答しないサイトを修正します。

