在 JSON 文件中准备输入参数
您可以创建 JSON 文件 (.json) 以提供用于一键式 Domino 设置的输入参数。
JSON 输入数据组织为顶级 JSON 对象,每个对象对应于特定的组件。每个顶级对象都可以包含嵌套对象。例如,serverSetup
对象包含包含了所有服务器相关参数的 server
对象,包含了所有网络相关参数的 network
对象,诸如此类。
准备好 JSON 文件后,请使用从 Domino 12.0.1 开始提供的 validjson 工具来验证配置。有关更多信息,请参阅 验证 JSON 配置。
autoConfigPreferences
,用于指定首选项。serverSetup
,用于设置服务器和注册用户。IDVault
,用于设置标识符保险库。appConfiguration
,用于配制应用程序。
JSON 文件必须包含有效的 JSON,如 json.org 中所述。
- 除非另有说明,否则所有值类型均为字符串。在引号中指定字符串。
- 布尔值通过 true 或 false 进行指示,不使用引号。
- 除非数字值用作字符串(例如 notes.ini 值),否则将不使用引号指定数字值。
- 要应用缺省值,请指定空值(不使用引号)或省略参数。
用于一键式设置首选项的 JSON 参数
参数 | 第一页 | 其他 | 描述 |
---|---|---|---|
autoConfigPreferences/deleteInputFileAfterProcessing | X | X | 如果为 true,在处理完成时,输入 JSON 文件会被删除。这可确保密码等保密数据不会留在文件系统上。使用此选项时,请确保在安全位置具有 JSON 文件的备份副本,以防再次需要该副本。 缺省值: false |
autoConfigPreferences/startServerAfterConfiguration | X | X | 如果为 true,那么 Domino 会在成功设置后启动。如果为 false,那么将退出设置,并且不会启动 Domino。 注: 如果要使用一键式设置来配置标识符保险库,请保留此设置 true。Domino 服务器必须立即启动,以使标识符保险库配置生效。 缺省值: true |
autoConfigPreferences/consoleLogOutput/show | X | X | 指定要写入控制台日志的一键式设置输出。可能的值为 "none"、"errors" 或 "all"。 缺省值: "errors" |
autoConfigPreferences/consoleLogOutput/pauseOnErrorSeconds | X | X | 当一键式设置完成并返回错误时,退出前要暂停的时间(以秒表示)。请注意,对于设置过程早期发生的某些错误,不会暂停。您始终可以查阅 IBM_TECHNICAL_SUPPORT/autoconfigure.log 获得输出。 缺省值:15 |
用于服务器设置的 JSON 参数
参数 | 第一页 | 其他 | 描述 |
---|---|---|---|
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 | X | 服务器标识密码 缺省值:无 |
serverSetup/server/minPasswordLength | X | X | 所有密码的最小密码长度(整数) 缺省值:5 |
serverSetup/server/useExistingServerID | X |
|
值 true 使用 IDFilePath 指定的现有服务器标识。缺省设置为创建新的服务器标识,缺省为 Domino 数据目录中的 server.id。 缺省值: false |
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 |
|
值 true 使用 certifierIDFilePath 指定的现有证明者标识。缺省设置为创建新的证明者标识,缺省为 Domino 数据目录中的 cert.id。 缺省值: false |
serverSetup/org/certifierIDFilePath | X |
|
当 useExistingCertifierID 为 true 时使用的证明者标识的路径。在 Docker 上,标识必须是相对于容器的。 缺省值:无 |
serverSetup/org/useExistingOrgUnitID | X |
|
值 true 使用 orgUnitIDFilePath 指定的现有组织单位证明者标识。指定 orgUnitName 时,缺省设置为创建新的组织单位证明者标识,缺省为 Domino 数据目录中的 oucert.id。 缺省值: false |
serverSetup/org/orgUnitIDFilePath | X |
|
当 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/useExistingAdminID | X |
|
值 true 使用 IDFilePath 指定的现有服务器标识。缺省设置为创建新的管理员标识并将其另存为 IDFilePath。 缺省值: false |
serverSetup/admin/CN | X* |
|
管理员通用名称,例如“Bill Ranney”。 |
serverSetup/notesINI/<any name> | X | X | 使用 JSON 输入时,可定义任何 notes.ini 设置。定义可能由服务器设置独立定义的 notes.ini 设置时,请谨慎使用;此处定义的值将覆盖先前由设置定义的任何值。 缺省值:无 |
serverSetup/security/ACL/prohibitAnonymousAccess | X | X | 值 true 赋予匿名用户“无访问权”。(布尔值) 缺省值: true |
serverSetup/security/ACL/addLocalDomainAdmins | X | X | 值 true 为 LocalDomainAdmins 组条目提供“管理者”访问权。(布尔值) 缺省值: true |
serverSetup/security/TLSSetup/method | X* |
|
certstore.nsf 中创建 TLS 工件的方法。必须是以下其中一项:
|
serverSetup/security/TLSSetup/CADisplayName | X |
|
认证中心显示名称 缺省值: DominoMicroCA |
serverSetup/security/TLSSetup/CAOrgName | X |
|
认证中心组织名称。缺省值为源 JSON 文件中 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/TLSKeyType | X |
|
TLSKeyType。有关有效值,请参阅 CAKeyType。 缺省值: RSA |
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 |
|
缺省情况下,导入文件将在成功导入后删除。指定 true 以保留该文件。 |
serverSetup/security/TLSSetup/exportPassword | X |
|
用于存储已加密的导入数据的密码(如果希望数据可导出)。可以使用间接指定密码中所述的任何间接密码机制。 |
serverSetup/directoryAssistance/databasePath | X | X | 目录辅助数据库路径。如果需要,创建 Domino 目录辅助数据库以用于配置对外部 LDAP 目录的访问。 缺省值: da.nsf |
serverSetup/directoryAssistance/domainName | X | X | 目录辅助域名。缺省值为源 JSON 文件中 serverSetup/server/domainName 属性的值。 |
serverSetup/directoryAssistance/companyName | X | X | 目录辅助公司名称。缺省值为源 JSON 文件中 serverSetup/org/orgName property 的值。 |
serverSetup/directoryAssistance/LDAP/hostName | X* | X* | LDAP 服务器的 DNS 主机名。 |
serverSetup/directoryAssistance/LDAP/vendor | X | X | 目录辅助 LDAP 供应商。必须是以下其中一项:"activeDirectory"、"openLDAP"、"dominoLDAP"。 缺省值: "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 | 目录辅助 LDAP 渠道加密。必须为 "TLS" 或 "none"。 缺省值: "TLS" |
serverSetup/directoryAssistance/LDAP/port | X | X | 目录辅助 LDAP 端口。 缺省值:"channelEncryption": "TLS" 为 636,"channelEncryption": "none". 为 389 |
serverSetup/directoryAssistance/LDAP/acceptExpiredCertificates | X | X | 目录辅助 LDAP - 接受到期的证书。 缺省值: false |
serverSetup/directoryAssistance/LDAP/verifyRemoteServerCertificates | X | X | 目录辅助 LDAP - 验证远程服务器证书。 缺省值: true |
serverSetup/directoryAssistance/LDAP/timeout | X | X | 目录辅助 LDAP 超时,非负整数值。值为 0 表示未超时。 缺省值:0 |
serverSetup/directoryAssistance/LDAP/maximumEntriesReturned | X | X | 目录辅助 LDAP 返回的最大条目数,非负整数值。值为 0 表示没有限制。 缺省值:0 |
serverSetup/autoregister/count | X |
|
要自动注册的其他服务器数。 缺省值:0 |
serverSetup/autoregister/IDPath | X |
|
指定将放入生成的服务器标识文件的目录。该目录必须已经存在。在 Docker 上,标识必须是相对于容器的。 缺省值:无 |
serverSetup/autoregister/pattern | X |
|
为生成的服务器标识文件的名称指定一个模式。模式必须包含单个“#”字符,该字符将替换为数字 0、1、...直至 count-1。例如,如果计数为 3 且模式为“mailserver#”,则生成的标识文件将命名为 mailserver0.id、mailserver1.id、mailserver2.id。 缺省值:无 |
serverSetup/registerUsers/defaults | X |
|
包含要注册的所有用户的缺省参数的对象。每个用户都有可覆盖缺省值的属性。 |
serverSetup/registerUsers/defaults/saveIDToPersonDocument | X |
|
如果为 true,那么用户标识文件将另存为 Domino 目录中用户“个人”文档中的附件。 缺省值: false |
serverSetup/registerUsers/defaults/mailTemplatePath | X |
|
要用于创建用户邮件文件的模板数据库的路径。 |
serverSetup/registerUsers/defaults/password | X |
|
要用于未提供显式密码的所有用户的密码。使用“@Prompt:”提示每个用户输入密码,或指定要应用于所有用户的密码(仅建议用于测试服务器)。不支持非“@Prompt:”的间接密码选项。 |
serverSetup/registerUsers/defaults/enableFullTextIndex | X |
|
如果为 true,那么将创建启用了全文索引数据库属性的用户邮件数据库。一键式设置不会创建索引。 缺省值: false |
serverSetup/registerUsers/defaults/certificateExpirationMonths | X |
|
用户证书到期前的月数。 缺省值:24 |
serverSetup/registerUsers/users | X |
|
要注册的用户数组。整个数组以 '[' 字符开头,以 JSON 输入中的 ']' 字符结尾。数组中每个条目都是以 '{' 字符开头和以 '}' 字符结尾的对象。一个对象(如下所示)中的属性提供了用户的注册数据。某些属性具有上述 /defaults 对象中描述的缺省值。 |
serverSetup/registerUsers/users/firstName | X |
|
用户名字 |
serverSetup/registerUsers/users/middleName | X |
|
用户的中间名 |
serverSetup/registerUsers/users/lastName | X* |
|
用户的姓氏 |
serverSetup/registerUsers/users/shortName | X |
|
用户的短名 |
serverSetup/registerUsers/users/password | X |
|
用户标识文件密码。可以指定显式密码或使用间接指定密码中记录的任何间接密码选项。必须使用此属性或 /defaults 中的 password 属性为每个用户指定密码。 |
serverSetup/registerUsers/users/mailFilePath | X |
|
用户邮件文件路径。如果未指定,那么不会为用户创建邮件文件。 |
serverSetup/registerUsers/users/mailTemplatePath | X |
|
邮件模板路径。如果在此处未指定或未与 /defaults 一起指定,那么缺省情况下会使用当前 Domino 版本的邮件模板。 |
serverSetup/registerUsers/users/IDFilePath | X |
|
用户标识文件路径。如果您还使用一键式设置创建了标识符保险库,若不希望在磁盘上存储标识文件,则您可以忽略此属性。在这种情况下,一键式设置会创建一个临时标识文件,其名称派生自用户的 mailFilePath(如果存在)或唯一的临时文件名。然后,在将标识文件上载到保险库之后,一键式设置将删除临时标识文件。如果指定了用户标识文件路径,那么将不会删除该文件。 |
serverSetup/registerUsers/users/saveIDToPersonDocument | X |
|
如果为 true,那么用户标识文件将另存为 Domino 目录中用户“个人”文档中的附件。 |
serverSetup/registerUsers/users/enableFullTextIndex | X |
|
如果为 true,那么将创建启用了全文索引数据库属性的用户邮件数据库。一键式设置不会创建索引。 |
serverSetup/registerUsers/users/internetAddress | X |
|
用户因特网地址。如果未指定,那么一键式设置将使用 <firstName><lastName>@<domain-name>,其中 <domain-name> 取自必需属性 serverSetup/server/domainName。 |
serverSetup/registerUsers/users/certificateExpirationMonths | X |
|
用户证书到期前的月数。 |
serverSetup/existingServer/CN | X* | 现有服务器的服务器通用名称(例如“Adminserver”),用于复制目录和其他数据库 。 | |
serverSetup/existingServer/hostNameOrIP | X | 现有服务器的服务器 DNS 主机名或 IP 地址。 缺省值:无 |
用于标识符保险库设置的 JSON 参数
参数 | 第一页 | 其他 | 描述 |
---|---|---|---|
IDVault/name | X* |
|
保险库名称。指定为“O=<vaultname>”,例如“O=DemoVault”。必须包括“O=”前缀。如果省略它,那么在尝试创建保险库时,可能会收到“在索引中找不到条目”错误。 |
IDVault/description | X* |
|
保险库描述。 |
IDVault/IDFile | X* |
|
保险库标识文件 |
IDVault/IDPassword | X* |
|
保险库标识文件密码 |
IDVault/path | X |
|
保险库数据库路径。这是可选参数,建议您不要指定它,因为它可以从 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* |
|
主策略描述 |
应用程序配置的 JSON 参数
参数 | 第一页 | 其他 | 描述 |
---|---|---|---|
appConfiguration/notesINI/<any-name> | X | X | 作为在 serverSetup 属性中指定这些变量的替代方法,可在此处定义任何 notes.ini 变量。 |
appConfiguration/databases/action | X* | X* | Specify "create" to create a new database, or "update" to update an existing database. |
appConfiguration/databases/filePath | X* | X* | 数据库文件路径。 |
appConfiguration/databases/title | X | X | 数据库标题。 |
appConfiguration/databases/templatePath | X | X | Database template file path. Required when action is "create". |
appConfiguration/databases/signUsingAdminp | X | X | When set to true, an
adminp request is issued to sign all design documents using the
server's
ID. Default: false |
appConfiguration/databases/ACL/roles | X | X | 角色名称的数组。示例:[“SpecApprover”,“SpecAuthor”] |
appConfiguration/databases/ACL/ACLEntries |
|
|
ACL 条目的数组。整个数组以 '[' 字符开头,以 JSON 输入中的 ']' 字符结尾。数组中每个条目都是以 '{' 字符开头和以 '}' 字符结尾的对象。一个对象(如下所示)中的属性提供了 ACL 条目的数据。 |
appConfiguration/databases/ACL/ACLEntries/name | X* | X* | 分层格式的 ACL 条目名称(例如,“adminserver/sherlock”)。该名称可以使用规范格式指定(例如,“CN=adminserver/O=sherlock”),但无需指定,因为一键式设置会自动规范该名称。 |
appConfiguration/databases/ACL/ACLEntries/level | X* | X* | 访问级别。必须是以下其中一项:"noAccess"、"depositor"、"reader"、"author"、"editor"、"designer"、"manager"。 |
appConfiguration/databases/ACL/ACLEntries/type | X | X | 访问类型。必须是以下其中一项:"unspecified"、"person"、"server"、"personGroup"、"serverGroup"、"mixedGroup" 缺省值: "unspecified"。 |
appConfiguration/databases/ACL/ACLEntries/canCreateDocuments | X | X | 指定的实体可以创建文档。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/canDeleteDocuments | X | X | 指定的实体可以创建文档。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/canCreatePersonalAgent | X | X | 指定的实体可以创建专用代理程序。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/canCreatePersonalFolder | X | X | 指定的实体可以创建个人文件夹和视图。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/canCreateSharedFolder | X | X | 指定的实体可以创建共享文件夹和视图。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/canCreateLSOrJavaAgent | X | X | 指定的实体可以创建 LotusScript 和 Java 代理程序。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/isPublicReader | X | X | 指定的实体可以读取公共文档。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/isPublicWriter | X | X | 指定的实体可以写入公共文档。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/canReplicateOrCopyDocuments | X | X | 指定的实体可以复制和拷贝文档。 缺省值:false。 |
appConfiguration/databases/ACL/ACLEntries/roles | X | X | 授予指定实体的角色的数组。示例:[“SpecApprover”,“SpecAuthor”] 缺省值:false。 |
appConfiguration/documents | X | X | 数据库中的文档的数组。整个数组以 '[' 字符开头,以 JSON 输入中的 ']' 字符结尾。数组中每个条目都是以 '{' 字符开头和以 '}' 字符结尾的对象。一个对象(如下所示)中的属性提供了要创建或更新的文档数据。 |
appConfiguration/documents/action | X* | X* | 指定 "create" 以创建新文档,或指定 "update" 以更新现有文档。 |
appConfiguration/documents/findDocument | X | X | 当操作为 "update" 时,为必需属性,此对象中的属性定义用于查找要更新的文档的一个或多个项。该文档必须具备所有具有指定确切值的项。例如:
|
appConfiguration/documents/computeWithForm | X | X | 根据文档表单计算/验证文档。如果为 true,那么将执行表单逻辑(如输入验证公式和缺省值公式),可能会修改文档(例如,添加其他项)。 缺省值:false。 |
appConfiguration/documents/items | X | X | 文档项。这些格式可以是简单格式或规范格式。您可以以简单格式指定某些项,以规范格式指定一些项。要设置任何项标志,需要规范格式。首先显示简单格式,然后是规范格式。支持的数据类型为文本、数字、文本列表以及数字列表。 |
appConfiguration/documents/items/"<item-name>": "<item-value>" | X | X | 文本项的简单格式。 |
appConfiguration/documents/items/"<item-name>": <item-value> | X | X | 数字项的简单格式。请注意,值没有用引号引起来。 |
appConfiguration/documents/items/"<item-name>": [ "v1", "v2" ] | X | X | 文本列表项的简单格式。数组可以包含一个或多个项(此处显示两项)。 |
appConfiguration/documents/items/"<item-name>": [ 1, 2 ] | X | X | 数字列表项的简单格式。请注意,值没有用引号引起来。数组可以包含一个或多个项(此处显示两项)。 |
appConfiguration/documents/items/"<item-name>" | X | X | 项的规范格式 |
appConfiguration/documents/items/"<item-name>"/"type" | X | X | 项数据类型。文本项和数字项可选;可根据 JSON 数据类型与上面的简单格式一样进行推导。如果指定,那么必须为以下项之一:"text"、"number"、"datetime"。 |
appConfiguration/documents/items/"<item-name>"/"value" | X | X |
|
appConfiguration/documents/items/"<item-name>"/"names" | X | X | 项包含名称。 缺省值:false。 |
appConfiguration/documents/items/"<item-name>"/"readers" | X | X | 用于确定哪些人员可以阅读文档的读者项。 缺省值:false。 |
appConfiguration/documents/items/"<item-name>"/"authors" | X | X | 用于确定哪些人员可以编辑文档的作者项。 缺省值:false。 |
appConfiguration/documents/items/"<item-name>"/"protected" | X | X | 项受保护。 缺省值:false。 |
appConfiguration/documents/items/"<item-name>"/"sign" | X | X | 如果文档已签名,则项是文档签名计算的一部分。 缺省值:false。 |
appConfiguration/documents/items/"<item-name>"/"encrypt" | X | X | 如果文档已加密,则项已加密。 缺省值:false。 |
appConfiguration/documents/items/"<item-name>"/"nonSummary" | X | X | 项不是摘要项。缺省情况下,项是摘要项。 缺省值:false。 |
appConfiguration/agents/ | X | X | 数据库中的代理程序的数组。整个数组以 '[' 字符开头,以 JSON 输入中的 ']' 字符结尾。数组中每个条目都是以 '{' 字符开头和以 '}' 字符结尾的对象。一个对象(如下所示)中的属性提供有关要处理的代理程序的信息。 |
appConfiguration/agents/name | X* | X* | 代理程序名称。 |
appConfiguration/agents/action | X* | X* | 对代理程序执行的操作。值可能是单个字符串或字符串的数组。有效值为:
|