appSettings.json 文件参考

appSettings.json 文件是 ArcGIS Documentation Center 使用的配置文件，用于存储应用程序设置。 IT 管理员可以创建并部署自定义 appSettings.json 文件，为多个用户配置应用程序。 本主题将介绍文件中的所有设置。

appSettings.json 结构

appSettings.json 文件是一个具有以下结构的 JSON 文件：

{
  "init": <boolean>,
  "allowedHosts": <string>,
  "endpoints": {
    "documentationSets": {
      "url": <string>
    },
    "webHelp": {
      "url": <string>
    },
    "softwareUpdate": {
      "url": <string>
    }
  },
  "webServer": {
    "defaultFileNames": [<string>, ...],
    "portPreferences": [
      {
        "order": <number>,
        "port": <number>
      },
      ...
    ],
    "portScan": {
      "minValue": <number>,
      "maxValue": <number>,
      "limit": <number>
    },
    "rootFolder": <string>
  },
  "language": <string>,
  "theme": <string>

appSettings.json parameters

init

• 类型：布尔

指示应用程序是否已使用设置初始化。 首次完成配置向导后，此值设置为 true。 IT 管理员可以将其设置为 true，以在应用程序首次启动时跳过配置向导。 通过将 init 设置为 false，用户启动应用程序时配置向导会打开，因此，如果您正在部署自定义 appSettings.json 文件，应将 init 设置为 true，以防止配置向导打开并可能覆盖您的自定义设置。

allowedHosts

• 类型：字符串

指定应用程序可以访问哪些主机。 使用此设置可控制网络访问。 该值可以设置为以下内容：

• *（星号）允许访问所有主机。

• 逗号分隔的特定主机列表，例如 doc.esri.com,example.com。 通常不需要指定多个主机。

• 单个主机，用于限制允许访问一个主机，例如 doc.esri.com。

• 空字符串 ("") 用于阻止所有网络访问。 这会禁用需要网络访问的功能，例如下载文档集。 您可能希望使用此设置来防止应用程序访问互联网。 如果您使用的是共享根文件夹，您可能还需要阻止用户下载文档集。

endpoints

• 类型：对象

包含应用程序所使用的各种服务的 URL 端点。每个端点都有一个 url 属性，用于指定该服务的 URL。 通常不需要修改这些 URL。

您可以为端点 URL 指定空字符串以禁用对这些服务的访问，但如果您想完全阻止应用程序访问互联网，最好将 allowedHosts 设置为如上所述的空字符串。

endpoints.documentationSets.url

• 类型：字符串

应用程序用于库选项卡的 URL，用户可以在其中浏览和下载文档集。 默认 URL 是 https://doc.esri.com/offline-help/packages/all，这是 Esri 的文档集在线库。

通常不需要修改此 URL。

直接在 Web 浏览器中访问默认 URL 将不会显示文档集。 只有应用程序才能访问该 URL。

endpoints.webHelp.url

• 类型：字符串

用户通过菜单 > 帮助按钮打开 ArcGIS Documentation Center 帮助时，所使用的在线版本文档 URL。

通常不需要修改此 URL。

endpoints.softwareUpdate.url

• 类型：字符串

此属性目前未被应用程序使用。

webServer

• 类型：对象

包含随应用程序附带的本地 Web 服务器设置。 子属性包括 defaultFileNames、portPreferences、portScan 和 rootFolder，下面将更详细地介绍这些属性。

webServer.defaultFileNames

• 类型：字符串数组

指定在未定义特定路径时将打开的文件名称和文件类型。 通常不需要修改此对象。

默认值为 ["index.html", "default.html"]。

webServer.portPreferences

• 类型：具有 order 和 port 属性的对象数组

order 属性定义了本地服务器使用指定 port 的优先顺序。 应用程序会尝试先使用端口 order 0，然后尝试 order 1，最后尝试 2。

port 属性指定本地服务器要使用的端口号。 默认端口号为 13774、13322 和 14357。

如果首选端口都不可用，应用程序将使用 webServer.portScan 设置自动查找可用的端口。

如果所有端口号都相同，应用程序只会尝试该端口号，如果该端口不可用，则回退到自动查找可用端口。

webServer.portScan

• 类型：具有 minValue、maxValue 和 limit 属性的对象

minValue 和 maxValue 属性定义了如果 webServer.portPreferences 中定义的首选端口不可用时，扫描可用端口号的包含范围。 limit 属性定义在该范围内放弃之前要尝试的随机端口数量。

默认范围为 20000 到 30000，默认尝试次数为 10。

若要限制为单个回退端口，请将 minValue 和 maxValue 设置为相同的端口号，并将 limit 设置为 1。

webServer.rootFolder

• 类型：字符串

指定下载存储和访问文档集的根文件夹。 这可以为本地路径或网络路径。 默认值是 C:\\Users\\<username>\\Documents\\ArcGIS\\DocCenter\\rootFolder，其中 <username> 是 Windows 用户名。

要为共享根文件夹指定网络路径，请使用 UNC 格式：\\\\<server_name>\\<folder_path>。 例如，名为 Polaris 的服务器有一个共享根文件夹 doc_share\arcgis_docsets，文档集将存储在其中：\\\\Polaris\\doc_share\\arcgis_docsets。

language

• 类型：字符串

指定应用程序界面的显示语言。 有效值如下方列出的语言代码所示。

• de：德语

• en：英语

• es：西班牙语

• fr：法语

• ja：日语

• ru：俄语

• zh-CN：简体中文

请注意，显示语言可能与已下载的文档集语言不同。 例如，用户可以选择应用程序界面的显示语言为英语，同时下载日语版文档集。

应用程序会根据显示语言对文档集列表应用默认过滤器。 例如，如果显示语言是英语，默认情况下应用程序中仅会显示包含英文内容的文档集。 用户可以清除过滤器，以查看和下载其他语言的文档集。

theme

• 类型：字符串

指定应用程序界面的主题。 有效值包括：

• Theme.Auto：应用程序将使用与操作系统主题相同的主题。 如果用户将 Windows 主题设置为浅色，应用程序将使用浅色主题。 如果用户将 Windows 主题设置为深色，应用程序将使用深色主题。

• Theme.Light：应用程序将使用浅色主题。

• Theme.Dark：应用程序将使用深色主题。

相关主题

• 配置应用程序（IT 管理员）

• 使用配置向导配置应用程序

• 应用程序状态文件