Environment Variables

はじめに

Environment variablesは、アプリケーションのsource codeの外部で定義できるkey-value pairsです。これらの変数には以下の利点があります：

• セキュリティ：Environment variablesは機密情報を安全に保つのに役立ちます。APIキー、トークン、データベースの認証情報などは、コードに直接保存すべきではありません。コードにアクセスできる人なら誰でもそれらを見ることができるためです。代わりに、environment variablesはこれらの機密情報を安全に保存し、codebaseから隔離します。

• 設定の柔軟性：Environment variablesを使用することで、デプロイ環境に基づいて設定を簡単に切り替えることができます。たとえば、ローカル開発と本番環境で異なるAPIエンドポイントを使用したり、デバッグツールのオン/オフを切り替えたりできます。この柔軟性により、コードを変更することなく、さまざまなシナリオでのアプリケーションの動作を制御できます。

• スケーラビリティ：Environment variablesを使用すると、再利用可能な設定を作成できます。類似の設定（APIキーやエンドポイントなど）を共有する複数のプロジェクトがある場合、それらの設定をenvironment variablesとして一度定義し、プロジェクト間で使用できるため、セットアップの管理がはるかに簡単になります。

Environment Variablesの使用場面

Environment variablesは通常、以下の領域で使用されます：

1. APIキーとエンドポイント：サードパーティAPIなどの外部サービスへのキーとエンドポイントを保存します（例：REACT_APP_API_KEY、REACT_APP_BASE_URL）。これにより、機密情報が安全に保たれ、デプロイ環境に基づいてエンドポイントを切り替えることができます。

2. フィーチャーフラグ：特定の機能を条件付きで有効化または無効化する場合、environment variablesをフィーチャーフラグとして使用できます。たとえば、REACT_APP_ENABLE_NEW_FEATUREをtrueまたはfalseに設定することで、コードを変更せずに機能を切り替えることができます。

ベストプラクティス

アプリケーションのライフサイクルを通じてセキュリティを確保するために、以下の2つの重要なプラクティスに従ってください：

• セキュリティを維持するために、APIキーやその他の機密情報を定期的にレビューしてローテーションしてください。
• 適切な分離とセキュリティを確保するために、開発環境、プレビュー環境、本番環境で変数に異なる値を設定してください。

Environment Variablesの作成

Catalystコンソールから直接、アプリケーションのenvironment variablesを作成できます。プライベートGit Integration、Slateテンプレート、またはパブリックリポジトリ統合を使用してデプロイされたアプリケーションのenvironment variablesは、デフォルトでCatalystの開発環境に作成されます。

SlateでEnvironment Variablesを作成するには、以下の手順に従います：

1. 任意のデプロイメントをクリックし、左ペインのConfigurationタブに移動してEnvironment Variablesを展開します。

2. Add Variableをクリックします。

3. Saveをクリックします。

アプリケーションに必要な数のenvironment variablesを追加できます。

本番環境での変数の作成

Catalystプロジェクトを本番環境にデプロイした場合、必要に応じて本番環境固有のenvironment variablesを作成できます。上記と同じ手順で本番環境に変数を作成できます。