OSGi配置设置

🔗 OSG是AEM技术堆栈中的一个基本元素。它用于控制AEM的复合包及其配置。

OSGi "提供了标准化基元，它允许应用程序从可重用的小组件和协作组件构建。 这些组件可以组合成应用程序并部署"。

这样可以轻松管理包，因为可以单独停止、安装和启动包。 互依关系会自动处理。 每个OSGi组件（请参阅OSGi规范）都包含在各种包中的一个包中。 使用AEM时，可通过多种方法来管理此类包的配置设置；有关更多详细信息和建议的实践，请参阅配置OSGi 。

以下OSGi配置设置（根据包列出）与项目实施相关。 列出的设置并非都需要调整，其中有些设置可帮助您了解AEM的操作方式。

注意

该列表旨在作为准则，并不详尽。 并非列出了所有包，也未列出某些包的所有参数。

所需的配置因项目而异。

有关使用的值以及有关参数的详细信息，请参阅Web控制台。

注意

OSGi配置差异工具是AEM工具的一部分，可用于列出默认的OSGi配置。

注意

对于AEM中的特定功能区域，可能需要其他包。 在这些情况下，可以在与相应功能相关的页面上找到配置详细信息。

AEM复制事件侦听 器配置：

  • 运行模式，复制事件将分发给侦听器。 例如，如果定义为作者，则系统将“启动”复制。

  • 如果项目代码在发布环境中处理复制事件（反向复制），则需要添加运行模式​publish。 例如，当使用调度程序从发布环境刷新时，或当发生到其他发布实例的标准复制时。

AEM存储库更改 侦听器配置：

  • 路径，用于侦听准备分发的存储库事件的位置。

CRX Sling客户端存 储库配置对基础内容存储库的访问。

  • 安装后应更改​管理员密码，以确保实例的安全。

  • 不应进行其他更改，并且必须谨慎，因为这些更改会影响对存储库的访问。

维客邮 件服务为维客发送的电子邮件配置电子邮件设置。

Apache Felix OSGi管理控 制台配置：

  • 插件，主导航项目（控制台插件），可在Apache Felix Web Management Console顶 级菜单项 中使用。禁用您不需要的任何内容，因为每个内容都需要空间和资源。
注意

请务必配置以下内容：

用 户名 和密码，用于访问Apache Felix Web管理控制台本身的凭据。
初始安装后必须更改密码，以确保实例的安全。

注意

此配置应使用Felix控制台进行，因为启动时需要此配置 — 在存储库可用之前。

Apache Sling可自定义的请求数据记录 器配置：

  • 记录 器名称 和日 志格式，用于配置请求和访问日志记录的位置和格式(默认值： request.log)。在分析与Web链相关的性能或调试功能时，此日志文件至关重要。

    这与Apache Sling请求记录器相配对。

有关更多信息，请参阅AEM日志记录和Sling日志记录。

Apache Sling事件线程池 配置：

  • 最小 池大 小和最大池大小，用于保存事件线程的池大小。

  • 队列大小，在池耗尽时线程队列的最大大小。

    推荐的值为-1，因为这会将队列设置为“无限制”；如果设置了限制，则在超出限制时可能会发生损失。

  • 更改这些设置有助于在事件数量较多的情况下提高性能；例如，大量AEM DAM或工作流的使用情况。

  • 应使用测试建立特定于您方案的值。

  • 这些设置可能会影响实例的性能，因此请不要无故和适当考虑地更改它们。

Apache SlingGETServlet 配置渲染的某些方面：

  • 自动 索引，用于启用/禁用目录渲染以进行浏览。

  • 启用 （或禁用）默认演绎版，如 HMTL、 纯文本、 ​​JSON 或XML。

    您不应禁用JSON。

注意

如果您在生产就绪模式中运行AEM，则会为生产实例自动配置此设置。

Apache Sling Java脚本处理程 序配置将.java文件编译为脚本(servlet)的设置。

某些设置可能会影响性能，应尽可能禁用这些设置，尤其是对于生产实例。

  • S 源VM​和​目标VM，将JDK版本定义为用作运行时JVM的版本

  • 对于生产实例：

    • 禁用​生成调试信息

Apache Sling JCR安 装程序这些参数可能不需要配置，但在开发或调试时可能有助于了解这些参数。例如，安装文件夹可用于签入/签出或创建包。

  • 安装文件夹名 称重新展 开安装文件夹的最大层次结构深度 — 指定在何处搜索要安装的资源库文件夹以及搜索到哪个深度。使用通配符时（如中所示）。*/install)将搜索所有适当的匹配项，例如/libs/sling/install和/libs/cq/core/install。

  • 搜索路径,jcrinstall搜索要安装的资源的路径列表，以及指示该路径的权重因子的数字。

Apache Sling作业事件处理程 序配置用于管理作业计划的参数：

  • 重试间隔、 最大重试次数、 最大并行作业数、 确认等待时间​等。

  • 更改这些设置可以提高大量作业情况下的性能；例如，大量使用AEM DAM和工作流。

  • 应使用测试建立特定于您方案的值。

  • 请勿随意更改这些设置，只有在适当考虑后才进行更改。

Apache Sling JSP脚本处理程 序为JSP脚本处理程序配置与性能相关的设置。要提高性能，应尽可能禁用。

特别是对于生产实例：

  • 禁用​生成调试信息
  • 禁用​Keep Generated Java
  • 禁用​映射的内容
  • 禁用​显示源片段
注意

如果您在生产就绪模式中运行AEM，则会为生产实例自动配置此设置。

Apache Sling日志记录 配置：

  • 日 志级 别日志文件，用于定义中央日志记录配置(error.log)的位置和日志级别。该级别可设置为DEBUG、INFO、WARN、ERROR和FATAL中的一个。

  • 日志文 件和日 志文 件的数量阈值，用于定义日志文件的大小和版本旋转。

  • 消息 模式定义日志消息的格式。

有关更多信息，请参阅AEM日志记录和Sling日志记录。

Apache Sling日志记录器配置（工厂配置） 配置：

  • 日志级别、日 志 文件和 消息 格式，以定义日志文件和消息的详细信息。

  • ​​Loggerto定义类别；例如，仅对com.day.cq执行日志。

  • 通过使用​工厂配置，可以添加任意数量的附加配置以满足所需的各种日志级别和类别。

  • 这种配置在开发过程中很有帮助；例如，将特定服务的TRACE消息记录到特定日志文件中。

  • 此类配置在生产环境中非常有用；例如，将有关特定服务的消息记录到单个日志文件中，以便更便于监控。

有关更多信息，请参阅AEM日志记录和Sling日志记录。

Apache Sling日志记录编写器配置（工厂配置） 配置：

  • 日 志文件，定义日志文件的存在性。

  • 用于定义版 本旋转的日志文件数。

  • Apache Sling日志记录器配置​配置可以使用编写器。

  • 这种配置在开发过程中很有帮助；例如，将特定服务的TRACE消息记录到特定日志文件中。

  • 此类配置在生产环境中非常有用；例如，将有关特定服务的消息记录到单个日志文件中，以便更便于监控。

有关更多信息，请参阅AEM日志记录和Sling日志记录。

Apache Sling主 ServletConfigure:

  • 每个请求和递归 深度 调 用的数量，以保护系统免受无限递归和过多脚本调用的影响。

Apache Sling MIME类型服 务配置：

  • MIME类 型，将项目所需的类型添加到系统中。这允许文件上的GET请求为链接文件类型和应用程序设置正确的content-type标头。

Apache Sling反向链 接过滤器要解决CRX WebDAV和Apache Sling中存在的跨站点请求伪造(CSRF)的已知安全问题，您需要配置反向链接过滤器。

反向链接过滤器服务是一种OSGi服务，可用于配置：

  • 应筛选哪些http方法
  • 是否允许空反向链接标头
  • 以及除服务器主机外允许的服务器列表。

有关更多详细信息，请参阅安全检查表 — 跨站点请求伪造问题 。

注意

Apache Sling反向链接过滤器依赖于快速修补程序包的安装。

Apache Sling请求记 录器配置：

  • 用于定义请求记录方式的各种参数。

  • 启用请求日志，以启用或禁用。

  • 启用访问日志，以启用或禁用。

这与Apache Sling可自定义的请求数据记录器相配对。

有关更多信息，请参阅AEM日志记录和Sling日志记录。

Apache Sling资源解析程序工 厂配置Sling资源解析的核心方面：

  • 资源搜索路径，添加任何特定于项目的路径(但不删除 /libs 或 /apps)。

  • 虚拟 URL来定义虚URL映射。

  • 用于定 义任何别名的URL映射；例如，从 /content 到 /。

  • 映射位置，中外部化的映射器配 /etc/map置。

  • 使用本地安装（例如，使用http://localhost:4502/system/console/jcrresolver）确定哪个资源解析程序处于活动状态。

有关详细信息，请参阅：https://cwiki.apache.org/confluence/display/SLING/Flexible+Resource+Resolution。

注意

特别是，必须在存储库中配置这些选项。

否则，在下次启动时，AEM可能会覆盖使用Felix控制台对​URL映射​所做的更改。

Apache Sling Servlet/Script解析程序和错误处理程 序Sling Servlet和脚本解析程序具有多个任务：

  1. 它用作ServletResolver，以选择Servlet或Script来调用以处理请求。

  2. 它用作SlingScriptResolver。

  3. 它通过使用与用于解析请求处理Servlet和脚本相同的算法来实施ErrorHandler界面来管理错误处理，以选择错误处理Servlet和脚本。

可以设置各种参数，包括：

  • 执行 路径可滑动路径以搜索可执行脚本；通过配置特定路径，您可以限制可以执行的脚本。如果未配置路径，则使用默认路径(/ = root)，这允许执行所有脚本。

    如果配置的路径值以斜杠结尾，则会搜索整个子树。 如果没有这样的尾随斜杠，则仅当脚本与脚本完全匹配时，才会执行脚本。

  • 脚本用户 — 此可选属性可指定用于读取脚本的存储库用户帐户。如果未指定帐户，则默认使用admin用户。

  • 默认 扩展将使用默认行为的扩展列表。这意味着资源类型的最后一个路径段可用作脚本名称。

Day Commons GFX字体助 手在渲染图形时，可以使用DrawText嵌入文本。为此，您还可以安装自己的字体：

  • 定义要搜索项目特定字体的​字体路径。

    例如，/apps/myapp/fonts。

使用Apache HTTP客户端 的所有代码的Apache HTTP组件代理配置代理配置，在进行HTTP时使用；例如，复制时。

创建新配置时，请勿更改工厂配置，而是使用此处提供的配置管理器为此组件创建新的工厂配置：http://localhost:4502/system/console/configMgr/。 代理配置在​org.apache.http.proxyconfigurator中提供。

注意

在AEM 6.0及更早版本中，代理是在Day Commons HTTP客户端中配置的。 自AEM 6.1及更高版本起，代理配置已移至“Apache HTTP组件代理配置”，而不是“Day Commons HTTP Client”配置。

Day CQ Antispam配置使用的反垃圾邮件服务(Akismet)。这要求您注册：

  • 提供程序
  • API密钥
  • 注册的URL

AdobeGranite HTML库管 理器配置此库以控制客户端库（css或js）的处理；包括如何查看底层结构。

  • 对于生产实例：

    • 启用​Minify（以删除CRLF和空格字符）。
    • 启用​Gzip（允许使用一个请求来压缩和访问文件）。
    • 禁用​Debug
    • 禁用​Timing

  • 对于JS开发（尤其是在进行消息调试时）：

    • 禁用​Minify
    • 启用​Debug​以分隔文件进行调试和与firebug一起使用。
    • 如果对计时感兴趣，请启用​计时。
    • 启用​Debug​控制台以查看JS控制台日志消息。
注意

更改​Minify​或​Gzip​的设置时，还需要删除/var/clientlibs的内容。 这是Clientlibs的缓存版本，将在下次请求时重新构建。

注意

如果您在生产就绪模式中运行AEM，则会为生产实例自动配置此设置。

Day CQ HTTP头身份验证处 理程序HTTP请求的基本身份验证方法的系统范围设置。

使用已关闭的用户组时，您可以配置（其中包括）：

  • HTTP领域
  • 默认登录页面

Day CQ Link Checker服务检 查和（如有必要）配置：

  • 调度 程序周期，定义自动检查外部链接的间隔。

  • 检查​Bad Link Tolerance Interval，以了解在此期间之后，失败的外部链接被视为坏。

  • 链接检查覆盖模式，以定义要从链接检查中排除的任何路径。

Day CQ Link Checker任 务为单个链接检查器任务（用于检查外部链接的任务）配置设置：

  • 检查在​良好链接测试间隔​和​坏链接测试间隔​中定义的间隔

  • 检查链接时外部访问所需的与Internet访问代理和NTLM相关的各种参数。

Day CQ Mail Service配 置邮件服务器的主机名和访问详细信息。请参阅配置邮件服务一节。

Day CQ MCM新闻稿 配置与新闻稿一起使用的各种设置。

Day CQ根映射 配置：

  • Target 路径，用于定义对“ ”的请 /求将被重定向到的位置。

AEM中提供了两个UI :

  • 触屏优化UI已引入
  • 经典UI仍然完全可操作

使用AEM根映射，您可以配置要作为实例默认UI的UI:

  • 要使触屏优化UI作为默认UI，Target路径​应指向：

       /projects.html

  • 要将经典UI作为默认UI，Target路径​应指向：

       /welcome.html
注意

标准安装后，触屏优化UI是默认UI。

AdobeGranite SSO身份验证处 理程序配置单点登录(SSO)详细信息；在企业创作设置中，通常需要使用这些参数，通常与LDAP结合使用。

提供了各种配置属性：

  • ​
    此身份验证处理程序处于活动状态的PathPath。如果此参数留空，则禁用身份验证处理程序。 例如，路径/会导致将身份验证处理程序用于整个存储库。

  • 服务
    排名OSGi框架服务排名值用于指示调用此服务的顺序。这是
    int 值越高，则指定的优先级越高。

    默认值为 0.

  • 标
    头名称可能包含用户ID的标头名称。

  • Cookie名
    称可能包含用户ID的Cookie的名称。

  • 参
    数名称可能提供用户ID的请求参数的名称。

  • 用
    户映射对于选定的用户，从HTTP请求提取的用户名可以替换为凭据对象中的其他用户名。此处定义了映射。 如果用户名
    admin 显示在映射的任一侧，将忽略映射。请注意，字符“=”必须使用前导“\”进行转义。

  • ​
    格式指示提供用户ID的格式。用法:

    • Basic 用户ID是否采用HTTP Basic Authentication格式进行编码
    • AsIs 如果用户ID以纯文本提供，或者应按原样使用任何已应用的正则表达式值或任何正则表达式

Day CQ WCM调试过 滤器开发时，此功能非常有用，因为它允许在访问页面时使用后缀，如？debug=layout。例如，http://localhost:4502/cf#/content/geometrixx/en/support.html?debug=layout将提供开发人员可能感兴趣的布局信息。

  • 在生产实例上禁用此功能，以确保性能和安全性。

Day CQ WCM过 滤器配置：

  • WCM模 式来定义默认模式。

  • 在创作实例中，此参数可能为edit、disable,preview或analytics。

    其他模式可以从Sidekick访问，或者后缀?wcmmode=disabled可用于模拟生产环境。

  • 在发布实例上，必须将此参数设置为disabled，以确保不能访问其他模式。

注意

如果您在生产就绪模式中运行AEM，则会为生产实例自动配置此设置。

Day CQ WCM Link Checker配置 器配置：

  • 重写配置 列表，用于为基于内容的链接检查器配置指定位置列表。配置可以基于运行模式；这对于区分创作环境和发布环境很重要，因为linkchecker设置可能不同。

Day CQ WCM页面处理 器配置：

  • 路径，系统在触发之前侦听页面修改的位置列 jcr:Event表。

Adobe页面展示 次数跟踪器对于创作实例配置：

  • sling.auth.requirements:将此属性的值设置为 -/libs/wcm/stats/tracker
注意

此配置将允许对跟踪服务进行匿名请求。

注意

有关更多信息，请参阅页面展示次数 。

Day CQ WCM页面统 计信息对于发布实例配置：

  • 用于发送数 据的URL，用于配置用于跟踪页面统计信息的URL（如果跟踪器请求通过调度程序，则此URL至关重要）；例如，默认值为 http://localhost:4502/libs/wcm/stats/tracker。

  • 启用跟 踪脚本以启用( true)或禁用( false)在页面上包含跟踪脚本。默认值为 false.

注意

有关更多信息，请参阅页面展示次数 。

Day CQ WCM版本管 理器控制是否以及如何在您的系统中管理版本：

  • 激活时创建版本，在标准安装中启用

  • 启用清除

  • 清除路径，搜索操作将搜索的路径

  • 隐式版本控制路径，隐式版本控制处于活动状态的路径。

  • 最大版本年龄，版本的最大年龄（以天为单位）

  • 最大版本数，要保留的最大版本数

有关详细信息，请参阅版本清除。

Day CQ工作流电子邮件通 知服务为工作流发送的通知配置电子邮件设置。

CQ重写器HTML解析器工厂

控制CQ重写器的HTML解析器。

  • 要处理的其他标记 — 您可以添加或删除解析器要处理的HTML标记。默认情况下，会处理以下标记：A，IMG，AREA，FORM，BASE，LINK，SCRIPT，BODY，HEAD。
  • 保留驼峰式 — 默认情况下，HTML解析器将驼峰式（例如eBay）属性转换为小写式（例如ebay）属性。您可以关闭此选项以保留驼峰式大小写属性。 在使用前端框架(如Angular2)时，这非常有用。

Day Commons JDBC连接池 配置对用作内容源的外部数据库的访问。

这是工厂配置，因此可以配置多个实例。

Adobe CQ Media DPS会话服 务管理DPS会话以与发布结合使用。

特别是，您可以定义dps.session.service.url.name:默认设置为https://dpsapi2.digitalpublishing.acrobat.com/webservices/sessions

CDN重 写器必须确保AEM与CDN之间的通信，以便以安全的方式将资产/二进制文件交付给最终用户。这包括两项任务：

  • 最初（或在缓存中过期后）通过CDN从AEM访问资源。
  • 安全地访问缓存在CDN中的资源，因为一旦该资源缓存在CDN中，则该请求不会转到AEM，所有在上有权访问该资源的用户都应从CDN提供。

AEM提供了一个重写器，用于将内部资产URL重写到外部CDN URL。 它会重写要传递到CDN的链接，包括JWS签名和过期时间，以便安全地访问资产。 此功能将用于创作实例。

总体流程如下：

  1. 用户通过AEM进行身份验证，并请求包含资产的页面。

  2. 请求的页面包含类似于/content/dam/geometrixx-media/articles/paladin_trailer.jpg/jcr:content/renditions/cq5dam.thumbnail.319.319.png的资产

  3. 重写器将转换指向包含JWS签名的CDN URL的链接：

    CDN_domain/content/dam/geometrixx-media/articles/paladin_trailer.jpg/_jcr_content/renditions/cq5dam.thumbnail.319.319.png?cdn_sign=JWS_SIGNATURE

  4. 然后，用户的浏览器将资产请求转发到CDN服务器

  5. 应将CDN配置为将请求与cdn_sign参数一起转发到AEM。

  6. 身份验证处理程序将验证cdn_sign参数并将资产返回到CDN，然后将资产交付给用户

用户的浏览器、CDN和AEM之间的流量可以如下所示。

chlimage_1-118

注意

当前仅为AEM创作实例启用此功能。

​​CDNonfigServiceImpl提供CDN配置

通过在com.adobe.cq.cdn.rewriter.impl.CDNConfigServiceImpl的配置中提供​CDN分发域名，可以启用CDN重写功能。

该服务还包含其他配置选项，例如启用/禁用CDN重写、执行CDN重写的路径前缀、TTL值和协议（HTTP或HTTPS）。

​​CDNRewriter — 用于将内部图像URL重写到CDN URL的重写器

可以定义com.adobe.cq.cdn.rewriter.impl.CDNRewriter中的​标记属性​值，以便只重写选择性图像链接。

在此页面上