iPortal 配置文件说明

SuperMap iPortal 的主要配置信息位于 WEB-INF（【SuperMap iPortal 安装目录】\webapps\iportal\WEB-INF）目录下，关于目录说明请参考：安装之后目录说明。

iPortal 配置文件简介

SuperMap iPortal 的配置文件包含 iPortal 门户功能的配置文件和与 iServer 共用的基础配置文件（关于 iServer 的配置文件说明请参见：iServer 配置文件说明）。

iPortal 门户功能的配置文件主要内容如下表所示：

配置文件的内容

文件名	描述
iportal.xml	iPortal 门户的主要配置信息，包括数据库配置以及一些门户功能的配置等。
iportal-monitor.xml	节点监控配置信息，包括节点监控数据存储的数据库配置、添加的 iServer 节点信息等。关于此配置文件的使用，请参见：监控配置。
iportal-storage.xml	用户上传数据文件的存储配置信息，包括 FTP 服务器存储配置等。关于此配置文件的使用，请参见：托管数据存储配置。
iportal-ehcache.xml	iPortal 代理服务访问权限信息缓存共享配置信息，默认保存在本地，无需配置，当使用 iPortal 高可用方案时，需配置。关于此配置文件的使用，请参见：代理服务访问权限信息缓存共享配置。

iPortal 配置文件结构

SuperMap iPortal 配置文件 iportal.xml，包含了 iPortal 门户的主要配置信息，根节点为 <IportalConfig>。<IportalConfig> 节点目前主要包含：

数据库配置： <dataSourceConnectionPoolInfo>
数据上传配置：<uploadSetting>
服务相关配置：<serviceSetting>、<serviceCheckSetting>、<serviceAuditSetting>、<serviceProxy>、<cookieStorage>
用户注册配置：<registerSetting>
共享范围配置：<shareSetting>
地图相关配置：<mapsSetting>、<defaultInternetBuildinMapSetting>、<mapApps>、<mapViewerSetting>
自定义目录配置：<customDirectorySetting>
部门相关配置：<departmentSetting>
群组相关配置：<groupSetting>
访问域配置：<httpHeaderSetting>、
WebApp相关配置：<appsConfig>
安全配置：<proxyUriRuleConfig>、<httpsConfig>
全局搜索配置：<searchModuleConfig>

在启动 SuperMap iPortal 服务之前，建议您详细阅读下面的配置文件说明，方便您根据自身业务需求，做好产品的配置。

1. <dataSourceConnectionPoolInfo>

用于设置 SuperMap iPortal 数据库连接池，默认配置的是 SQLite 数据库，建议您选用 MySQL/Oracle/PostgreSQL 数据库。

<dbType>：数据库类型，字符需要大写，如 SQLITE、MYSQL、ORACLE、POSTGRESQL。
<driverClass>：数据库驱动的类全名。
<jdbcUrl>：连接至驱动的 url，对于 SQLite 数据库文件路径，如果使用相对路径，则是相对于 iPortal home 的路径，此外，SQLite 数据库提供了英文版，数据库名为 iportal_en.db，如果您需要使用英文版的示范应用等，可以切换至英文版的数据库，只需将数据库名 iportal.db 替换为 iportal_en.db 即可，需要注意的是，中英文数据库中存放的内容是彼此独立的，切换后，中文版数据库的内容不会更新到英文版数据库中，请在使用 iPortal 之前选择好数据库语言版本；MYSQL JDBC URL 的格式为：jdbc:mysql://[host:port]/[database]?[参数名1]=[参数值1]&[参数名2]=[参数值2]…。其中 MySQL 的默认端口为：3306，database 为数据库名，参数可选。需要注意的是，在 xml 配置文件中，url 中的&符号需要转义成&。Oracle JDBC URL 的格式为：jdbc:oracle:thin:@[host:port]:[database]。其中 Oracle 的默认端口为 1521，database 为创建的数据库实例名。PostgreSQL JDBC URL 的格式为：jdbc:postgresql://[host:port]/[database]?[参数名1]=[参数值1]&[参数名2]=[参数值2]…。其中 PostgreSQL 的默认端口为 5432，database 为数据库名。
<maxPoolSize>：连接池在同一时刻内所提供最大活动连接数。
<initialPoolSize>：初始化连接池大小。
<minPoolSize>：连接池在同一时刻内所提供最小活动连接数。
<maxIdleTime>：最大空闲时间，maxIdleTime 秒内未使用则连接被丢弃。若为0则永不丢弃，默认值: 0。
<maxWait>：当发生异常时数据库等待最大毫秒数（当没有可用连接时）。
<username>：用户名。SQLite 数据库的用户名可以为空；MySQL 数据库的初始管理员账号是 root；Oracle 数据库应填写具有 DBA 权限的用户的用户名；PostgreSQL 数据库的初始管理员账号是 postgres。
<password>：密码。SQLite 数据库的密码可以为空；MySQL 数据库没有初始密码。Oracle 数据库填写 <username> 配置项中的用户所对应的密码；PostgreSQL 数据库填写安装数据库时输入的管理员密码。

2. <uploadSetting>

<userMaxCapacity>：用于设置用户允许上传的最大数据容量默认值，单位：MB。

3. <serviceSetting>

<showOffline>：用于设置服务列表中是否显示离线服务，默认值：false，不显示离线服务，只显示在线服务。您可以设置为：true，既显示离线服务也显示在线服务。离线表示该服务的原始服务已经被停用或删除。

4. <serviceCheckSetting>

用于设置注册服务的动态更新时间，主要指检测单个服务的状态更新和批量注册服务的数量更新，两者分开配置，单位：分钟。

<singleCheckInterval>：单个注册的服务自动检测时间，默认：30分钟。
<batchCheckInterval>：批量注册的服务自动检测时间，默认：60分钟。

5. <serviceAuditSetting>

<allowServiceAudit>：用于设置是否开启服务审核功能，默认值：false，不开启服务审核功能。
<auditedAttributes>：用于设置哪些服务属性字段被修改后需要管理员重新审核，默认值：all，审核所有服务属性字段，即：如果普通用户对审核通过的服务进行了修改，即使修改任意一个属性字段，都需要管理员重新审核。当然，管理员可以配置哪些服务属性字段被修改后需要重新审核，以英文","分隔，如：resTitle,thumbnail。服务属性字段包括：名称(resTitle)、描述(idAbs)、缩略图(thumbnail)、标签(tags)、参照系(refSysInfo)、标识(exDesc)、范围(geoBndBox)、提供者(mdContact)。

6. <registerSetting>

<allowRegister>：用于设置用户注册功能的开启与禁用，默认值：true，开启用户注册功能。
<allowUserAudit>：用于设置是否开启对注册用户的审核功能，默认值：false，不开启对注册用户的审核功能。
<sendEmailNotification>：用于设置是否向注册用户发送审核结果的邮件通知，默认值：false，不开启发送邮件通知功能。
<extendUserFields>：用于设置用户注册时需要填写的除基本信息（如：账号、密码等）之外的其他信息（如：部门、邮箱等）。每个信息都包含在一个<field>节点中，需要在<field>节点中设置如下信息：
<name>：用于设置用户注册时的扩展字段名称，目前支持：部门（Department）、邮箱（Email），即：用户注册时可选择部门或邮箱。
<required>：用户设置扩展字段是否为必填项，true 表示必填项，false 表示可选项。

注意：如果设置部门、邮箱等多个信息，相应的需设置多个<field>节点，每个<field>节点中只能设置一个信息，例如：部门。

<defaultRole>：用于设置注册用户的默认角色，即：为新注册的用户分配的角色。默认值： PORTAL_USER。目前支持设置：PORTAL_USER 或 PORTAL_VIEWER 角色。

7. <shareSetting>

<allowListUsers>：用于设置资源分享给指定用户时，是否允许列出所有用户列表，默认值：false，不允许列出所有用户列表。如果设置为 true，将会在分享时列出门户中所有用户的列表。需要注意的是，列出所有用户列表与根据部门列出用户是不相兼容的，即如果您在分享给指定用户时允许列出所有用户列表，将不会再根据部门组织结构列出门户中的用户。
<scope>：用于设置资源的共享范围。
<toUser>：用于设置是否允许共享给指定用户，默认值：true，允许共享给指定用户。
<toGroup>：用于设置是否允许共享给群组，默认值：true，允许共享给群组。
<toDepartment>：用于设置是否允许共享给部门，默认值：false，不允许共享给部门。

8. <mapsSetting>

<showBatchAddMaps>：用于设置在 iPortal 的地图列表页面是否显示批量添加地图按钮，默认值：true，显示批量添加地图按钮。
<allowMapAudit>：用于设置是否开启地图审核功能，默认值：false，不开启地图审核功能。
<auditedAttributes>：用于设置哪些地图属性字段被修改后需要管理员重新审核，默认值：all，审核所有地图属性字段，即：如果普通用户对审核通过的地图进行了修改，即使修改任意一个属性字段，都需要管理员重新审核。当然，管理员可以配置哪些地图属性字段被修改后需要重新审核，以英文","分隔，如：title,description。地图属性字段包括：标题(title)、描述(description)、缩略图(thumbnail)、标签(tags)、中心点和缩放级别(geoAttr)、图层(layers)。

9. <serviceProxy>

用于设置在 iPortal 中注册的服务是否使用代理，默认不启用服务代理，建议您启用服务代理。

如果您不启用服务代理，会存在以下这种状况：

用户 A 注册了一个服务，并分享给用户 B，此时用户 B 知道了该服务地址。当用户 A 修改了该注册服务的共享设置后，用户 B 登录 iPortal 门户，在服务列表中看不到该条服务信息了，但之前已经知道该服务地址的事实无法改变，用户 B 仍然可以访问该服务，服务的信息安全受到威胁。

启用服务代理后，只有服务的注册者和管理员可以看到原始的服务地址，其他有权限访问该服务的用户只能看到代理后的服务地址，在门户级别实现了对注册服务的访问控制。

<enable>：设置是否启用服务代理，默认值：false，不启用服务代理，如果您希望启用服务代理，可以设置为： true。
<enableBuiltinProxy>：设置是否启用 iPortal 内置的服务代理功能，默认值：true，启用内置的服务代理，关于内置的服务代理配置请参见：SuperMap iPortal 内置的服务代理配置。
<port>：设置代理服务地址的端口号，默认值：8195。您也可以自定义设置该端口号，只要保证您设置的端口号没有被占用就可以。
<rootUrlPostfix>：为代理服务根地址设置统一的后缀名，默认的后缀名为：portalproxy，完整的代理服务地址例如：http://192.168.120.40:8195/portalproxy/iserver/services/map-changchun/rest，您可以根据实际需要设置该后缀名，也可以设置为空值，即不设置后缀名。
<httpConnPoolInfo>：代理服务的连接池设置项，用于设置代理服务内部的 HttpClient 连接池。调整该节点下的各个设置项，从而提升代理服务的并发性能。
<maxTotal>：设置整个连接池最大连接数。默认值是：20。
<defaultMaxPerRoute>：对于一个路由地址，设置最多存在几个连接。默认值是：2。
<enableAccessStatistics>：设置是否开启代理服务访问统计功能，默认值：false，不开启。
<cacheConfig>：设置代理服务缓存。iPortal 提供了两种缓存方式：Ehcache 缓存和 Redis 缓存。系统默认使用的是 Ehcache 缓存，您无需进行任何配置，可直接使用。其中，iPortal 内置的服务代理支持 Ehcache 缓存和 Redis 缓存，独立部署的服务代理仅支持 Redis 缓存。
<enable>：设置是否开启服务代理缓存功能，默认值：true，开启
<type>：设置缓存类型，字符需要大写，默认值：EHCACHE，使用 Ehcache 缓存，您还可设置为：REDIS，使用 Redis 缓存
<cacheServerConfig>：缓存服务器配置
<ehcacheConfigPath>：设置 Ehcache 配置文件的路径，默认指向系统自带的 Ehcache 缓存的配置文件 iportal-ehcache.xml，位于【SuperMap iPortal 安装目录】\webapps\iportal\WEB-INF 目录下，当然，您也可以自己编写独立的缓存配置文件。

我们以注释的方式提供了以下 Redis 缓存的配置信息：

<nodes>：设置 Redis 服务节点，Redis 若要使用集群，nodes节点可以配置多个 host:port，以“|”分隔，否则只需配置一个 host:port
<timeout>：Redis 服务连接超时时间，单位：ms
<password>：Redis 服务的访问密码
<maxTotal>：可用连接 Redis 实例的最大数目
<maxIdle>：控制一个 Pool（连接池）最多有多少个状态为 idle（空闲的）的 Jedis 实例
<maxWaitMillis>：等待可用连接的最大时间，单位：ms，默认值：-1，表示永不超时
<testOnBorrow>：在 borrow 一个Jedis 实例时，是否提前进行 validate 操作，默认值：true，表示得到的 Jedis 实例均是可用的。不建议对该参数进行修改。

注意：

支持注册的服务类型中，SuperMap REST 服务、OGC 服务（WMS、WMTS、WFS、WCS、WPS）、ArcGIS REST 服务均支持服务代理，而“其他服务”类型不支持服务代理。
停用代理服务后，需要重启 iPortal 服务，设置才会生效。

10. <customDirectorySetting>

用于设置自定义目录功能的显示或者隐藏。地图和服务自定义目录的默认值都是：false，不显示地图、服务、场景的自定义目录。您可以分别开启地图和服务的自定义目录功能。关于自定义目录配置请参见：自定义目录配置。

11. <defaultInternetBuildinMapSetting>

<googleMapsAPIKey>：用于设置 Google Maps JavaScript API Key，需要您去 Google Developers 申请一个 Key。

12. <httpHeaderSetting>(已过期)

用于设置允许访问 iPortal 资源的域。自 iPortal 9D(2019) SP1起，该配置项已过期，iPortal 默认支持所有跨域访问，如果您希望只允许指定域可访问，可将 %SuperMap iPortal_HOME%\webapp\iportal\WEB-INF\web.xml 文件中 cors.allowed.origins 参数值由默认的 *（支持所有域访问）修改为指定可访问的域。如果您希望在跨域访问时携带 cookie，还需将 cors.support.credentials 的值设置为 true。

<accessControlAllowOrigins>：设置允许的域，优先匹配这些域，不匹配时使用defaultAccessControlAllowOrigin 的设置。
<defaultAccessControlAllowOrigin>：默认允许所有域，可配置特定的域。

13. <departmentSetting>

<enable>：用于设置组织结构功能的启用与禁用。默认值：false，不启用组织结构配置。如果您希望实现分部门的资源管理，各级单位或部门管理员在门户中管理各级单位或部门的资源和用户，那么建议您启用组织结构配置功能。
<orderBy>：用于设置组织结构中部门的排序字段。默认值：CREATETIME，按部门的创建时间排序。您也可以设置按 NAME（按部门名称排序）、ORDERNUM（按填写的部门序号排序）。
<orderType>：用于设置排序时，按升序或降序排序。默认值：ASC，按升序排序。您也可以设置按 DESC 降序排序。

14. <mapApps>

Map App 集合，用于扩展用户自定义的地图应用 APP，默认值：mapViewer_v2，使用 iPortal 内置的 V2版本（新版）数据上图 APP。

15. <groupSetting>

用于设置在“我的申请”和“我的授权”页面是否显示群组相关信息。默认值：true，显示群组相关信息。

16.<portalCustomSetting>

门户自定义设置。

<supportMultiLanguages>：为门户自定义的内容设置多语言，例如：自定义目录，默认支持一种语言，可通过如下配置支持多语言：
<enable>：设置是否启用多语言设置，默认值：false，不启用多语言设置，如果您希望启用多语言设置，可以设置为： true。
<languages>：设置支持的语言，目前支持中文和英文，可设置为：zh-CN,en-US。

17.<mapViewerSetting>

用于设置数据上图中，地图中允许添加的矢量要素总数的最大值，默认值：3000。

18.<cookieStorage>

登录用户的 cookie 存储配置，用于 iPortal 与代理服务之间的 session 共享。iPortal 提供了两种缓存方式：Ehcache 缓存和 Redis 缓存。系统默认使用的是 Ehcache 缓存，您无需进行任何配置，可直接使用。其中，iPortal 内置的服务代理支持 Ehcache 缓存和 Redis 缓存，独立部署的服务代理仅支持 Redis 缓存。

<type>：设置缓存类型，字符需要大写，默认值：EHCACHE，使用 Ehcache 缓存，您还可设置为：REDIS，使用 Redis 缓存
<cacheServerConfig>：缓存服务器配置
<ehcacheConfigPath>：设置 Ehcache 配置文件的路径，默认指向系统自带的 Ehcache 缓存的配置文件 iportal-ehcache.xml，位于【SuperMap iPortal 安装目录】\webapps\iportal\WEB-INF 目录下，当然，您也可以自己编写独立的缓存配置文件。

我们以注释的方式提供了以下 Redis 缓存的配置信息：

<nodes>：设置 Redis 服务节点，Redis 若要使用集群，nodes节点可以配置多个 host:port，以“|”分隔，否则只需配置一个 host:port
<timeout>：Redis 服务连接超时时间，单位：ms
<password>：Redis 服务的访问密码
<maxTotal>：可用连接 Redis 实例的最大数目
<maxIdle>：控制一个 Pool（连接池）最多有多少个状态为 idle（空闲的）的 Jedis 实例
<maxWaitMillis>：等待可用连接的最大时间，单位：ms，默认值：-1，表示永不超时
<testOnBorrow>：在 borrow 一个Jedis 实例时，是否提前进行 validate 操作，默认值：true，表示得到的 Jedis 实例均是可用的。不建议对该参数进行修改。

19.<appsConfig>

用于设置 iPortal 中内置的 WebApps 的使用权限。

<editableAppsLimitToAdmin>: 只有管理员具有使用权限的 WebApps
<PortalAppType>:WebApp 的名称，目前支持配置 DATAVIZ、DATAINSIGHTS、MAPSTYLER、EARTH、MAPDASHBOARD、APPBUILDER

20.<proxyUriRuleConfig>

用于设置 getURLResource 资源中的 SSRF 防御配置。

<includes>：允许访问的 URL符合的正则表达式规则
<excludes>：拒绝访问的 URL 符合的正则表达式规则
<lanConfig>：局域网 IP 配置项
<whiteList>：IP 白名单，允许访问的IP地址列表
<blackList>：IP 黑名单，拒绝访问的IP地址列表
<denyProxySameDomain>：是否拒绝访问代理主机同域名的服务。默认为 false，允许来自同域名的访问

21.<searchModuleConfig>

用于设置 iPortal 的全局搜索功能。

<enable>：是否开启全局搜索功能。默认值： true。
<reindexAllResources>：是否重新索引已有 iPortal 资源。重建索引后，此配置会自动设置为 false。
<startElasticSearch>：是否启用 iPortal 内置的 Elasticsearch。默认值：true。如果您希望使用自己搭建的 Elasticsearch 服务器，需要将该值设置为 false。
<port>：内置全局搜索服务的端口。默认端口号：8192。

22.<httpsConfig>

iPortal 的 https 证书信任设置。

<trustAllHttpsCertificates>：是否信任所有的 https 证书。默认值： true，信任所有证书。