透過系統環境變數準備輸入參數
作為使用 JSON 檔案的替代方法,您可以使用系統環境變數,提供輸入參數進行一鍵式 Domino 設定。
如果您執行 Domino on Docker,請在
--env-file 參數指定的文字檔中定義要供 Docker 匯出的系統環境變數。如果您在 Windows 或 UNIX 上執行 Domino,請在安裝 Domino 之後,使用批次檔或 shell Script,或執行個別指令來匯出設定伺服器所需的系統環境變數。export 指令的語法各不相同,但在 Linux 上使用 bash shell 的範例是: 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 shell Script 中定義的對應系統環境變數將如下。您在呼叫一鍵式「Domino 設定」的同一 shell 內呼叫 shell Script 。在此情況下,只有包含空格的值需要引號;對其他值使用引號是選用的。當 Script 執行時,會從這些值中去除引號。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 shell Script 進行指定時,需要引號括住包含空格的字串。否則,不需要引號。例如,指定
export SERVERSETUP_SERVER_TITLE="ACME Application Server",而不指定export SERVERSETUP_SERVER_TITLE=ACME Application Server。
- 在檔案中透過 Docker
- 布林值是以沒有引號的 true 或 false 表示。
- 指定數值時沒有引號,除非它們充當字串(例如 notes.ini 值)。
- 若要套用預設值,請指定沒有引號的空值或省略參數。
用於伺服器設定的系統環境變數
| 變數 | 第一部伺服器 | 其他伺服器 | 預設值 | 說明 |
|---|---|---|---|---|
| SERVERSETUP_SERVER_TYPE | X* | X* | 伺服器類型。必須是:
|
|
| SERVERSETUP_SERVER_NAME | X* | X* | 伺服器通用名稱,例如,Adminserver |
|
| SERVERSETUP_SERVER_DOMAINNAME | X* | X* | Domino 網域名稱 | |
| SERVERSETUP_SERVER_TITLE | X | X | 無 | 伺服器標題 |
| SERVERSETUP_SERVER_PASSWORD | X | 無 | 伺服器 ID 密碼 | |
| SERVERSETUP_SERVER_MINPASSWORDLENGTH | X | X | 5 | 所有密碼的密碼長度下限。(整數) |
| SERVERSETUP_SERVER_USEEXISTINGSERVERID | X | false | true 值使用 IDFilePath 指定的現有伺服器 ID。預設值是建立新的伺服器 ID,其會預設為 Domino 資料目錄中的 server.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 | 無 | 組織國家/地區代碼 |
| SERVERSETUP_ORG_ORGNAME | X* | X* | 組織名稱 | |
| SERVERSETUP_ORG_CERTIFIERPASSWORD | X* | 組織發證者密碼 | ||
| SERVERSETUP_ORG_ORGUNITNAME | X | X | 無 | 組織單位名稱 |
| SERVERSETUP_ORG_ORGUNITPASSWORD | X | X | 無 | 組織單位密碼 |
| SERVERSETUP_ORG_USEEXISTINGCERTIFIERID | X | false | true 值使用 certifierIDFilePath 指定的現有發證者 ID。預設值是建立新的發證者 ID,其會預設為 Domino 資料目錄中的 cert.id。在 Docker 上,ID 必須相對於儲存器。 | |
| SERVERSETUP_ORG_CERTIFIERIDFILEPATH | X | 無 | useExistingCertifierID 為 true 時所使用之發證者 ID 的路徑。在 Docker 上,ID 必須相對於儲存器。 | |
| SERVERSETUP_ORG_USEEXISTINGORGUNITID | X | false | true 值使用 orgUnitIDFilePath 指定的現有組織單位發證者 ID。指定 orgUnitName 時的預設值是建立新的組織單位發證者 ID,其會預設為 Domino 資料目錄中的 oucert.id。在 Docker 上,ID 必須相對於儲存器。 | |
| SERVERSETUP_ORG_ORGUNITIDFILEPATH | X | 無 | useExistingOrgUnitID 為 true 時所使用之發組織單位證者 ID 的路徑。在 Docker 上,ID 必須相對於儲存器。 | |
| SERVERSETUP_ADMIN_FIRSTNAME | X | 無 | 管理員名字 | |
| SERVERSETUP_ADMIN_MIDDLENAME | X | 無 | 管理員中間名或名稱的第一個字母 | |
| 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 資料庫的方法。必須是下列其中一個:
|
||
| SERVERSETUP_SECURITY_TLSSETUP_CADISPLAYNAME | X | DominoMicroCA | 憑證管理中心顯示名稱。 | |
| SERVERSETUP_SECURITY_TLSSETUP_CAORGNAME | X | 憑證管理中心組織名稱。預設為 SERVERSETUP_ORG_ORGNAME 系統環境變數的值。 | ||
| SERVERSETUP_SECURITY_TLSSETUP_CAKEYTYPE | X | RSA | 憑證管理中心金鑰類型。必須是下列其中一個:
|
|
| SERVERSETUP_SECURITY_TLSSETUP_ CAEXPIRATIONDAYS | X | 憑證管理中心憑證到期之前的天數。如果未指定,則 Domino 會選擇適當的預設值。 | ||
| SERVERSETUP_SECURITY_TLSSETUP_ ORGNAME | X | TLS 憑證組織名稱。預設值為 CAORGNAME 的值。 | ||
| SERVERSETUP_SECURITY_TLSSETUP_TLSKKEYTYPE | X | RSA | 如需有效值,請參閱 CAKEYTYPE。 | |
| SERVERSETUP_SECURITY_TLSSETUP_CERTEXPIRATIONDAYS | X | TLS 憑證到期之前的天數,為 1 到 398 之間(含)的整數值。如果未指定,Domino 會選擇適當的預設值。 | ||
| SERVERSETUP_SECURITY_TLSSETUP_IMPORTFILEPATH | X | 「方法」的必要項目:「匯入」。要匯入的 .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 供應商。必須是下列其中一個:「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」或「無」。 |
| 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 | 無 | 如果您自動註冊伺服器,請指定要放置所產生之伺服器 ID 檔案的目錄。此目錄必須已存在。在 Docker 上,ID 必須相對於儲存器。 | |
| SERVERSETUP_AUTOREGISTER_PATTERN | X | 無 | 如果您自動註冊伺服器,請指定所產生伺服器 ID 檔案之名稱的型樣。型樣必須包含單一「#」字元,此字元將取代為數字 0、1、... 最多為 count-1。 例如,如果計數為 |
|
| SERVERSETUP_EXISTINGSERVER_CN | X* | 例如,要從中抄寫 Domino 名錄及其他資料庫之現有伺服器的伺服器通用名稱,例如 Adminserver。 |
||
| SERVERSETUP_EXISTINGSERVER_HOSTNAMEORIP | X | 無 | 現有伺服器的伺服器 DNS 主機名稱或 IP 位址。 |
ID 儲存庫的系統環境變數
註: ID 儲存庫設定是選用的,但如果指定,則需要所有變數。
| 變數 | 第一部伺服器 | 其他伺服器 | 預設值 | 說明 |
|---|---|---|---|---|
| IDVAULT_NAME | X | 儲存庫名稱。指定為「O=<vaultname>」,例如,「O=DemoVault」。您必須包含「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" | 指定要寫入到主控台日誌的一鍵式設定輸出。可能值是 "none"、"errors" 或 "all"。 |
| AUTOCONFIGPREFERENCES_CONSOLELOGOUTPUT_PAUSEONERRORSECONDS | X | X | 15 | 當一鍵式設定完成,但發生錯誤時,在結束之前暫停的時間(以秒為單位)。請注意,對於設定程序中早期發生的某些錯誤,不會暫停。您可以一律參閱 IBM_TECHNICAL_SUPPORT/autoconfigure.log,以取得輸出。 |