关于插件
插件是一个 .jar 文件(包含代码、资源和配置文件),可以安装到 Atlassian 产品中以添加新功能或更改现有功能的行为。
您可以使用插件以多种方式自定义和扩展 JIRA 的功能,包括:
JIRA 附带了许多预安装的插件,还有更多可以从Atlassian Plugin Exchange下载。您还可以创建自己的插件。请访问JIRA 开发人员文档以获取有关构建插件的信息。
可以使用通用插件(与 JIRA 捆绑)启用或禁用已安装的 JIRA 插件,如下所述。
每个插件都由一个或多个插件模块组成。一个插件可以做很多事情,每个模块代表插件的一个功能。可以启用或禁用单个模块,但不建议这样做,因为模块通常可以相互依赖。要安全地做到这一点,需要了解模块相互依赖关系。
在本页面:
此页面上描述的某些功能在 JIRA OnDemand中受到限制。
关于“版本 1”插件和“版本 2”插件
Atlassian 插件有两种类型:
- “版本 1”插件——这些插件与 JIRA 4.0 版之前使用的“旧”插件框架兼容,也与 JIRA 4.0 版及更高版本中使用的“新”插件框架兼容。“版本 1”插件安装在JIRA 安装目录下
atlassian-jira/WEB-INF/lib/
。“版本 1”插件必须手动安装(见下文)并手动卸载(见下文)。 - “版本 2”插件——这些插件与 JIRA 4.0 及更高版本中使用的“新”插件框架兼容。使用 JIRA 管理界面(见下文)自动安装“版本 2”插件。它们安装在JIRA 主目录下。“版本 2”插件部署在内部OSGi容器中,以将插件与核心代码和其他插件隔离,并允许复杂的依赖管理。'版本 2' 插件必须使用插件配置文件 ( ) 中的属性明确声明。
plugins/installed-plugins/
plugins-version="2"
atlassian-plugin.xml
如何判断插件是“版本 1”还是“版本 2”?
转到https://plugins.atlassian.com并查看插件的详细信息。“插件系统”字段将显示版本 1 插件的“一个”和版本 2 插件的“两个”。
安装 JIRA 插件
从 Atlassian Plugin Exchange 安装插件
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 系统管理员 全局权限的用户身份登录。
- 选择“管理”>“插件”>“插件”。将显示通用插件管理器,显示安装在您的 JIRA 站点上的插件。
键盘快捷键:'g' + 'g' +开始输入'plugins'
要从 Atlassian 插件交换中查找和添加插件:
- 单击UPM 中的安装选项卡。您将看到精选插件列表。
- 按如下方式搜索您的插件:
- 在Search the Plugin Exchange搜索框中输入一些描述插件的关键字,然后按 Enter。
- 或者,浏览到列表中所需的插件。您可以从插件中选择Featured 、 Popular 、 Supported ( by Atlassian)或All available以显示下拉列表以查看不同的插件列表。
- 单击所需插件的安装按钮以将其添加到您的应用程序中。成功安装插件后,将显示确认消息和插件详细信息。
注意:您可能需要重新启动应用程序才能使更改生效。如果是这种情况,通用插件管理器会通知您。
注意:并非所有插件都可以自动安装。有些需要手动安装。这些插件将有一个下载按钮而不是安装按钮。在这些情况下,您应该阅读并遵循插件的安装说明。
屏幕截图:从 Atlassian Plugin Exchange 查找新插件
安装自己的插件
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 系统管理员 全局权限的用户身份登录。
- 选择“管理”>“插件”>“插件”。将显示通用插件管理器,显示安装在您的 JIRA 站点上的插件。
键盘快捷键:'g' + 'g' +开始输入'plugins'
要上传您自己的插件:
- 单击UPM 中的安装选项卡。
系统显示特色插件列表。 - 单击上传插件链接。
系统显示上传插件窗口。 - 指定插件的位置:
- 如果您要安装的插件在您的计算机上,请使用“浏览”对话框选择插件 JAR 文件。
- 如果要从远程位置安装插件,请在From this URL文本框中输入插件 JAR 文件的 URL。
- 单击上传按钮以上传并启用您的插件。成功安装插件后,将显示一条确认消息。
注意:您可能需要重新启动应用程序才能使更改生效。如果是这种情况,通用插件管理器会通知您。
截图:上传新插件
手动安装插件
如果出现以下情况,您将需要手动安装插件:
- 您正在安装“版本 1 ”插件;或者
- 您的 JIRA 服务器无法访问互联网(在这种情况下,通用插件管理器将无法访问http://plugins.atlassian.com)。
下载或创建插件 jar 文件后,请按照以下步骤将其安装到 JIRA 实例中:
- 关闭 JIRA。
- 将您的插件 jar(例如“ EXAMPLE_PLUGIN.jar ”)复制到相应的插件目录中:
- 如果您正在安装“版本 1 ”插件,请将 jar 复制到JIRA 安装目录下的
atlassian-jira/WEB-INF/lib/
. - 如果您要安装“版本 2 ”(OSGi)插件,请将 jar 复制到JIRA 主目录下的
plugins/installed-plugins/
.
要确定插件是版本 1 还是版本 2,请查看Plugin Exchange。请注意,插件有不同的版本,旧版本的插件可能是版本 1。
- 如果您正在安装“版本 1 ”插件,请将 jar 复制到JIRA 安装目录下的
- 启动 JIRA。
- 转到“管理”>“插件”>“插件”。您的插件(例如“ EXAMPLE_PLUGIN ”)将被列出并启用。
如果将“版本 1”插件的 JIRA jar 文件复制到“版本 2”插件的安装目录中(反之亦然),JIRA 会提供警告,指示插件已安装到错误的目录中。
但是,可能有极少数“版本 1”插件(例如JIRA RPC 插件)在意外安装到“版本 2”插件目录 ( <JIRA home directory>/plugins/installed-plugins/
) 时不会生成此警告。尽管如此,该插件将无法正常运行,并且 JIRA 管理“插件”页面通常表明该插件有零个模块。
要解决此问题,请通过以下方式将插件 jar 重新安装到正确的目录:
- 关闭 JIRA,
- 将插件 jar 文件移动到
<JIRA installation directory>/atlassian-jira/WEB-INF/lib/
- 重新启动 JIRA。
查看已安装的插件
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 管理员 全局权限的用户身份登录。
- 选择管理。
系统显示管理页面。 - 从插件部分中选择插件。通用插件管理器出现。键盘快捷键:g + g +开始输入插件
屏幕截图:使用通用插件管理器查找已安装的 JIRA 插件
如果您没有 JIRA 系统管理员全局权限,某些选项卡将不可见
更新 JIRA 插件
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 系统管理员 全局权限的用户身份登录。
- 选择“管理”>“插件”>“插件”。将显示通用插件管理器,显示安装在您的 JIRA 站点上的插件。
键盘快捷键:'g' + 'g' +开始输入'plugins'
要升级插件:
- 单击管理我的插件选项卡。您将在“可用更新”标题下看到可升级的插件列表。
- 如果您已经安装了更高版本的插件,此页面将显示该插件的最新兼容版本。
- 您可以单击插件名称以展开该行并查看有关该插件的更多信息。
- 您可以通过在过滤可见插件文本框中输入关键字来过滤您的列表。
- 单击要升级的插件的名称,以查看有关该插件的更多信息。
- 单击插件旁边的更新按钮将其更新到显示的版本。
升级所有可用插件:
- 单击管理我的插件选项卡。您将在“可用更新”标题下看到可升级的插件列表。
- 如果您已经安装了更高版本的插件,此页面将显示该插件的最新兼容版本。
- 您可以单击插件名称以展开该行并查看有关该插件的更多信息。
- 您可以通过在过滤可见插件文本框中输入关键字来过滤您的列表。
单击全部更新按钮将每个插件升级到显示的插件版本。
注意:并非所有插件都可以通过通用插件管理器安装或升级。有些插件必须手动安装和升级。
禁用 JIRA 插件
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 管理员 全局权限的用户身份登录。
- 选择管理。
系统显示管理页面。 - 从插件部分中选择插件。通用插件管理器出现。键盘快捷键:g + g +开始输入插件
要禁用插件:
- 单击管理现有选项卡。您将看到应用程序中安装的插件列表。启用的插件将具有此图标:
- 找到要禁用的插件,然后单击标题以展开插件详细信息部分。
- 单击禁用按钮。
- 禁用插件后,您可能需要重新启动应用程序才能使更改生效。如果是这样,您将看到插件的消息Disabled, requires restart。
插件完全禁用后,您将看到插件的启用链接。
另请注意,如果插件在启动或初始化时导致错误,JIRA 可以自动禁用它们。这通常是由于旧版本的插件与您当前版本的 JIRA 不兼容造成的。如果发生这种情况,它将在“当前插件”页面上显示(如上所示)。您需要停止 JIRA,安装更新版本的插件并重新启动 JIRA。
启用 JIRA 插件
注意:默认启用新安装的插件。
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 管理员 全局权限的用户身份登录。
- 选择管理。
系统显示管理页面。 - 从插件部分中选择插件。通用插件管理器出现。键盘快捷键:g + g +开始输入插件
要启用插件:
- 单击管理现有选项卡。您将看到应用程序中安装的插件列表。禁用的插件将具有此图标:
- 找到您要启用的插件,然后单击标题以展开插件详细信息部分。
- 单击启用按钮。
- 启用插件后,您可能需要重新启动应用程序才能使更改生效。如果是这样,您将看到插件的消息Enabled, requires restart。
插件完全禁用后,您将看到插件的禁用链接。
禁用/启用所有用户安装的插件(安全模式)
在安全模式下运行 JIRA 会立即禁用所有用户安装的插件。进入安全模式时禁用的所有插件将在退出安全模式时重新启用。
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 管理员 全局权限的用户身份登录。
- 选择管理。
系统显示管理页面。 - 从插件部分中选择插件。通用插件管理器出现。键盘快捷键:g + g +开始输入插件
要启用安全模式:
- 单击管理现有选项卡。
系统显示已安装插件的列表。 - 单击启用安全模式链接。
- 单击确认窗口中的继续按钮。
所有用户安装的插件都将被禁用,您的应用程序现在将以安全模式运行。 - 根据需要对已安装的插件进行更改。
例如,您可能想要启用/禁用特定插件或插件模块。 - 通过单击安全模式横幅中的链接之一退出安全模式:
- 单击退出安全模式并恢复以前的配置以将您的插件配置恢复到进入安全模式之前的状态。
- 单击退出安全模式并保留当前配置以保留在安全模式期间对插件配置所做的所有更改。
卸载 JIRA 插件
注意:如果您只想暂时删除一个插件,您可能希望禁用它而不是卸载它。
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 系统管理员 全局权限的用户身份登录。
- 选择“管理”>“插件”>“插件”。将显示通用插件管理器,显示安装在您的 JIRA 站点上的插件。
键盘快捷键:'g' + 'g' +开始输入'plugins'
要卸载插件:
- 单击管理现有选项卡。
系统会列出您的应用程序中安装的插件。 - 单击要卸载的插件的名称。
系统显示插件详细信息。 - 单击卸载按钮。
信息摘要显示卸载消息并从您的应用程序中卸载插件。
手动卸载“版本 1”插件
- 关闭 JIRA。
- 从相应的插件目录中删除您的插件 jar(例如“EXAMPLE_PLUGIN.jar”):
- 如果要删除“版本 1”插件,请从 atlassian-jira/WEB-INF/lib/ 下的 JIRA 安装目录中删除 jar。
- 如果要删除“版本 2”(OSGi) 插件,请从插件/已安装插件/ 下的 JIRA 主目录中删除 jar。
- 启动 JIRA。
- 转到“管理 > 插件”。您的插件(例如“EXAMPLE_PLUGIN”)将不再列出。
配置 JIRA 插件
许多插件具有高级配置选项,例如,一个插件可能包含多个您可以启用/禁用的“模块”。如果您在应用程序实例上安装了这些插件之一,则可以通过通用插件管理器 (UPM)查看和更新这些配置选项。
要访问 JIRA 中的通用插件管理器:
- 以具有JIRA 管理员 全局权限的用户身份登录。
- 选择管理。
系统显示管理页面。 - 从插件部分中选择插件。通用插件管理器出现。键盘快捷键:g + g +开始输入插件
配置插件:
- 单击管理现有选项卡。
- 找到您要配置的插件并单击其标题。
插件详细信息部分展开。 单击该插件的配置按钮。
出现高级配置选项。如果插件被禁用,则无法对其进行配置,因此不会出现“配置”按钮。如果插件没有高级配置选项,则没有配置按钮。
- 根据需要更新配置设置并保存更改。
注意:插件本身提供了高级配置选项。如果您在单击配置按钮后遇到任何问题,则由插件负责,而不是 UPM。