Unitの設定一覧
Unit設定ファイルは、Personium Unitの設定を行うための "personium-unit-config.properties" という名前のjavaプロパティファイルです。このファイルを所定の場所に配置しサーブレットコンテナを起動すると、Unitはこのファイルで定義された項目はその設定値を使い、定義されていない項目についてはデフォルトの設定値を使って動作します。
デフォルト設定値
Unit設定のデフォルト設定値はGitHubソース上の "personium-unit-config-default.properties" ファイル(war ファイルに同梱)で定義されています。 このファイル自体に変更を加えることでもUnit設定は切替わりますが、非推奨です。
Unit設定ファイルの配置場所
Unit設定ファイルの配置場所はJavaのシステムプロパティで指定可能です。
io.personium.configurationFile={ファイル名まで含めたPath}
指定された場所にファイルが存在しない、またはシステムプロパティで場所が指定されていない場合、クラスパス上の"personium-unit-config.properties"を読み込みます。
personium-unit-config.propertiesが正しく読み取られたかどうかを確認するには、起動ログをご確認ください。
Unit設定ファイルのキー名について
すべてのキーは、以下のキープレフィックスを持ちます。
io.personium.core.
例としてUnit証明書の設定には次のキーを使用する必要があります。
io.personium.core.x509.crt
変更必須設定
Personiumを運用する上でデフォルトから変更を必須としている設定です。これら設定を変更せずにPersonium Unitを起動すると、正しく動作しなかったり、セキュリティ上の問題が発生します。必ず設定を行ってください。
| キー | 説明 | 値 | 記載例 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| x509.key | X509秘密鍵を配置したパス | PEM形式秘密鍵のフルパス | /opt/x509/localhost.key | core, engine | |
| x509.crt | X509証明書を配置したパス | PEM形式証明書のフルパス | /opt/x509/localhost.crt | core, engine | |
| x509.root | X509ルート証明書を配置したパス | 信頼すべきPEM形式ルート証明書のフルパス スペース区切りで複数指定可能 | /opt/x509/personium_ca.crt | core, engine | 何も指定しなければ(キーの定義もしない)、Personiumプロジェクト公式CAの証明書は自動的に信頼されます。 |
| security.secret16 | トークンとファイル生成時の暗号化キー | 16桁の16進文字列 | secret16abcdefgh | core, engine | |
| unitUser.issuers | Unitユーザトークン発⾏者として認定する文字列 Cell URLを指定することでそのCellをUnitユーザトークン発行者として指定できます | URL スペース区切りで複数指定可能 | http://localhost:8080/UnitUserCell/ | core |
変更任意設定
Personiumを運用する上でデフォルトからの変更を任意としている設定です。
基本設定
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| version | バージョン | 文字列 | core, engine | ||
| thread.pool.num | スレッドプール数 | int | 20 | core | v1.5.4～v1.6.9。PersoniumUnit全体のスレッドプール数。v1.6.10以降は機能ごとにスレッドプールを分割。 |
| thread.pool.num.io.cell | Cell Export/Importで使用するスレッドプール数 | int | 10 | core | v1.6.10以降。 |
| thread.pool.num.io.box | Box Export/Installで使用するスレッドプール数 | int | 20 | core | v1.6.10以降。 |
| thread.pool.num.misc | 汎用スレッドプール数 | int | 10 | core | v1.6.10以降。 |
| plugin.path | Personiumプラグイン配置先パス | プラグイン配置先フルパス | /personium/personium-core/plugins | core | |
| unitScheme | Unitのスキーム設定 | "http" または "https" | https | core | 開発用途にhttpを設定することも可能ですが、運用時には必ずhttpsを設定してください。 |
| unitPort | Unitのポート番号 | ポート番号 | core | v1.6.0以降。UnitURLが "https://p-host:8080/" の場合、unitPortは8080になります。UnitURLが "https://p-host/" の場合、unitPortは設定しません。 | |
| masterToken | マスタートークン | トークン文字列 | core, engine | デフォルトは無効です。開発用途などで設定することもできますが、運用時には設定しないでください。 | |
| pathBasedCellUrl.enabled | CellにアクセスするURL形式 | true:path based cell url false:per cell fqdn url | v1.7.5以前:true v1.7.6以降:false | core | v1.7.0以降 |
Cell
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| cell.relayhtmlurl.default | Cellルート取得API実行時にアクセスするURL | URL | core | v1.6.15以降。 | |
| cell.authorizationhtmlurl.default | OAuth2.0 認可エンドポイントAPIの認証フォームリクエスト実行時にアクセスするURL | URL | core | v1.6.15以降。 | |
| cell.authorizationpasswordchangehtmlurl.default | OAuth2.0 認可エンドポイントAPIのパスワード変更フォームリクエスト実行時にアクセスするURL | URL | core | v1.7.7以降。 |
OData
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| odata.batch.bulkRequestMaxSize | $batch処理を行う際のリクエスト最大件数 | Int | 1000 | core | |
| odata.batch.timeoutInMillis | $batch処理のタイムアウト時間(msec) | Long | 270000 | core | |
| odata.batch.sleepInMillis | $batch処理のスリープ時間(msec) | Long | 50 | core | |
| odata.batch.sleepIntervalInMillis | $batch処理のスリープ間隔(msec) | Long | 1000 | core | |
| odata.links.NtoN.maxnum | N:Nの$linksが作成可能な最大件数 | Int | v1.7.5以前:10000 v1.7.6以降:150000 | core | |
| odata.query.expand.top.maxnum | $expand指定時の$top最大数 | Int | 100 | core | |
| odata.expand.retrieve.maxnum | $expandの最大展開数（一件取得時） | Int | 1000 | core | |
| odata.query.top.maxnum | $topの最大値数 | Int | 10000 | core | |
| odata.query.skip.maxnum | $skipの最大値数 | Int | 100000 | core | |
| odata.query.top.defaultnum | 一覧取得時のデフォルト返却件数 | Int | 25 | core | |
| odata.query.expand.property.maxnum.list | $expandのプロパティの最大値数（一覧取得時） | Int | 2 | core | |
| odata.query.expand.property.maxnum.retrieve | $expandのプロパティの最大値数（一件取得時） | Int | 10 | core |
アカウント
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| account.lastauthenticated.enabled | パスワード認証成功時に、Accountの最終ログイン時刻を更新するか | true:更新する false:更新しない | true | core | ～v1.7.4 v1.7.5で廃止 最終更新日時を記録すると認証処理内部で登録処理が⾏われるため、書き込みの多重ロックの影響を受けます（ロック範囲はCell単位）。 また書き込みが発生するため性能の低下が発生します。 Basic認証はこの設定で最終ログイン日時の記録は行われません。 |
WebDAV
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| dav.childresource.maxnum | コレクションの子要素の最大数 | Int | 1024 | core | |
| dav.depth.maxnum | コレクションの階層の深さの最大数 | Int | 50 | core |
セキュリティ
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| security.dav.encrypt.enabled | WebDAVファイルを暗号化するか | true:暗号化する false:暗号化しない | false | core | v1.5.1以降 |
| security.auth.password.regex | パスワード制限 | 文字列 正規表現パターン | ^[a-zA-Z0-9-_!$*=^`{|}~.@]{6,32}$ | core | v1.7.5以降 ※パスワードの文字数は1〜256です。制限に関係なく、257文字以上のパスワードを設定することはできません。 |
| security.auth.password.hashAlgorithm | パスワードのハッシュアルゴリズム | 文字列 "scrypt"または"sha-256" | scrypt | core | v1.7.8以降 ※"scrypt"を推奨 ※"sha-256"は非推奨（旧方式のハッシュアルゴリズム。後に削除する予定。） |
| security.auth.password.scrypt.cpuCost | scryptハッシュのCPUコスト | Int 2のべき乗 | 16384 | core | v1.7.8以降 |
| security.auth.password.scrypt.memoryCost | scryptハッシュのメモリコスト | Int | 8 | core | v1.7.8以降 |
| security.auth.password.scrypt.parallelization | scryptハッシュの並列化数 | Int | 1 | core | v1.7.8以降 |
| security.auth.password.scrypt.keyLength | scryptハッシュのキー長 | Int | 32 | core | v1.7.8以降 |
| security.auth.password.scrypt.saltLength | scryptハッシュのソルト長 | Int | 64 | core | v1.7.8以降 |
| security.auth.password.salt | SHA256アルゴリズム使用時のパスワードハッシュソルト値 | 16桁の16進文字列 | saltijkl | core | scrypt使用時は無効 |
| security.token.defaultScope.ropc | ROPCでのアクセストークン発行時に付与されるデフォルト (最大) スコープ | スペース区切りのスコープ情報 | root | core | v1.7.18以降 |
| security.token.defaultScope.assertion | assertionでのアクセストークン発行時に付与されるデフォルト (最大) スコープ | スペース区切りのスコープ情報 | root | core | v1.7.18以降 |
| security.token.defaultScope.grant_code | grant_codeでのアクセストークン発行時に付与されるデフォルト (最大) スコープ | スペース区切りのスコープ情報 | root | core | v1.7.18以降 |
Lock
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| lock.type | Lockのタイプ | "memcached":Memcached "inProcess":InProcess | memcached | core | |
| lock.accountlock.time | アカウントロックの有効期限(sec) 認証失敗時にそのアカウントの認証をロックし、認証を失敗させる期間 | Int | 1 | core | ～v1.7.4 v1.7.5で廃止 |
| lock.retry.times | ロック取得時のリトライ回数 | Int | 50 | core | |
| lock.retry.interval | ロック取得リトライ時の間隔(msec) | Long | 100 | core | |
| lock.cell.retry.times | Cellロック取得時のリトライ回数 | Int | 50 | core | |
| lock.cell.retry.interval | Cellロック取得リトライ時の間隔(msec) | Long | 100 | core | |
| lock.memcached.host | ロックをmemcachedに保持する際のmemcachedホスト名 | ホスト名 | localhost | core | |
| lock.memcached.port | ロックをmemcachedに保持する際のmemcachedポート番号 | ポート番号 | 11211 | core | |
| lock.memcached.opTimeout | ロック用memcached operationタイムアウト値(msec) | Long | 12000 | core |
認証
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| authn.account.lockCount | アカウントロックの閾値 連続した認証失敗時にそのアカウントをロックし、認証を失敗させる回数 | Int 0～100 | 0 | core | v1.7.5以降 0に設定するとアカウントロックを行いません |
| authn.account.lockTime | アカウントロック期間(sec) 連続した認証失敗時にそのアカウントをロックし、認証を失敗させる期間 | Int 0～2592000（30日） | 0 | core | v1.7.5以降 0に設定するとアカウントロックを行いません |
| authn.account.validAuthnInterval | 有効な認証間隔(sec) 認証間隔よりも短い間隔で認証試行を失敗させる | Int | 1 | core | v1.7.5以降 |
Elasticsearch
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| es.hosts | Elasticsearch ホスト名 | Elasticsearchのノードを{host:port}形式で指定 カンマ区切りで複数指定可能 | localhost:9300 | core, engine | 接続可能なノードが１つでも指定されていれば動作可能です。 |
| es.cluster.name | Elasticsearch クラスタ名 | 文字列 | clusterpersonium | core, engine | |
| es.unitPrefix | Elasticsearchを使用する際、index生成時のindex名に用いるプレフィックス | 文字列 | u0 | core, engine | 通常はUnit名を指定します。 |
| es.topnum | Elasticsearch の検索結果出力上限数 | Int | 10000 | core | |
| es.retryTimes | エラー発生時のリトライ回数 | Int | 3 | core | |
| es.retryInterval | エラー発生時のリトライ間隔(msec) | Int | 1500 | core | |
| es.index.numberOfShards | Elasticsearch シャード数 | Int | 10 | core | v1.7.5以降 |
| es.index.numberOfReplicas | Elasticsearch レプリカ数 | Int | 0 | core | v1.7.5以降 |
| es.index.maxResultWindow | Elasticsearch 最大結果表示数 | Long | v1.7.6以前:110000 v1.7.7以降:150000 | core | v1.7.5以降 |
| es.index.merge.scheduler.maxThreadCount | Elasticsearch マージスケジューラの最大スレッド数 | Int | core | v1.7.5以降 |
BinaryData
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| binaryData.physical.delete.mode | ファイル削除時に物理削除するか | true:物理削除 false:論理削除 | true | core | 論理削除時は削除されたファイルが残り続けるためディスクを圧迫する可能性があります。 |
| binaryData.fsync.enabled | ファイルへの書き込み時にfsyncを有効にするか | true:有効 false:無効 | false | core, engine | 有効にした場合WebDAVのファイルを書き込む際にfsyncを行うためWebDAV登録性能が劣化します。 バックアップをスナップショットなどで取得したりディスクへの書き込みを厳密にする必要がある場合は有効にします。 |
| binaryData.dav.retry.count | Davファイルのハードリンク作成/改名/削除時のリトライ回数 | Int | 100 | core | |
| binaryData.dav.retry.interval | Davファイルのハードリンク作成/改名/削除時のリトライ間隔(msec) | Long | 50 | core |
BlobStore
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| blobStore.root | blobデータを格納するルートパス | ディレクトリのフルパス | /personium_nfs/personium-core/dav | core, engine |
ユーザデータ
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| box.odata.schema.MaxEntityTypes | EntityTypeの最大数 | Int | 100 | core | |
| box.odata.schema.MaxProperties | EntityTypeに含まれるプロパティの最大数 | Int | 400 | core | |
| box.odata.schema.property.LayerLimits.SimpleType | 各階層のSimpleTypeの最大数 | Int カンマ区切り | *,50,30,10 | core | |
| box.odata.schema.property.LayerLimits.ComplexType | 各階層のComplexTypeの最大数 | Int カンマ区切り | 20,5,2,0 | core |
Event
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| event.log.current.dir | イベントログファイルの格納ディレクトリ | ディレクトリのフルパス | /personium_nfs/personium-core/eventlog | core | |
| event.hop.maxnum | あるイベントを契機としたイベント処理を繰り返す最大数 | Int | 3 | core | v1.6.2以降。0に設定するとルールによるイベント処理は行われなくなります。 |
キャッシュ
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| cache.type | キャッシュのタイプ | "memcached":memcachedでキャッシュ "none":キャッシュ無効 | memcached | core | noneにした場合管理情報を毎回Elasticsearchに問い合わせるためElasticsearchの負荷が上昇します。 |
| cache.cell.enabled | Cellのキャッシュを有効とするか | true:有効 false:無効 | true | core | |
| cache.box.enabled | Boxのキャッシュを有効とするか | true:有効 false:無効 | true | core | |
| cache.schema.enabled | Schemaのキャッシュを有効とするか | true:有効 false:無効 | true | core | |
| cache.memcached.host | memcachedホスト名 | ホスト名 | localhost | core | |
| cache.memcached.port | memcachedポート番号 | ポート番号 | 11212 | core | |
| cache.memcached.opTimeout | memcached operationタイムアウト値(msec) | Long | 12000 | core | |
| cache.memcached.expiresin | キャッシュ有効期間(sec) | Int | 86400 | core |
Engine
"engine.host", "engine.port", "engine.path"はCoreからEngineへアクセスする際に使用します。
http://{engine.host}:{engine.port}/{engine.path}
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| engine.host | Engineサーバのホスト名 | ホスト名 | localhost | core | |
| engine.port | Engineサーバのポート番号 | ポート番号 | 8080 | core | |
| engine.path | Engineのパス | パス | personium-engine | core | |
| engine.script.cache.maxNum | Engineスクリプトのキャッシュ最大登録数 | Int | 100000 | engine | 最大登録数を超えた場合、最終アクセス日時の古いものから削除されます。 v1.5.19以降 |
| engine.script.connection.timeout | Engineスクリプトのコネクションタイムアウト時間(msec) | Int | 50000 | engine | Engineスクリプト内でAPIを呼び出す際のコネクションタイムアウト時間を設定。 v1.5.21以降 |
barファイル
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| bar.file.maxSize | barファイルの最大ファイルサイズ(MB) | Long | 100 | core | |
| bar.entry.maxSize | barファイル内エントリの最大ファイルサイズ(MB) | Long | 10 | core | |
| bar.userdata.linksOutputStreamSize | ユーザデータのリンク処理時にレスポンスを返却するサイズ | Long | 5 | core | |
| bar.userdata.bulkSize | ユーザデータの一括登録件数 | Long | 1000 | core | |
| bar.installfile.dir | barファイルやログ詳細の格納用ルートディレクトリ | ディレクトリのフルパス | /personium_nfs/personium-core/barInstall | core | |
| bar.progress.expireInSec | memcachedに格納するbarインストール処理状況の有効期限(sec) | Int | 259200 | core |
OpenID Connect
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| oidc.google.trustedClientIds | Google OpenID Connectにおいて、このUnitが信頼するClientID スペース区切りで複数指定可能 | 文字列 | * | core | "*"を指定した場合全てのClientIDを信頼する 将来的にPlugin独自設定として移動予定 |
CellSnapshot
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| cellSnapshot.root | snapshotデータを格納するルートパス | ディレクトリのフルパス | /personium_nfs/personium-core/snapshot | core | v1.5.4以降 |
EventBus
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| eventbus.mq | メッセージキュー | activemq kafka | activemq | core | 使用するメッセージキューを選択します v1.6.8以降 |
| eventbus.broker | メッセージキューのbroker URL | URL | tcp://localhost:61616 | core | v1.7.4以降 |
| eventbus.queue | イベントのキュー名 | 文字列 | personium_event_queue | core | v1.6.0以降 |
| eventbus.topic.all | イベントのトピック名 | 文字列 | personium_event_topic | core | v1.6.0以降 |
| eventbus.topic.rule | ルールイベントのトピック名 | 文字列 | personium_event_topic_rule | core | v1.6.0以降 |
| eventbus.eventProcessing.thread.num | イベント処理用スレッド数 | Int | 1 | core | v1.6.8以降 |
Rule
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| rule.timerEvent.thread.num | タイマーイベント送信用のスレッド数 | Int | 1 | core | v1.6.8以降 |
Stream Collection
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| stream.mq | メッセージキュー | activemq kafka | core | 使用するメッセージキューを選択します。何も設定しなければStream Collectionは無効になります v1.7.4以降 | |
| stream.broker | メッセージキューのbroker URL | URL | core | v1.7.4以降 | |
| stream.username | brokerへの認証に使用するユーザ名 | 文字列 | core | 認証の必要のないbrokerには設定しないでください v1.7.4以降 | |
| stream.password | brokerへの認証に使用するパスワード | 文字列 | core | 認証の必要のないbrokerには設定しないでください v1.7.4以降 | |
| stream.expiresIn | Streamに送信するメッセージの有効期間(sec) | Int | 3600 | core | activemqのみ有効 v1.7.4以降 |
Token Introspection
| キー | 説明 | 値 | デフォルト値 | 使用コンポーネント | 備考 |
|---|---|---|---|---|---|
| introspect.username | ユーザ名 | 文字列 | core | Resource ServerからToken Introspectionにアクセスする際のBasic認証用 v1.7.4以降 | |
| introspect.password | パスワード | 文字列 | core | Resource ServerからToken Introspectionにアクセスする際のBasic認証用 v1.7.4以降 |