コンテンツにスキップ
Authrim

Admin UIプラグイン管理

Authrim Admin Consoleは、コードやAPI呼び出しを書かずにプラグインを管理するためのグラフィカルインターフェースを提供します。

プラグイン一覧

設定 > プラグインに移動して、登録済みのすべてのプラグインを表示します。

プラグイン一覧には以下が表示されます：

  • プラグインアイコンと名前
  • 簡単な説明
  • カテゴリバッジ（notification、identity、authentication、flow）
  • ステータスインジケーター（有効/無効）
  • 信頼レベルバッジ（Official/Community）

フィルタリング

フィルターコントロールを使用してリストを絞り込みます：

フィルターオプション
カテゴリAll、Notification、Identity、Authentication、Flow
ステータスAll、Enabled、Disabled
信頼レベルAll、Official、Community

プラグインカード

各プラグインカードには以下が表示されます：

要素説明
アイコンプラグインアイコン（Lucideアイコンまたはカスタム）
名前メタデータからの表示名
バージョンセマンティックバージョン（例：1.0.0）
説明短い説明
カテゴリバッジnotification、identity、authentication、またはflow
ステータスバッジEnabled（緑）またはDisabled（グレー）
信頼バッジOfficial（検証済み）またはCommunity（警告）

カードをクリックして詳細ダイアログを開きます。

詳細ダイアログ

プラグイン詳細ダイアログは包括的な情報とコントロールを提供します：

概要タブ

  • 完全な説明
  • 作者情報
  • ライセンス
  • ドキュメントリンク（ある場合）
  • リポジトリリンク（ある場合）
  • 安定性ステータス（stable、beta、alpha、deprecated）
  • 検索/分類用のタグ

設定タブ

設定フォームはプラグインのZodスキーマから自動生成されます：

スキーマタイプUIコンポーネント
z.string()テキスト入力
z.string().url()バリデーション付きURL入力
z.number()min/max付き数値入力
z.boolean()トグルスイッチ
z.enum([...])ドロップダウン選択
機密フィールドパターンパスワード入力（マスク）

設定フィールドには以下が表示されます：

  • ラベル（.describe()から）
  • 現在の値
  • デフォルト値（異なる場合）
  • バリデーションメッセージ

ヘルスタブ

プラグインのヘルスチェック結果を表示：

ステータスインジケーター説明
healthy緑プラグインは正常に動作中
degraded黄動作中だが問題あり
unhealthy赤動作していない
unknownグレーヘルスデータなし

ヘルスチェックの詳細には以下が含まれる場合があります：

  • 最終チェックのタイムスタンプ
  • ステータスメッセージ
  • 個別のチェック結果（API接続性、認証情報など）

管理者メモ

プラグインが管理者メモを提供する場合、折りたたみ可能なセクションに以下が表示されます：

  • 設定のヒント
  • 既知の制限事項
  • 移行手順
  • デプロイメモ

設定の編集

  1. プラグイン詳細ダイアログを開く
  2. 設定タブに切り替え
  3. フィールド値を変更
  4. 設定を保存をクリック

バリデーション

  • 入力中のリアルタイムバリデーション
  • 必須フィールドインジケーター
  • 数値のmin/max制約
  • URLフォーマット検証
  • カスタムバリデーションメッセージ

設定ソース

UIは現在の設定がどこから来ているかを表示します：

ソースバッジ説明
kvKV StorageAdmin UI/API経由で保存
envEnvironment環境変数から
defaultDefaultスキーマのデフォルト値

有効化/無効化

プラグインの有効化

  1. プラグイン詳細ダイアログを開く
  2. 有効化ボタンをクリック
  3. 設定が必要な場合は、まずフォームを完成させる
  4. アクションを確認

プラグインの無効化

  1. プラグイン詳細ダイアログを開く
  2. 無効化ボタンをクリック
  3. 依存関係の警告を確認（該当する場合）
  4. アクションを確認

ヘルスチェック

手動ヘルスチェック

  1. プラグイン詳細ダイアログを開く
  2. ヘルスタブに切り替え
  3. ヘルスチェック実行をクリック
  4. 結果を確認

自動ヘルスチェック

ヘルスチェックは自動的に実行されます：

  • プラグイン有効化時
  • 定期的（設定可能な間隔）
  • 設定変更時

コミュニティプラグインの警告

コミュニティプラグインを表示すると、警告バナーが表示されます：

コミュニティプラグイン

このプラグインはサードパーティによって提供されています。Authrimはそのセキュリティ、信頼性、互換性を保証しません。ソースコードを確認し、自己責任で使用してください。

警告には以下が含まれます：

  • 作者情報
  • リポジトリリンク（ある場合）
  • ライセンス情報

マルチテナント設定

マルチテナントデプロイの場合：

  1. テナントドロップダウン（右上）からテナントを選択
  2. テナント固有の設定を表示/編集
  3. テナント設定はグローバル設定をオーバーライド

テナント設定には以下が表示されます：

  • 継承された値（グローバルから）
  • オーバーライドされた値（テナント固有）
  • グローバル値にリセットするオプション

クイックアクション

プラグイン一覧で、カードにホバーするとクイックアクションが表示されます：

アクションアイコン説明
トグルスイッチダイアログを開かずに有効/無効を切り替え
設定歯車設定タブに直接ジャンプ
ヘルスハートヘルスチェックを実行

検索

検索バーを使用して以下でプラグインを検索：

  • 名前
  • 説明
  • タグ
  • カテゴリ
  • 作者

キーボードショートカット

ショートカットアクション
/検索にフォーカス
Escダイアログを閉じる
Tabフィールドをナビゲート
Enterフォームを送信

APIリファレンス

プログラムによるアクセスについては、プラグイン管理APIドキュメントを参照してください。

一般的な操作：

タスクAPIエンドポイント
プラグイン一覧GET /api/admin/plugins
プラグイン取得GET /api/admin/plugins/:id
設定更新PUT /api/admin/plugins/:id/config
有効化PUT /api/admin/plugins/:id/enable
無効化PUT /api/admin/plugins/:id/disable
ヘルスチェックGET /api/admin/plugins/:id/health
スキーマ取得GET /api/admin/plugins/:id/schema

トラブルシューティング

プラグインが表示されない

  1. プラグインがワーカーに登録されているか確認
  2. プラグインが正しくエクスポートされているか検証
  3. ワーカーログで登録エラーを確認

設定が保存されない

  1. フォームのバリデーションエラーを確認
  2. 管理者権限があるか検証
  3. ブラウザコンソールでAPIエラーを確認

ヘルスチェックが失敗

  1. エラーメッセージを確認
  2. プラグインの依存関係（外部サービス）を確認
  3. 設定値（APIキー、エンドポイント）を検証
  4. ワーカーからのネットワーク接続性を確認

コミュニティプラグインに関する懸念

コミュニティプラグインにセキュリティ上の懸念がある場合：

  1. ソースコードを確認
  2. 作者の評判を確認
  3. 依存関係を監査
  4. まずテスト環境で実行することを検討