6.4. Apicurio Registry Web コンソールを設定する
デプロイメント環境専用の Apicurio Registry Web コンソールを設定したり、その動作をカスタマイズしたりすることができます。本セクションでは、Apicurio Registry Web コンソールにオプションの環境変数を設定する方法を説明します。
前提条件
- Apicurio Registry がすでにインストールされている必要があります。
Web コンソールのデプロイメント環境の設定
ユーザーがブラウザーで Apicurio Registry Web コンソールに移動すると、一部の初期設定が読み込まれます。以下の 2 つの重要な設定プロパティーがあります。
- バックエンド Apicurio Registry REST API の URL
- フロントエンド Apicurio Registry Web コンソールの URL
通常、Apicurio Registry はこれらの設定を自動的に検出して生成しますが、一部のデプロイメント環境ではこの自動検出が失敗する場合があります。その場合には、環境のこれらの URL を明示的に設定するように環境変数を設定できます。
手順
以下の環境変数を設定し、デフォルトの URL を上書きします。
-
REGISTRY_UI_CONFIG_APIURL: バックエンド Apicurio Registry REST API の URL を設定します。例:https://registry.my-domain.com/apis/registry -
REGISTRY_UI_CONFIG_UIURL: フロントエンド Apicurio Registry Web コンソールの URL を設定します。たとえば、https://registry.my-domain.com/ui
読み取り専用モードでのコンソールの設定
オプション機能として、Apicurio Registry の Web コンソールを読み取り専用モードに設定することができます。このモードでは、Apicurio Registry Web コンソールでユーザーが登録されたアーティファクトを変更できる機能がすべて無効になります。たとえば、これには以下が含まれます。
- アーティファクトの作成
- アーティファクトの新規バージョンのアップロード
- アーティファクトのメタデータの更新
- アーティファクトの削除
手順
以下の環境変数を設定して、Apicurio Registry Web コンソールを読み取り専用モードで設定します。
-
REGISTRY_UI_FEATURES_READONLY:trueに設定すると、読み取り専用モードが有効になります。デフォルトはfalseです。