confluence 4.2 升级至 6.10.x 记录

confluence 4.2 升级至 6.10.x 记录

首先将线上环境中的 confluence 安装目录、数据目录以及数据库进行备份,相关信息如下:

  • 安装目录:/opt/atlassian/confluence
  • 数据目录:/opt/confluencedata
  • 数据库:confluence_smc

具体升级过程如下:

一、修改 confluence 服务应用程序目录

由于公司 confluence 服务 4.2 版本安装时,将应用程序目录移动至 webapps 目录下,导致升级时会无法识别到安装路径,所以需要修改应用程序路径,步骤如下:

首先停止 confluence 服务,将 webapps 目录下的 wiki 目录移动到安装目录的根目录下,并重命名为 confluence:

mv /opt/atlassian/confluence/webapps/wiki /opt/atlassian/confluence/confluence

修改 server.xml 文件,将 docBase 修改为如下内容:

<Context path="" docBase="../confluence" debug="0" reloadable="false" useHttpOnly="true">

修改完成后重新启动 confluence 服务验证访问,此时直接输入 IP:端口 即可

/opt/atlassian/confluence/bin/startup.sh

二、修改数据库配置

1. 修改字符集和排序

由于公司当前使用的 confluence 服务的数据库字符集为 utf8,并且未指定排序方式。为了保证后面跨版本升级时新的数据库结构能够正常同步,首先需要对数据库中的默认字符集和排序方式进行修改,修改步骤如下:

  1. 由于涉及修改的数据量比较大,首先设置忽略外键约束,避免修改时报错:
SET FOREIGN_KEY_CHECKS=0;
  1. 修改数据库默认字符集和排序,命令如下:
ALTER DATABASE confluence_smc CHARACTER SET utf8 COLLATE utf8_bin;
  1. 修改数据库中所有表的字符集和排序,命令如下:
SELECT CONCAT('ALTER TABLE `',  table_name, '` CHARACTER SET utf8 COLLATE utf8_bin;')
FROM information_schema.TABLES AS T, information_schema.`COLLATION_CHARACTER_SET_APPLICABILITY` AS C
WHERE C.collation_name = T.table_collation
AND T.table_schema = 'confluence_smc'
AND
(
    C.CHARACTER_SET_NAME != 'utf8'
    OR
    C.COLLATION_NAME != 'utf8_bin'
);

上面的命令执行完成后会生成修改所有表的 sql 语句,将这些 sql 复制到数据库内执行即可完成修改

  1. 修改所有数据类型为 varchar 字段的字符集和排序:
SELECT CONCAT('ALTER TABLE `', table_name, '` MODIFY `', column_name, '` ', DATA_TYPE, '(', CHARACTER_MAXIMUM_LENGTH, ') CHARACTER SET utf8 COLLATE utf8_bin', (CASE WHEN IS_NULLABLE = 'NO' THEN ' NOT NULL' ELSE '' END), ';')
FROM information_schema.COLUMNS 
WHERE TABLE_SCHEMA = 'confluence_smc'
AND DATA_TYPE = 'varchar'
AND
(
    CHARACTER_SET_NAME != 'utf8'
    OR
    COLLATION_NAME != 'utf8_bin'
);

上面的命令执行完成后会生成修改所有相关字段的 sql 语句,将这些 sql 复制到数据库内执行即可完成修改

  1. 修改所有数据类型不是 varchar 字段字符集和排序:
SELECT CONCAT('ALTER TABLE `', table_name, '` MODIFY `', column_name, '` ', DATA_TYPE, ' CHARACTER SET utf8 COLLATE utf8_bin', (CASE WHEN IS_NULLABLE = 'NO' THEN ' NOT NULL' ELSE '' END), ';')
FROM information_schema.COLUMNS 
WHERE TABLE_SCHEMA = 'confluence_smc'
AND DATA_TYPE != 'varchar'
AND
(
    CHARACTER_SET_NAME != 'utf8'
    OR
    COLLATION_NAME != 'utf8_bin'
);

上面的命令执行完成后会生成修改所有相关字段的 sql 语句,将这些 sql 复制到数据库内执行即可完成修改

  1. 设置开启外键约束:
SET FOREIGN_KEY_CHECKS=1;

2. 修改数据库配置文件

检查数据库的配置文件,在 [mysqld] 下面添加如下配置项:

character-set-server=utf8
collation-server=utf8_bin
default-storage-engine=INNODB
max_allowed_packet=256M
max_connections=1000
innodb_log_file_size=2GB
transaction-isolation=READ-COMMITTED
binlog_format=row

如果当前数据库中只有 confluence 一个业务,可以参考如上配置,如果有其他业务共用,为了避免影响其他业务,可以考虑将字符集和引擎设置忽略(可在程序连接数据库时在 jdbc 连接中指定)。

如果数据库配置文件中有如下配置,需要将其删除,否则会引发报错。如果还开启了其他的 sql_mode ,只需要删除 NO_AUTO_VALUE_ON_ZERO 即可:

sql_mode = NO_AUTO_VALUE_ON_ZERO

如果开启了 NO_AUTO_VALUE_ON_ZERO 则会引发如下报错内容:

2020-08-14 09:26:06,520 ERROR [http-8090-4] [atlassian.event.internal.EventPublisherImpl] invokeListeners There was an exception thrown trying to dispatch event 'com.atlassian.confluence.event.events.content.comment.CommentCreateEvent[[email protected]7b33]' from the invoker 'co[email protected]25695aa2'.
 -- url: /rest/tinymce/1/content/524379/comment | userName: admin| referer: //<confluence-url>/pages/viewpage.action?pageId=524379
java.lang.RuntimeException: java.lang.reflect.UndeclaredThrowableException
        at com.atlassian.event.internal.SingleParameterMethodListenerInvoker.invoke(SingleParameterMethodListenerInvoker.java:50)
        at com.atlassian.event.internal.AsynchronousAbleEventDispatcher$2.run(AsynchronousAbleEventDispatcher.java:60)
        at com.atlassian.event.internal.AsynchronousAbleEventDispatcher$1.execute(AsynchronousAbleEventDispatcher.java:28)
.....
Caused by: java.lang.reflect.UndeclaredThrowableException
        at $Proxy943.createOrUpdate(Unknown Source)
        at sun.reflect.GeneratedMethodAccessor1033.invoke(Unknown Source)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
.....
Caused by: java.lang.reflect.InvocationTargetException
        at sun.reflect.GeneratedMethodAccessor1033.invoke(Unknown Source)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
        at java.lang.reflect.Method.invoke(Unknown Source)
        at com.atlassian.mywork.client.service.ServiceSelectorImpl$3.invoke(ServiceSelectorImpl.java:144)
        ... 235 more
Caused by: java.lang.NullPointerException
        at net.java.ao.EntityManager$CacheKey.hashCode(EntityManager.java:1070)
        at java.util.HashMap.getEntry(Unknown Source)
        at java.util.LinkedHashMap.get(Unknown Source)
        at net.java.ao.EntityManager.getFromCache(EntityManager.java:247)
        at net.java.ao.EntityManager.peer(EntityManager.java:234)
        at net.java.ao.EntityManager.peer(EntityManager.java:299)
        at net.java.ao.EntityManager.create(EntityManager.java:411)
......

配置完成后重启数据库服务。

3. 修改 confluence 数据库配置文件

confluence 数据库配置文件存储在 confluence 家目录下,文件名称为 confluence.cfg.xml,将其中的 hibernate.connection.url 配置项进行修改:

<property name="hibernate.connection.url">jdbc:mysql://IP:3306/confluence_smc?sessionVariables=storage_engine%3DInnoDB</property>

<!--  将以上内容修改为如下( 添加&amp;useUnicode=true&amp;characterEncoding=utf8 )-->
<!--  添加这部分内容是由于数据库中字符集和排序已经修改为 utf8,如果不添加这部分配置会导致升级 5.x 版本时无法同步新的数据库结构,导致表缺失 -->

<property name="hibernate.connection.url">jdbc:mysql://IP:3306/confluence_smc?sessionVariables=storage_engine%3DInnoDB&amp;useUnicode=true&amp;characterEncoding=utf8</property>

需要注意的是,如果使用 mysql 5.7 版本,也需要将其中的 storage_engine 修改为 default_storage_engine

三、升级至 confluence 4.3.7 版本

confluence 4.X 中能升级的最大版本是 v4.3.7,所以先将 wiki 升级至 4.3.7 版本,步骤如下:

将原 wiki 服务进程停止,下载 4.3.7 版本安装包至 /opt 目录下,下载链接://www.atlassian.com/software/confluence/downloads/binary/atlassian-confluence-4.3.7-x64.bin

执行该二进制文件进行升级:

[[email protected] opt]# ./atlassian-confluence-4.3.7-x64.bin
Unpacking JRE ...
Starting Installer ...

This will install Confluence 4.3.7 on your computer.
OK [o, Enter], Cancel [c]

Choose the appropriate installation or upgrade option.
Please choose one of the following:
Express Install (uses default settings) [1], Custom Install (recommended for advanced users) [2], Upgrade an existing Confluence installation [3, Enter]							# 选择升级 confluence

Existing installation directory:
[/opt/atlassian/confluence]						   # 指定 confluence 的安装路径

Back Up Confluence Home
The upgrade process will automatically back up your Confluence Installation
Directory. You can also choose to back up your existing Confluence Home
Directory. Both directories are backed up as zip archive files in their
respective parent directory locations.

We strongly recommend choosing this option in the unlikely event that you
experience problems with the upgrade and may require these backups to
restore your existing Confluence installation.

If you have many attachments in your Confluence Home Directory, the zip
archive of this directory may consume a significant amount of disk space.
Back up Confluence home ?
Yes [y, Enter], No [n]							 # 备份 confluence 的家目录,如果此前已经做过备份,此处可选择 No
n

Checking for local modifications.

List of modifications made within Confluence directories.

The following provides a list of file modifications within the confluence
directory.

Modified files:
	confluence/WEB-INF/lib/atlassian-extras-2.4.jar
Removed files:
	(none)
Added files:
	(none)

[Enter]


Checking if your instance of Confluence is running
Upgrade Check List
Back up your external database
We strongly recommend you back up your Confluence database if you have not
already done so.

Please refer to the following URL for back up guidelines:
//docs.atlassian.com/confluence/docs-43/Production+Backup+Strategy

Check plugin compatibility
Check that your non-bundled plugins are compatible with Confluence 4.3.7.

For more information see our documentation at the following URL:
//docs.atlassian.com/confluence/docs-43/Installing+and+Configuring+Plugins+using+the+Universal+Plugin+Manager


Please ensure you have read the above checklist before upgrading.
Your existing Confluence installation is about to be upgraded! Do you want to proceed?
Upgrade [u, Enter], Exit [e]


Your instance of Confluence is currently being upgraded.
Checking if Confluence has been shutdown...
Backing up the Confluence installation directory

Deleting the previous Confluence installation directory...

Extracting files ...


Please wait a few moments while Confluence starts up.
Launching Confluence ...
Installation of Confluence 4.3.7 is complete
Your installation of Confluence 4.3.7 is now ready and can be accessed via
your browser.
Custom modifications
Your previous Confluence installation contains customisations that must be
manually transferred. Refer to our documentation more information:
//docs.atlassian.com/confluence/docs-43/Upgrading+Confluence#UpgradingConfluence-custommodifications
Confluence 4.3.7 can be accessed at //localhost:8090

Confluence 4.3.7 may take several minutes to load on first start up.
Finishing installation ...

升级完成后,将 /opt/atlassian/confluence/confluence/WEB-INF/lib 目录下的 atlassian-extras-2.4.jar 文件拷贝到办公电脑桌面上,使用破解工具包 confluence_keygen.jar 对其进行破解。

注:由于 confluence_keygen.jar 使用的图形化界面,所以需要在支持图形化界面的电脑上执行该程序,同时电脑中需要提前安装 jdk。对 atlassian-extras-2.4.jar 破解时直接点击 patch 按钮即可,不需要输入名称和 ID。

将破解后的 atlassian-extras-2.4.jar 上传到服务器的 /opt/atlassian/confluence/confluence/WEB-INF/lib 目录下并替换原文件,重新启动 confluence 服务,启动命令如下:

/opt/atlassian/confluence/bin/startup.sh

启动完成后访问页面,如果页面正常访问且数据完整,则升级完成。

四、升级至 5.10.9 版本

升级至 4.3.7 版本后,就可以直接升级至 5.10.9 版本,5.10.9 版本下载链接://www.atlassian.com/software/confluence/downloads/binary/atlassian-confluence-5.10.9-x64.bin

将下载后的安装包上传到 /opt 目录下,停止 wiki 服务,按照升级 4.3.7 的方式执行升级程序。

如果在执行升级程序时,报如下错误:

Could not display the GUI. This application needs access to an X Server.

这代表系统中缺少 dejavu-sans-fonts 软件包,使用如下命令安装即可:

yum install -y dejavu-sans-fonts

升级完成后,将 /opt/atlassian/confluence/confluence/WEB-INF/lib 目录下的 atlassian-extras-decoder-v2-3.2.jar 文件拷贝到办公电脑桌面上,并将其重命名为 atlassian-extras-2.4.jar,使用破解工具包 confluence_keygen.jar 对其进行破解。

将破解后的文件重命名回 atlassian-extras-decoder-v2-3.2.jar,并上传至原目录下。重新启动 confluence 服务。

启动完成后访问页面,如果页面正常访问且数据完整,则升级完成。

五、升级至 6.15.9 版本

6.15.9 版本下载链接://www.atlassian.com/software/confluence/downloads/binary/atlassian-confluence-6.15.9-x64.bin

将下载后的安装包上传到 /opt 目录下,停止 wiki 服务,按照升级 5.10.9 的方式执行升级程序。

升级完成后,将 /opt/atlassian/confluence/confluence/WEB-INF/lib 目录下的 atlassian-extras-decoder-v2-3.4.1.jar 文件拷贝到办公电脑桌面上,并将其重命名为 atlassian-extras-2.4.jar,使用破解工具包 confluence_keygen.jar 对其进行破解。

将破解后的文件重命名回 atlassian-extras-decoder-v2-3.4.1.jar,并上传至原目录下。重新启动 confluence 服务。

启动完成后访问页面,如果页面正常访问且数据完整,则升级完成。

六、修改访问路径

原 confluence 将程序主目录放置在 /opt/atlassian/confluence/webapps 目录下,而新的 confluence 服务的程序主目录是在 /opt/atlassian/confluence 目录下,所以为了确保升级前的链接地址可以正常访问升级后的服务,需要做如下修改:

  1. 将 /opt/atlassian/confluence 目录下的 confluence 主程序目录移动至 /opt/atlassian/confluence/webapps 目录下,并重命名为 wiki

  2. 修改 /opt/atlassian/confluence/conf 目录下的 server.xml 文件,将其中指定程序主目录的配置进行修改:

<Context path="" docBase="../confluence" debug="0" reloadable="false" useHttpOnly="true">
    
<!-- 将上面的配置修改为如下内容 -->
    
<Context path="" docBase="" debug="0" reloadable="false" useHttpOnly="true">
    
<!-- 配置 docBase 部分为空,tomcat 启动时会自动到 webapps 目录下寻找项目启动 -->
  1. 重启 confluence 服务,此时就可以使用原访问地址//smc.sohuno.com/wiki 进行访问。

七、处理预览文件显示乱码的问题

官方处理文档//confluence.atlassian.com/confkb/the-text-in-a-powerpoint-excel-or-word-document-looks-different-when-using-the-viewfile-macro-200213562.html#TheTextinaPowerPoint,ExcelorWordDocumentisMissingorLooksDifferentwhenUsingtheViewfileMacro-InstallingMicrosoftFonts

confluence 6 版本添加了文件预览的功能,如果系统中缺少字符集,预览的时候会显示乱码,解决办法如下:

首先在操作系统中创建如下目录(CentOS 系统):

mkdir -p /usr/share/fonts/msttcore/

找一台 Windows 系统的电脑,将 C:\Windows\Fonts 目录下的所有字体文件打包,上传到 /usr/share/fonts/msttcore 目录下。

在 /opt/atlassian/confluence/bin 目录下(安装目录),编辑 setenv.sh 脚本,在 CATALINA_OPTS 部分添加如下内容:

CATALINA_OPTS="-Dconfluence.document.conversion.fontpath=/usr/share/fonts/msttcore/ ${CATALINA_OPTS}"

在 /opt/confluencedata 目录下删除如下内容(数据目录):

rm -rf /opt/confluencedata/viewfile/*
rm -rf /opt/confluencedata/thumbnails/*
rm -rf /opt/confluencedata/shared-home/dcl-document/*
rm -rf /opt/confluencedata/shared-home/dcl-document_hd/*
rm -rf /opt/confluencedata/shared-home/dcl-thumbnail/*

重启 confluence 服务即可。

八、处理验证码不显示的问题

confluence 默认在登录失败超过 3 次就会开启验证码认证,如果出现验证码完全不显示,有可能是字符编码的问题,一般日志中会有如下报错:

2020-09-05 15:01:27,053 ERROR [http-8090-1] [[Standalone].[localhost].[/].[jcaptcha]] log Servlet.service() for servlet jcaptcha threw exception
com.octo.captcha.CaptchaException: word is too tall: try to use less letters, smaller font or bigger background:  text bounds = {text=tasble

在 /opt/atlassian/confluence/bin 目录下(安装目录),编辑 setenv.sh 脚本,在 CATALINA_OPTS 部分添加如下内容:

 CATALINA_OPTS="-Dfile.encoding=UTF-8"

在系统中安装如下软件(一般情况下都是默认安装好的):

yum -y install deja*

重启 confluence 即可。

如果只是部分验证码不显示(刷新多次,偶现验证不显示的情况),可能是由于缺失字体导致的,暂未找到解决办法,可以先关闭验证码功能。

九、处理升级 confluence 后无法创建页面的问题

官方处理文档:

confluence 升级至 6.15.10 版本后,创建空间或页面会显示如下报错:

该文件的加载时间比平时要长。请稍等片刻,然后尝试刷新

页面会一直卡在刷新的界面中,经过排查,可以确定是由于 confluence 新增的协同编辑功能导致的。

协同编辑是通过 Synchrony 进行的,Synchrony 在默认的情况下是运行在 8091 端口的。这个能够实时的同步数据。Synchrony 是一个可执行的进程,这个进程是在 Confluence 之外运行的,但是又是由 Confluence 自动进行管理的。

如果没有在 confluence 中使用反向代理 ,那么会通过 Confluence 的内部 Synchrony 代理连接到 Synchrony。

如果 confluence 是运行在一个反向代理的后面的,那么就需要在反向代理中添加针对 Synchrony 服务 ws 请求的代理配置。例如当前使用 NGINX 作为反向代理,那么在 NGINX 中添加如下配置(与 confluence 在同一个 server 段):

location /synchrony {
		proxy_set_header X-Forwarded-Host $host;
		proxy_set_header X-Forwarded-Server $host;
		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
		proxy_pass //IP:8091/synchrony;
		proxy_http_version 1.1;
		proxy_set_header Upgrade $http_upgrade;
		proxy_set_header Connection "Upgrade";
}

接下来修改 /opt/atlassian/confluence/conf 目录下的 server.xml 文件,在其中配置 tomcat 连接器:

<Connector port="8090" connectionTimeout="20000" redirectPort="8443"
		   maxThreads="48" minSpareThreads="10"
		   enableLookups="false" acceptCount="10" debug="0" URIEncoding="UTF-8"
		   protocol="org.apache.coyote.http11.Http11NioProtocol"
		   proxyName="smc.sohuno.com" proxyPort="80" schema="http"/>

修改完成后重启 confluence 服务即可。

或者直接在 confluence 的设置中将协同编辑功能关闭,也可以解决该问题。