通过系统环境变量准备输入参数

作为使用 JSON 文件的替代方法,您可以使用系统环境变量为一键式 Domino 设置提供输入参数。

如果在 Docker 上运行 Domino,则为 Docker 定义要在 --env-file 参数指定的文本文件中导出的系统环境变量。如果在 Windows 或 UNIX 上运行 Domino,那么在安装 Domino 之后,可以使用批处理文件或 shell 脚本或运行个别命令来导出设置服务器所需的系统环境变量。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 脚本中定义的相应系统环境变量如下所示。在调用一键式 Domino 设置的相同 shell 中调用 shell 脚本。在这种情况下,仅包含空格的值需要引号;对于其他值,使用引号是可选的。脚本运行时,将从值中去掉引号。
    export SERVERSETUP_SERVER_TYPE=additional
    export SERVERSETUP_SERVER_NAME=mailserver1
    export SERVERSETUP_SERVER_DOMAINNAME=Renovations
    export SERVERSETUP_SERVER_TITLE="Renovations Mail Server"
以下各表描述了服务器设置、标识符保险库和一键式设置首选项的受支持系统环境变量。
  • 首个服务器其他服务器列中的 X 指示参数与该类型的服务器设置相关。
  • X 旁边的星号 (*) 表示必需参数。
  • 除非另有说明,否则所有值类型均为字符串。
  • 请注意以下与使用引号将字符串值括起来相关的规则:
    • 通过 Docker --env-file 参数在文件中指定时,不允许使用引号。
    • 通过 Windows 批处理文件指定时,不需要引号。
    • 通过 UNIX bash shell 脚本指定时,包含空格的字符串需要用引号括起来。否则,不需要引号。例如,指定 export SERVERSETUP_SERVER_TITLE="ACME Application Server" 而不是 export SERVERSETUP_SERVER_TITLE=ACME Application Server
  • 布尔值通过 true 或 false 进行指示,不使用引号。
  • 除非数字值用作字符串(例如 notes.ini 值),否则将不使用引号指定数字值。
  • 要应用缺省值,请指定空值(不使用引号)或省略参数。

用于服务器设置的系统环境变量

1. 用于服务器设置的系统环境变量
变量 首个服务器 其他服务器 缺省 描述
SERVERSETUP_SERVER_TYPE X* X* 服务器类型。必须为:
  • first 用于 Domino 域中的首个服务器。
  • additional 用于域中的其他服务器。
SERVERSETUP_SERVER_NAME X* X* 服务器通用名称,例如 Adminserver
SERVERSETUP_SERVER_DOMAINNAME X* X* Domino 域名
SERVERSETUP_SERVER_TITLE X X 服务器标题
SERVERSETUP_SERVER_PASSWORD X 服务器标识密码
SERVERSETUP_SERVER_MINPASSWORDLENGTH X X 5 所有密码的最小密码长度。(整数)
SERVERSETUP_SERVER_USEEXISTINGSERVERID X false 值 true 使用 IDFilePath 指定的现有服务器标识。缺省设置是创建新的服务器标识,缺省值为 Domino 数据目录中的 server.id
SERVERSETUP_SERVER_IDFILEPATH X X* 服务器标识文件的路径。在 Docker 上,标识必须是相对于容器的。
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 指定的现有证明者标识。缺省设置为创建新的证明者标识,缺省为 Domino 数据目录中的 cert.id。在 Docker 上,标识必须是相对于容器的。
SERVERSETUP_ORG_CERTIFIERIDFILEPATH X useExistingCertifierID 为 true 时使用的证明者标识的路径。在 Docker 上,标识必须是相对于容器的。
SERVERSETUP_ORG_USEEXISTINGORGUNITID X false 值 true 使用 orgUnitIDFilePath 指定的现有组织单位证明者标识。指定 orgUnitName 时,缺省设置为创建新的组织单位证明者标识,缺省为 Domino 数据目录中的 oucert.id。在 Docker 上,标识必须是相对于容器的。
SERVERSETUP_ORG_ORGUNITIDFILEPATH X none useExistingOrgUnitID 为 true 时使用的组织单位证明者标识的路径。在 Docker 上,标识必须是相对于容器的。
SERVERSETUP_ADMIN_FIRSTNAME X 管理员名字
SERVERSETUP_ADMIN_MIDDLENAME X 管理员中间名或姓名首字母
SERVERSETUP_ADMIN_LASTNAME X* 管理员姓氏
SERVERSETUP_ADMIN_PASSWORD X* 管理员标识密码
SERVERSETUP_ADMIN_IDFILEPATH X* 管理员标识文件路径。在 Docker 上,标识必须是相对于容器的。
SERVERSETUP_ADMIN_CN X* 管理员通用名称。
SERVERSETUP_SECURITY_ACL_PROHIBITANONYMOUSACCESS X X true 值 true 赋予匿名用户对所有新数据库的 ACL 的“无访问权”。(布尔值)
SERVERSETUP_SECURITY_ACL_ADDLOCALDOMAINADMINS X X true true 赋予 LocalDomainAdmins 组条目对所有新数据库的 ACL 的“管理者”访问权。(布尔值)
SERVERSETUP_SECURITY_TLSSETUP_METHOD X* 用于创建 TLS 工件 certstore.nsf 数据库的方法。必须是以下其中一项:
  • “dominoMicroCA”用于创建 Domino Micro 认证中心,并使用它来创建 TLS 证书。有效参数为 CADisplayName、CAOrgName、CAKeyType、CAExpirationDays、orgName、TLSKeyType 和 certExpirationDays。
  • “import”用于从 .pem、.p12、.pfx 或 .kyr 文件导入证书数据。有效参数为 importFilePath、importFilePassword、retainImportFile 和 exportPassword。
SERVERSETUP_SECURITY_TLSSETUP_CADISPLAYNAME X DominoMicroCA 认证中心显示名称。
SERVERSETUP_SECURITY_TLSSETUP_CAORGNAME X 认证中心组织名称。缺省值为系统环境变量 SERVERSETUP_ORG_ORGNAME 的值。
SERVERSETUP_SECURITY_TLSSETUP_CAKEYTYPE X RSA 认证中心密钥类型。必须是以下其中一项:
  • “RSA”- 具有缺省密钥大小的 RSA
  • “ECDSA”- 具有缺省密钥大小的 ECDSA
  • “RSA2048” - 具有 2048 位密钥的 RSA
  • “RSA4096”- 具有 4096 位密钥的 RSA
  • “ES256”- 具有 256 位密钥的 ECDSA “ES384”- 具有 384 位密钥的 ECDSA。
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 之间的整数值(包括 1 和 398)。如果未指定,那么 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 供应商。必须是以下其中一项:“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_MAXIMUMENTRIESREANCE X X 0 目录辅助 LDAP 返回的最大条目数,非负整数值。值为 0 表示没有限制。
SERVERSETUP_AUTOREGISTER_COUNT X 0 要自动注册的服务器数。(整数)如果不使用自动注册,要手动注册服务器。
SERVERSETUP_AUTOREGISTER_IDPATH X 指定在自动注册服务器时将放入生成的服务器标识文件的目录。该目录必须已经存在。在 Docker 上,这些标识必须与容器是相对的。
SERVERSETUP_AUTOREGISTER_PATTERN X 如果自动注册服务器,请为生成的服务器标识文件的名称指定一个模式。模式必须包含单个“#”字符,该字符将替换为数字 0、1、...直至 count-1。

例如,如果 count 为 3 且模式为 mailserver#,则生成的标识文件将命名为mailserver0.id 、mailserver1.id 、mailserver2.id 。

SERVERSETUP_EXISTINGSERVER_CN X* 现有服务器的服务器通用名称,用于复制 Domino 目录和其他数据库,例如 Adminserver
SERVERSETUP_EXISTINGSERVER_HOSTNAMEORIP X 现有服务器的服务器 DNS 主机名或 IP 地址。

用于标识符保险库的系统环境变量

注: 标识符保险库设置是可选的,但如果指定,则需要所有变量。
2. 用于标识符保险库的系统环境变量
变量 首个服务器 其他服务器 缺省 描述
IDVAULT_NAME X 保险库名称。指定为“O=<vaultname>”,例如“O=DemoVault”。必须包括“O=”前缀。如果省略它,那么在尝试创建保险库时,可能会收到“在索引中找不到条目”错误。
IDVAULT_DESCRIPTION X 保险库描述
IDVAULT_IDFILE X 保险库标识文件
IDVAULT_IDPASSWORD X 保险库标识文件密码
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 主策略描述

用于一键式设置首选项的系统环境变量

3. 用于一键式设置首选项的系统环境变量
变量 首个服务器 其他服务器 缺省 描述
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 获得输出。