Notariumドキュメント
ドキュメントのバージョン: latest

設定

Notarium の設定は環境変数で行います。シークレットもパスも、イメージには焼き込みません。デフォルトはゼロコンフィグを前提としており、まっさらなインスタンスは設定ゼロで立ち上がります。このページは主要な変数の概要です。正確な値とデフォルトを含む完全な一覧はリファレンスにあります。

設定は docker run-e フラグ、または .env ファイル(.env.example からコピーします)で指定します。Docker スタックは .env をそのままコンテナへ渡します。

主要な変数

変数役割デフォルト
DATA_DIRデータに関する唯一のつまみ。メタデータデータベース、インデックス、ノート、成果物と、ほかのすべてがここから導かれるルートです。未設定なら実用的なデフォルトが使われます。/data(Docker)、~/.local/share/notarium(ホスト)
PORTバックエンドが待ち受けるポート(/api/mcp、そして Web インターフェース)。3000
AUTH_MODE認証モード:password または nonepassword
META_DB_URLメタデータデータベース:sqlite:<path> または postgres://…。任意 — 外部 Postgres を使うときだけ指定します。デフォルトでは DATA_DIR 配下の SQLite です。sqlite:<DATA_DIR>/meta.db
SPACES_ROOT各スペースが 1 つのフォルダになるルート。インターフェースからのスペース作成もこれで有効になります。任意 — ノートが DATA_DIR の外にある場合のみ。<DATA_DIR>/spaces
VECTOR_SEARCHon/off — セマンティック検索(ベクトル検索)。公開イメージでは off(コード上は on)

各トピックは専用ページで解説しています。認証(AUTH_MODE)、データベース(META_DB_URL)、セマンティック検索(VECTOR_SEARCH とモデルのパラメータ)。

スペースのトポロジー

スペースを定義する方法は 2 つあります。

  • SPACES_ROOT — ゼロコンフィグ。各スペースは指定したルート配下のフォルダです。スペースは初回起動時と、インターフェースの「New space…」ボタンで作成されます。Docker スタックのデフォルトはこちらです。
  • SPACES_CONFIG — 明示的で固定されたトポロジー(インライン JSON、または JSON ファイルへのパス)。スペースの集合をオペレーターが決めていて、インターフェースからは作成しない構成に向いています。

スペースとプロジェクトのモデルについてはコンセプトを参照してください。

エージェントの認証(OAuth)

個人トークン(PAT)に加えて、Notarium は MCP コネクタを OAuth で認可できます。エージェント(たとえば Claude コネクタ)が自分で認証を済ませるので、トークンを手で貼り付ける必要はありません。これには個別の設定は要りません。クライアントは動的に登録されます。リバースプロキシの背後では PUBLIC_BASE_URL(たとえば https://notes.example.com)を設定してください — OAuth メタデータ用の、変わらない外部アドレスになります。設定しない場合、アドレスはプロキシの転送ヘッダーから導出されます。同じくプロキシの背後では TRUST_PROXY も設定しておくとよいでしょう。ログインと新しいコネクタの受け入れに関する制限が、プロキシのアドレスではなく本当のクライアントIPごとに数えられるようになります — 本番環境を参照してください。エージェントの接続について詳しくはエージェントを接続するをご覧ください。

完全なリファレンス

検索まわりの変数(EMBED_MODELEMBED_DIMENSIONSEMBED_CPU_MEM_ARENA など)、同期のタイミング、その他の細かいつまみは、環境変数ページの表にまとめてあります。

次は、認証を設定し、必要に応じてセマンティック検索も設定してください。