システム環境変数による入力パラメーターの準備
JSON ファイルを使用する代わりに、システム環境変数を使用して、ワンタッチ Domino セットアップの入力パラメーターを指定できます。
Domino on Docker を実行する場合は、Dockerのシステム環境変数を定義し、
--env-file
パラメーターで指定されたテキストファイルにエクスポートします。Dominoを Windows または UNIX で実行する場合、Domino をインストールした後で、バッチファイルまたはシェルスクリプトを使用するか、個々のコマンドを実行して、サーバーのセットアップに必要なシステム環境変数をエクスポートします。エクスポート・コマンドの構文はさまざまですが、Linux で bash シェルを使用する例は次のとおりです。 export SERVERSETUP_SERVER_TYPE=additional
システム環境変数の名前は、以下の例外を除き、JSON ファイルで指定されたパラメーター名と同様です。
- UNIX のように名前の大文字・小文字が区別されるプラットフォームでは、システム環境変数名を大文字で指定する必要があります。
- JSON 入力は階層構造ですが、環境変数は「フラット」または「グローバル」な名前空間です。そのため、名前の間にアンダースコアを挿入して階層を示す形にしています。たとえば、JSON 入力ファイルは、次のデータを提供します。
"serverSetup": { "server": { "type": "additional", "name": "mailserver1", "domainName": "Renovations", "title": "Renovations Mail Server" },
Docker に指定された対応するシステム環境変数--env-file
は、次のようになります。注:--env-file
を使用する場合は、値を引用符で囲まないでください。SERVERSETUP_SERVER_TYPE=additional SERVERSETUP_SERVER_NAME=mailserver1 SERVERSETUP_SERVER_DOMAINNAME=Renovations SERVERSETUP_SERVER_TITLE=Renovations Mail Server
UNIX bash シェルスクリプトで定義された対応するシステム環境変数は、次のようになります。ワンタッチの Domino セットアップを呼び出すのと同じシェル内でシェル スクリプトを呼び出します。この場合、スペースを含む値だけが引用符で囲まれます。その他の値に引用符を使うことは任意です。スクリプトの実行時に引用符が値から削除されます。export SERVERSETUP_SERVER_TYPE=additional export SERVERSETUP_SERVER_NAME=mailserver1 export SERVERSETUP_SERVER_DOMAINNAME=Renovations export SERVERSETUP_SERVER_TITLE="Renovations Mail Server"
次の表は、サーバー設定、ID ボールト、ワンタッチセットアップの環境設定でサポートされるシステム環境変数を示しています。
- [最初のサーバー ] 列または [追加サーバー] 列の X は、パラメーターがそのタイプのサーバーセットアップに関連していることを示します。
- X の横にアスタリスク (*) が付いている場合は、必須パラメーターを示します。
- 特に注記がない限り、値の形式は文字列です。
- 文字列値の前後に引用符を付けるには、次の規則に注意してください。
- Docker 引数を使用してファイルを指定する場合
--env-file
、引用符は使用できません。 - Windows バッチ・ファイルを使用して指定する場合、引用符は必要ありません。
- UNIX の bash シェルスクリプトで指定する場合、スペースを含む文字列は引用符で囲む必要があります。それ以外の場合、引用符は必要ありません。たとえば、
export SERVERSETUP_SERVER_TITLE="ACME Application Server"
の場合は指定し、export SERVERSETUP_SERVER_TITLE=ACME Application Server
の場合は指定しいません。
- Docker 引数を使用してファイルを指定する場合
- ブール値は、引用符なしで true または false で示されます。
- 数値は、「notes.ini」などの文字列として機能する場合を除き、引用符なしで指定されます。
- 既定値を適用するには、引用符を付けずに null を指定するか、パラメーターを省略します。
サーバー・セットアップのシステム環境変数
変数 | 最初のサーバー | 追加サーバー | デフォルト | 説明 |
---|---|---|---|---|
SERVERSETUP_SERVER_TYPE | X* | X* | サーバーの種類。次のいずれかである必要があります。
|
|
SERVERSETUP_SERVER_NAME | X* | X* | サーバーの共通名 (たとえば Adminserver など)。 |
|
SERVERSETUP_SERVER_DOMAINNAME | X* | X* | Domino ドメイン名 | |
SERVERSETUP_SERVER_TITLE | X | X | None | サーバータイトル |
SERVERSETUP_SERVER_PASSWORD | X | None | サーバー ID のパスワード | |
SERVERSETUP_SERVER_MINPASSWORDLENGTH | X | X | 5 | すべてのパスワードの最小パスワード長。(整数) |
SERVERSETUP_SERVER_USEEXISTINGSERVERID | X | false | 値が true の場合、IDFilePath で指定された既存のサーバー ID が使用されます。デフォルトでは、Dominoデータディレクトリーにserver.idをデフォルトとする新しいサーバーIDを作成します。 | |
SERVERSETUP_SERVER_IDFILEPATH | X | X* | サーバー ID ファイルのパス。Docker では、ID はコンテナーに対して相対的である必要があります。 | |
SERVERSETUP_SERVER_SERVERTASKS | X | X | "Replica,Router,Update,AMgr,Adminp,Sched,CalConn,RnRMgr" | サーバー上で実行されるサーバー タスクのコンマ区切りのリスト。 |
SERVERSETUP_SERVER_ADDITIONALSERVERTASKS | X | X | サーバー上で実行する追加タスクのコンマ区切りのリスト。サーバータスクのデフォルトリストに追加する場合に使用します。 | |
SERVERSETUP_NETWORK_HOSTNAME | X* | X* | DNS ホスト名 | |
SERVERSETUP_NETWORK_ENABLEPORTENCRYPTION | X | X | true | 値が true の場合、ポートの暗号化が有効になります。(ブール値) |
SERVERSETUP_NETWORK_ENABLEPORTCOMPRESSION | X | X | true | 値が true の場合、ポート圧縮が有効になります。(ブール値) |
SERVERSETUP_ORG_COUNTRYCODE | X | X | None | 組織の国コード |
SERVERSETUP_ORG_ORGNAME | X* | X* | 組織名 | |
SERVERSETUP_ORG_CERTIFIERPASSWORD | X* | 組織認証者パスワード | ||
SERVERSETUP_ORG_ORGUNITNAME | X | X | None | 組織のユニット名 |
SERVERSETUP_ORG_ORGUNITPASSWORD | X | X | None | 組織のユニットパスワード |
SERVERSETUP_ORG_USEEXISTINGCERTIFIERID | X | false | 値が true の場合、certifierIDFilePath で指定された既存の証明書 ID を使用します。デフォルトでは、Dominoデータディレクトリーにcert.idをデフォルトとする新しい認証者IDを作成します。Docker では、ID はコンテナーに対して相対的である必要があります。 | |
SERVERSETUP_ORG_CERTIFIERIDFILEPATH | X | None | useExistingCertifierID が trueのときに使用される証明書IDのパス。Docker では、ID はコンテナーに対して相対的である必要があります。 | |
SERVERSETUP_ORG_USEEXISTINGORGUNITID | X | false | 値が true の場合、orgUnitIDFilePath で指定された既存の組織単位認証者 ID を使用します。orgUnitName が指定されている場合のデフォルトでは、Domino データディレクトリーに oucert.id となる新しい組織単位認証者 ID が作成されます。Docker では、ID はコンテナーに対して相対的である必要があります。 | |
SERVERSETUP_ORG_ORGUNITIDFILEPATH | X | なし | useExistingOrgUnitID が true の場合に使用される組織単位認証者 ID のパス。Docker では、ID はコンテナーに対して相対的である必要があります。 | |
SERVERSETUP_ADMIN_FIRSTNAME | X | None | 管理者名 (名) | |
SERVERSETUP_ADMIN_MIDDLENAME | X | None | 管理者のミドル・ネームまたはイニシャル・ネーム | |
SERVERSETUP_ADMIN_LASTNAME | X* | 管理者名 (姓) | ||
SERVERSETUP_ADMIN_PASSWORD | X* | 管理者 ID パスワード | ||
SERVERSETUP_ADMIN_IDFILEPATH | X* | 管理者 ID ファイルパスDocker では、ID はコンテナーに対して相対的である必要があります。 | ||
SERVERSETUP_ADMIN_CN | X* | 管理者の共通の名前。 | ||
SERVERSETUP_SECURITY_ACL_PROHIBITANONYMOUSACCESS | X | X | true | 値が true の場合、匿名ユーザーは新しいデータベースの ACL にアクセスできません。(ブール値) |
SERVERSETUP_SECURITY_ACL_ADDLOCALDOMAINADMINS | X | X | true | 値が true の場合、すべての新しいデータベースの ACL で、LocalDomainAdmins グループ・エントリ・マネージャー・アクセス権を与えます。(ブール値) |
SERVERSETUP_SECURITY_TLSSETUP_METHOD | X* | TLS 成果物 certstore.nsf データベースを作成する方法。次の内の 1 つでなければなりません:
|
||
SERVERSETUP_SECURITY_TLSSETUP_CADISPLAYNAME | X | DominoMicroCA | 認証機関の表示名。 | |
SERVERSETUP_SECURITY_TLSSETUP_CAORGNAME | X | 認証機関の組織名。デフォルト値は、SERVERSETUP_ORG_ORGNAME システム環境変数の値です。 | ||
SERVERSETUP_SECURITY_TLSSETUP_CAKEYTYPE | X | RSA | 認証機関キータイプ。次の内の 1 つでなければなりません:
|
|
SERVERSETUP_SECURITY_TLSSETUP_ CAEXPIRATIONDAYS | X | 認証局証明書が期限切れになるまでの日数。指定しない場合は、Domino によって適切なデフォルト値が選択されます。 | ||
SERVERSETUP_SECURITY_TLSSETUP_ ORGNAME | X | TLS certificate organization name. デフォルト値は CAORGNAME の値です。 | ||
SERVERSETUP_SECURITY_TLSSETUP_TLSKKEYTYPE | X | RSA | 有効な値については、CAKEYTYPE を参照してください。 | |
SERVERSETUP_SECURITY_TLSSETUP_CERTEXPIRATIONDAYS | X | Number of days until TLS certificate expires, an integer value between 1 and 398, inclusive. 指定しない場合は、Domino によって適切なデフォルト値が選択されます。 | ||
SERVERSETUP_SECURITY_TLSSETUP_IMPORTFILEPATH | X | "method:" に必須"import"。インポートする .pem、.p12、.pfx、.kyr ファイルのパス。 | ||
SERVERSETUP_SECURITY_TLSSETUP_IMPORTFILEPASSWORD | X | インポート・ファイルの内容を暗号化解除するためのパスワード。インポート・ファイルがパスワードで保護されている場合は必須です。「パスワードを間接的に指定する」で説明している、間接的なパスワードメカニズムを使用できます。 | ||
SERVERSETUP_SECURITY_TLSSETUP_RETAINIMPORTFILE | X | false | デフォルトでは、インポート・ファイルはインポートが成功した後に削除されます。ファイルを保存する場合は true を指定します。 | |
SERVERSETUP_SECURITY_TLSSETUP_EXPORTPASSWORD | X | データをエクスポート可能にしたい場合に使用する、インポートされたデータを暗号化して保存するためのパスワード。 | ||
SERVERSETUP_DIRECTORYASSISTANCE_DATABASEPATH | X | X | da.nsf | ディレクトリー・アシスタンス・データベースのパス。ディレクトリアシスタント・データベースを作成する。 |
SERVERSETUP_DIRECTORYASSISTANCE_DOMAINNAME | X | X | LDAP ディレクトリーに対するディレクトリアシスタントのドメイン名。デフォルト値は SERVERSETUP_SERVER_DOMAINNAME の値です。 | |
SERVERSETUP_DIRECTORYASSISTANCE_COMPANYNAME | X | X | ディレクトリアシスタントの会社名。デフォルト値は、SERVERSETUP_ORG_ORGNAME の値です。 | |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_HOSTNAME | X* | X* | LDAP サーバーの DNS ホスト名。 | |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_VENDOR | X | X | dominoLDAP | ディレクトリアシスタントの LDAP ベンダー。次の内の 1 つでなければなりません: "activeDirectory"、"openLDAP"、"dominoLDAP" |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_USERDN | X | X | ディレクトリアシスタントの LDAP ユーザーの識別名。 | |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_PASSWORD | X | X | ディレクトリアシスタントの LDAP ユーザーのパスワード。 | |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_BASESEARCHDN | X | X | ディレクトリアシスタントの LDAP 基本検索の識別名。 | |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_CHANNELENCRYPTION | X | X | TLS | ディレクトリー・アシスタンスの LDAP チャネルの暗号化。"TLS" または "none" である必要があります。 |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_PORT | X | X | ディレクトリアシスタントの LDAP ポート。デフォルト値は、SERVERSETUP_DIRECTORYASSISTANCE_LDAP_CHANNELENCRYPTION=TLS の場合は 636、SERVERSETUP_DIRECTORYASSISTANCE_LDAP_CHANNELENCRYPTION=none の場合は 389 です。 | |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_ACCEPTEXPIREDCERTIFICATES | X | X | false | ディレクトリー・アシスタンス LDAP - 期限切れの証明書を受け入れます。 |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_VERIFYREMOTESERVERCERTIFICATES | X | X | true | ディレクトリアシスタント LDAP - リモートサーバー証明書を確認します。 |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_TIMEOUT | X | X | 0 | ディレクトリー・アシスタンス LDAP タイムアウト。負でない整数値です。0 の値は、タイムアウトなしを意味します。 |
SERVERSETUP_DIRECTORYASSISTANCE_LDAP_MAXIMUMENTRIESRETURNED | X | X | 0 | ディレクトリアシスタント LDAP の返される最大エントリー数。負でない整数値です。0 の値は、制限がないことを意味します。 |
SERVERSETUP_AUTOREGISTER_COUNT | X | 0 | 自動的に登録するサーバーの数。(整数)自動登録を使用しない場合は、サーバーを手動で登録します。 | |
SERVERSETUP_AUTOREGISTER_IDPATH | X | None | サーバーを自動的に登録する場合に、生成されたサーバー ID ファイルを格納するディレクトリーを指定します。ディレクトリーはすでに存在している必要があります。Docker では、ID はコンテナーに対して相対的である必要があります。 | |
SERVERSETUP_AUTOREGISTER_PATTERN | X | None | サーバーを自動的に登録する場合に、生成されるサーバー ID ファイルの名前のパターンを指定します。パターンには「#」を1文字含む必要があり、この文字は0、1、...とカウント1までの数字に置き換えられます。 たとえば、count が |
|
SERVERSETUP_EXISTINGSERVER_CN | X* | Domino ディレクトリおよびその他のデータベースを複製する既存のサーバーのサーバー共通名 ( 例 : Adminserver )。 |
||
SERVERSETUP_EXISTINGSERVER_HOSTNAMEORIP | X | None | 既存のサーバーのサーバー DNS ホスト名または IP アドレス。 |
ID ボールトのシステム環境変数
注: ID ボールトの設定はオプションですが、指定した場合は、すべての変数が必要です。
変数 | 最初のサーバー | 追加サーバー | デフォルト | 説明 |
---|---|---|---|---|
IDVAULT_NAME | X | ボールト名。例えば "O=DemoVault" のように、"O=<vaultname>"と指定します。"O=" の接頭部を含める必要があります。この接頭部を省略すると、ボールト作成の試行時に「エントリが索引に見つかりません」というエラーが発生する可能性があります。 | ||
IDVAULT_DESCRIPTION | X | ボールトの説明 | ||
IDVAULT_IDFILE | X | ボールト ID ファイル | ||
IDVAULT_IDPASSWORD | X | ボールト ID ファイル・パスワード | ||
IDVAULT_PATH | ボールト・データベース・パス。これはオプションのパラメーターであり、name パラメーターから派生する場合があるため、指定しないことをお勧めします。指定する場合は、パスのディレクトリー部分は IBM_ID_VAULT にして、パスのファイル名部分は name パラメーターと一致させ、O= 接頭部を付けずに指定する必要があります (例: "IBM_ID_VAULT/DemoVault.nsf")。 | |||
IDVAULT_PASSWORDRESET_HELPTEXT | X | パスワードを忘れたユーザーのためのヘルプテキスト | ||
IDVAULT_SECURITYSETTINGSPOLICY_NAME | X | セキュリティー設定ポリシー名 | ||
IDVAULT_SECURITYSETTINGSPOLICY_DESCRIPTION | X | セキュリティー設定ポリシーの説明 | ||
IDVAULT_MASTERPOLICY_DESCRIPTION | X | マスターポリシーの説明 |
ワンタッチ設定のシステム環境変数
変数 | 最初のサーバー | 追加サーバー | デフォルト | 説明 |
---|---|---|---|---|
AUTOCONFIGPREFERENCES_STARTSERVERAFTERCONFIGURATION | X | X | true | true の場合、セットアップが成功すると、Dominoが起動します。false の場合、セットアップは終了し、Dominoを起動しません。 |
AUTOCONFIGPREFERENCES_CONSOLELOGOUTPUT_SHOW | X | X | "errors" | コンソール・ログに書き込むワンタッチ・セットアップ出力を指定します。指定できる値は、「なし」、「エラー」または「すべて」です。 |
AUTOCONFIGPREFERENCES_CONSOLELOGOUTPUT_PAUSEONERRORSECONDS | X | X | 15 | ワンタッチ・セットアップがエラーで完了したときに終了するまでの時間 (秒単位)。なお、セットアップの初期段階で発生した特定のエラーについては、一時停止しません。出力については、常時 IBM_TECHNICAL_SUPPORT/autoconfigure.log を参照してください。 |