はじめに
Merlon を最短で起動し、空の状態からオペレーターダッシュボードに到達するまでの手順。
空のシステムではなくデータの入った状態を見たい場合は、デモツアーから始めるとよい。約1,015件の合成顧客データと98件のアラートが同梱されており、アカウント作成も不要である。
前提条件
- Docker 24+
- Docker Compose v2+
git
ローカルに Go / Node.js をインストールする必要はない。以下はすべてコンテナ内で完結する。
1. 起動する
git clone https://github.com/ksuk/merlon.git
cd merlon
cp .env.example .env
mkdir -p operator-content/tm_scenarios operator-content/screening_lists
cp content/_sample/cdd_weights/funds_transfer.yaml operator-content/cdd_weights.yaml
cp content/_sample/tm_scenarios/*.yaml operator-content/tm_scenarios/
cp deploy/seed/demo/screening_lists/*.yaml operator-content/screening_lists/
docker compose up --build
標準トポロジーはoperator-contentをread-onlyでマウントし、ネイティブEngineを必須とする。ここでコピーするファイルはローカル評価用の合成サンプルであり、実データを使用する前に、レビュー済みで導入組織が承認したポリシーコンテンツへ置き換えること。ディレクトリまたはいずれかの必須rootが存在しない、または不正な場合、プロセスはセットアップと診断のためliveのままになるが、GET /healthz/readyは"engine":"error"を含む503を返し、システム状態画面はEngineを利用不能として表示する。
初回ビルドには数分かかる。Compose はデータベースパスワード、ブートストラップトークン、開発用 JWT 署名シークレットを .env から読み込むため、2行目のコピーは省略できない。省略すると、ログインフローを提供できる状態になる前に起動が停止する。
次の行が出るまで待つ。
{"level":"INFO","msg":"merlon-api starting","env":"development","mode":"all","addr":":8080"}
2. 管理者アカウントを作成する
このトポロジーでは認証が有効であり、まだアカウントが1つも存在しないため、ログイン画面のままでは先に進めない。ログインフォームの下にある「管理者アカウントを作成する」から作成するか、http://localhost:8080/setup を直接開く。
メールアドレスと12文字以上のパスワードを入力する。このルートはアカウントが存在しない間だけ有効であり、最初の管理者が作成された後はリクエストを拒否する。ログイン後、「ユーザ管理」で運用モデルに必要な Analyst と Viewer のアカウントを作成する。同じ画面でロール、有効状態、代替パスワードを変更でき、いずれの変更も対象アカウントの既存セッションを無効化する。
:::note healthy はセットアップ完了を意味しない
標準ComposeのヘルスチェックはGET /healthz/readyを参照するため、Engineが読み込まれ、最初の管理者が作成されるまでdocker psはコンテナをunhealthyと表示する。プロセス自体はセットアップと診断のためGET /healthz/liveへ応答する。トラブルシューティングを参照。
:::
3. ログインする
作成したアカウントでログインする。顧客一覧が空でアラートも無いダッシュボードが表示されれば正常である。まだ何も投入していないため、これは期待どおりの状態である。
「ユーザ管理」を開き、Analyst と Viewer のアカウントを個別に作成して、それぞれログインできることを確認する。有効な Admin は最低1つ維持する。最後の有効Adminを無効化または降格する操作はAPIが拒否する。
次のステップ
| 目的 | 参照先 |
|---|---|
| データが入った状態で製品を見る | デモツアー |
| 自組織の顧客・取引を投入する | 初期移行 |
| スコアとアラートの仕組みを理解する | アーキテクチャ |
| ルールを調整する | ルール作成 |
| 設定を変更する | 設定リファレンス |
| 実運用する | デプロイ |
| うまく動かない | トラブルシューティング |
この環境を手元から出す前に
.env.example には開発専用の認証情報が含まれており、そのすべてに MUST change in production が明記されている。上記の compose ファイルはポート 8080 を全インターフェースで公開する点にも注意すること。
このクイックスタートはローカルマシンでの評価用である。それ以外の場所で Merlon を動かす前に、デプロイと設定リファレンスを読むこと。開発用の初期認証情報のまま規制記録を生成するシステムは、後から説明のつくものではない。