arc.properties 配置

Version 25.2.9314


arc.properties 配置


本参考指南涵盖了知行之桥的 arc.properties 文件中所有支持的配置选项。该文件用于嵌入式 Jetty Web 服务器

要将这些选项添加到知行之桥应用程序,请使用文本编辑器打开 arc.properties 文件(位于安装目录中),然后添加相应的语法。可以在下面找到每个选项的示例。

cdata.app.db

定义知行之桥使用的后端数据库的连接字符串。

cdata.app.db=jdbc:cdata:mysql:server=localhost;port=3306;database=mysql;user=MyUserName;password=MyPassword

cdata.app.directory

定义知行之桥的用户数据存储路径。

cdata.app.directory=/mnt/shared/arc

cdata.contextPath

定义部署 Web 应用程序的基本 URL 路径。它充当 Web 应用程序处理的所有 URL 的前缀。

cdata.contextPath=/myapp

例如,如果应用程序托管在www.mydomain.com,则这可确保接收端点是http://www.mydomain.com/myapp/pub/Receive.rsb

cdata.tempDirectory

定义应用程序使用的临时目录的位置。

cdata.tempDirectory=/tmp/arc

cdata.initParameters

定义 Servlet 的初始化参数。这些参数是键值对,供 Servlet 或过滤器在运行时访问。它们必须以逗号分隔的字符串形式设置,格式为key:value

cdata.initParameters=sessionTimeout:60,allowedOrigins:*

cdata.warPath

如果arc.war文件位于其他位置,则设置其路径。

cdata.warPath=${cdata.home}/webapp/arc.war

cdata.http.port

设置知行之桥运行和监听的HTTP端口。

cdata.http.port=4080

cdata.http.host

设置 Jetty HTTP 服务器应绑定的主机/IP 地址。这决定了服务器监听传入 HTTP 请求的网络接口。

cdata.http.host=192.168.0.27

cdata.http.timeout

控制 HTTP 连接的空闲超时时间。此设置决定 Jetty 在关闭连接之前等待连接活动的时间(以毫秒为单位)。

cdata.http.timeout=60000

cdata.http.gzipEnabled

布尔选项,用于控制是否为 HTTP 响应启用 GZIP 压缩。启用后,Jetty 会自动压缩响应以减少带宽占用,从而提高支持 GZIP 的客户端的性能。

cdata.http.gzipEnabled=true

cdata.http.maxFormSize

定义 HTTP 表单提交(例如 application/x-www-form-urlencoded 和 multipart/form-data 请求)允许的最大大小(以字节为单位)。它限制了表单提交(包括通过表单上传文件)中可处理的数据量。

cdata.http.maxFormSize=2000000

cdata.http.proxyMode

布尔选项,用于确定 Jetty 是在反向代理还是负载均衡器后面运行。启用后,Jetty 会正确处理代理请求,包括 X-Forwarded-For 和 X-Forwarded-Proto 等标头。

  • 如果设置为 true,Jetty 会信任来自代理的 X-Forwarded-* 标头。
  • 如果设置为 false,Jetty 会忽略这些标头并假定客户端直接连接。

这可确保在代理后运行时能够正确检测客户端 IP、进行 HTTPS 重定向和主机解析。

cdata.http.proxyMode=true

cdata.tls.port

指定 Jetty 用于 TLS(HTTPS)连接的端口号。这是 cdata.http.port 的安全替代方案,用于纯 HTTP 流量。

cdata.tls.port=443

cdata.tls.keyStoreType

指定 Jetty 应用于 TLS/SSL 证书的密钥库类型。密钥库包含 Jetty 建立安全 HTTPS 连接所需的私钥和 SSL 证书。

常见类型包括JKS、PKCS12、BKS和PEM。

cdata.tls.keyStoreType=PEM

cdata.tls.keyStorePath

指定 Jetty 应用于 TLS/SSL 加密的密钥库的文件路径。

cdata.tls.keyStorePath=/pathto/mykeystore.jks

cdata.tls.keyStorePassword

定义指定密钥库的密码。

cdata.tls.keyStorePassword=Password123

cdata.tls.sniHostCheck

布尔值,控制 Jetty 是否在 TLS/SSL 连接中的服务器名称指示 (SNI) 处理期间强制执行主机名验证。

cdata.tls.sniHostCheck=true

cdata.requestLog.enabled

用于控制 Jetty 是否将 HTTP 请求记录到访问日志的布尔值。启用后,Jetty 会记录传入请求的详细信息,例如客户端 IP、请求方法、响应状态和响应时间。

cdata.requestLog.enabled=true

cdata.requestLog.filenameDateFormat

指定 Jetty 在轮转日志时附加到日志文件名的日期格式模式。这有助于按天、小时或自定义间隔整理日志。

  • cdata.requestLog.filename 一起使用,生成轮转日志文件名。
  • 该格式遵循 Java 的 SimpleDateFormat 模式。默认值为 yyyy_MM_dd,表示每天创建一个新的日志文件。
  • 如果为空 (""),Jetty 将禁用基于日期的轮转。

cdata.requestLog.filenameDateFormat=MM_dd_yyyy

cdata.requestLog.retainDays

指定 Jetty 在自动删除旧访问日志之前保留它们的天数。

  • 默认值为31,表示 Jetty 会在删除日志之前保留 31 天。
  • 设置为0时,Jetty 将禁用日志保留,这意味着日志永远不会自动删除。
  • jetty.requestLog.filenameDateFormat一起使用,用于管理轮换日志文件。

cdata.requestLog.retainDays=90

cdata.session.timeout

定义 Jetty Web 服务器中用户会话过期之前的最大不活动持续时间(以秒为单位)。

  • 默认值为 600 秒(10 分钟)。
  • 小于或等于 0 的值将被忽略。

cdata.session.timeout=1200

cdata.loginService.ldap.

这被解释为cdata.loginService.ldap.*。这些属性用于在 Jetty 中配置轻量级目录访问协议 (LDAP) 身份验证,允许用户通过 LDAP 服务器进行身份验证。支持多种属性。在嵌入式 Jetty 服务器上使用 LDAP 时,至少需要以下属性:

cdata.loginService.ldap.hostname
cdata.loginService.ldap.bindDn
cdata.loginService.ldap.bindPassword

arc.properties 的完整 LDAP 部分可能如下所示:

;; LDAP
cdata.loginService.ldap.enabled=true
cdata.loginService.ldap.bindDn="CN=ldapuser,DC=example,DC=org"
cdata.loginService.ldap.hostname="127.0.0.1"
cdata.loginService.ldap.bindPassword="Adminpassword1"
cdata.loginService.ldap.port="1389"
cdata.loginService.ldap.debug=true
cdata.loginService.ldap.authenticationMethod="simple"
cdata.loginService.ldap.userBaseDn="DC=example,DC=org"
cdata.loginService.ldap.userRdnAttribute="cn"
cdata.loginService.ldap.userPasswordAttribute="userPassword"
cdata.loginService.ldap.forceBindingLogin="true"
cdata.loginService.ldap.roleBaseDn="DC=example,DC=org"
cdata.loginService.ldap.roleNameAttribute="cn"
cdata.loginService.ldap.roleMemberAttribute="member"
cdata.loginService.ldap.useLdaps="false"

请参阅配置 LDAP 身份验证以获取更多上下文以及受支持的属性的完整列表。

cdata.loginService.ldap.enabled

布尔值,用于确定 Jetty 中是否启用了 LDAP 身份验证。此属性通常用于根据您的配置需求启用或禁用整个基于 LDAP 的登录服务。

cdata.loginService.ldap.enabled=true