環境

Squid は作業用に 2 つの環境（dev と prod）を提供します。

新しいアプリケーションを作成すると、Squid は自動的に dev と prod の環境をセットアップします。開発とテストには dev 環境を使用してください。prod 環境は、アプリケーションを本番公開する準備が整ったときに使用します。

識別子

リソース	共有
App ID	✓
Region	✓
Organization	✓
Developer ID	✓
API Keys	×

エンティティ

リソース	共有
AI Agents	×
Connectors	×
Secrets	×
Built-in database	×
Backend deployments	×

環境とコネクタ

Squid Console でアプリの dev と prod のバージョンを切り替えると、それぞれ異なるコネクタのセットを持っていることに気づくはずです。 本番アプリの機能に意図しない変更が加わるのを防ぐため、dev と prod 環境のコネクタは同期されません。Squid アプリにコネクタを追加する際は、目的の環境に追加していることを確認してください。

Best practice

dev 環境は、コネクタの開発用バージョンと接続してください。これにより、アプリケーションの本番バージョンを変更することなく、機能の構築とテストができます。

特定のコネクタについて、dev と prod の両環境で同じ connector ID を選択すると、dev で開発してから、コード内の変数を一切変更せずに prod へ push できます。

dev 環境は、prod 環境のアプリケーションとは別の、独立した完全なバックエンドアプリケーションです。

環境の選択

コンソールでの環境

コンソールでコネクタを追加または管理する前に、正しい環境にいることを確認してください。Squid Console で環境を切り替えるには、コンソール上部の環境名を選択し、表示したい環境を選択します。

開発時の環境

デフォルトでは、.env ファイル内の environmentId と apiKey は dev に設定されているため、これらのフラグを付けずにコマンドを実行すると、そのコマンドは dev 環境がデフォルトになります。

アプリのフロントエンドで環境を切り替えるには、Squid context で適切な environmentId 値を使用します。

<SquidContextProvider
  options={{
    appId: 'YOUR_APP_ID',
    region: 'YOUR_REGION', // example: 'us-east-1.aws'
    environmentId: 'dev', // or 'prod'
  }}
>
  <App />
</SquidContextProvider>

主要な環境変数

環境変数（environment variables）は「envars」とも呼ばれ、開発環境と本番環境の両方でアプリケーションを構成・運用するために不可欠です。

• SQUID_APP_ID: ユニークな Squid アプリケーション識別子。（コマンドラインで使用する場合は --appId）
• SQUID_REGION: 'us-east-1.aws' などのリージョンを指定。（コマンドラインで使用する場合は --region）
• SQUID_ENVIRONMENT_ID: 作業環境（'dev' または 'prod'）を示します。（コマンドラインで使用する場合は --environmentId）
• SQUID_API_KEY: API アクセス用の固有キー。環境ごとに異なります。（コマンドラインで使用する場合は --apiKey）
• SQUID_DEVELOPER_ID: Squid backend をローカルで実行するために必要。.env ファイルまたは Squid Console で確認できます。（コマンドラインで使用する場合は --squidDeveloperId）

Netlify や GitHub Actions のようなツールを用いた自動デプロイでは、これらの環境変数をデプロイマシン上、またはデプロイツールの設定内に直接設定することを推奨します。この方法により、API Key のような機密情報のセキュリティと管理が向上します。

デプロイマシンまたはデプロイプロセス上で変数を設定することで、開発用と本番用の設定を明確に分離することもできます。

セキュリティ上の注意

機密性の高い変数、特に API Key の取り扱いには注意してください。セキュリティリスクを避けるため、クライアントサイドのコードに決して露出させないでください。こうした重要情報は常に、サーバー側または保護された環境変数内で安全に管理してください。

コンソールで envars を確認する

管理を容易にするために、Squid Console から環境変数をコピーできます。この機能は、開発およびデプロイの両方の目的で変数を正確に設定するのに役立ちます。 Squid Console の Show env vars ボタンは、これらの変数にアクセスするための便利なツールです。

また、"Create .env file" ボタンをクリックして、ローカル開発用の .env ファイルを生成することもできます。