Growi v7.1.x・v.7.2.x→v7.3.0へのアップデート

概要

Growi 7.1/7.2からv7.3.0Growiアップグレードの手順です。
Elasticsearchの全文検索を利用している方は「Elasticsearchのバージョンアップ」を伴う作業になります。

前提

既にgrowi v7.1.x/v7.2.xをインストールしていること。
管理画面トップやトップページ右下からバージョンが7.1.xまたは7.2.xであることを再確認します。
systemdによってサービス化されていること。
具体的な手順はhttps://atelier.reisalin.com/projects/zettel/knowledgebase/articles/105
最新版や安定版がリリースされていることを以下のサイトで確認していること。
https://github.com/growilabs/growi/releases
※設定ファイルの変更やパッケージインストールの変更、nodeのバージョンアップの必要等があれば、それも事前に済ませます。

さっくりはならない手順

Growiをメンテナンスモードにします。
Growi・Elasticsearchのサービスを停止します。
バックアップを取ります。
gitコマンドで最新版をcheckoutします。
アップグレードを行います。
Elasticsearch・Growiのサービスを再開します。
Growiのメンテナンスモードを解除します。
アップグレードされたことを確認します。

メンテナンスモード有効化

Growiに管理者権限でログインします。
管理トップ＞アプリ設定に進み、「メンテナンスモードを開始する」をクリックします。
トップページに戻り「メンテナンスモード」が表示されていることを確認します。

バックアップ

以下をバックアップします。

mongodbの格納データ

cat /etc/mongod.conf |grep dbPath

として、ここのディレクトリ一式を控えます。(筆者環境 /home/mongodb)

このディレクトリを任意の方法でバックアップします。

Growiの添付ファイル一式が納められているディレクトリ（ファイルアップロード先をlocalにしている場合のみ)

/growi/root/directory/apps/app/public

(筆者環境 /home/www-data/growi/apps/app/public)ここも念のためバックアップします。

※ 添付ファイルのアップロード先をAWSやAzureなどにしている場合は不要です

vpsや仮想ゲストの場合はシステム全体：推奨

スナップショット機能などでシステム全体をバックアップした方が確実で安心です。

ElasticsearchとGrowiの停止

Elasticsearchサービス停止

sudo systemctl stop elasticsearch.service

サービス停止確認

systemctl status elasticsearch.service

inactive(dead)を確認します。

Growiサービス停止

sudo systemctl stop growi.service

サービス停止確認

systemctl status growi.service

inactive(dead)を確認します。

作業前バックアップ

データディレクトリを丸ごとコピー (-aオプションでパーミッションを維持)

sudo cp -a /var/lib/elasticsearch/ /path/to/backup/dir/elastic_bk.$(date +%Y%m%d)

自分の環境に合わせます。

バックアップ確認

sudo ls -l /path/to/backup/dir/elastic_bk.$(date +%Y%m%d)

バックアップした内容があることを確認します。(※管理者権限でないとこのディレクトリを見ることはできません)

リポジトリ設定ファイル名をv9用に変更

Elasticsearchのバージョンを指定するリポジトリをv9に変更します。

現行のリポジトリリストをバックアップ

sudo cp -pi /etc/apt/sources.list.d/elastic-8.x.list /path/to/backup/dir/elastic-8.x.list.$(date +%Y%m%d)

リポジトリリストのバックアップ確認

diff -u /path/to/backup/dir/elastic-8.x.list.$(date +%Y%m%d) /etc/apt/sources.list.d/elastic-8.x.list

リポジトリリストの名前変更

sudo mv /etc/apt/sources.list.d/elastic-8.x.list /etc/apt/sources.list.d/elastic-9.x.list

リポジトリリストの名前変更確認

ls -l /etc/apt/sources.list.d/elastic-9.x.list

ファイルがあることを確認します。

sedコマンドでファイル内の参照先を8.xから9.xに書き換え

sudo sed -i 's/8.x/9.x/g' /etc/apt/sources.list.d/elastic-9.x.list

Elasticsearchのアップグレード

パッケージ全体のバックアップ

sudo aptitude update

好みでaptitudeを用いています。必要に応じてaptを用いてください。

Elasticsearchのアップグレード

sudo aptitude upgrade elasticsearch

※ Growiインストール時、/etc/elasticsearch/jvm.optionsファイルなどの設定変更を行っているため、アップグレード時の設定ファイルを残すかどうかの確認では、必ずN（残す）を選択します。

プラグインのアンインストール

Growiに必要なElasticsearchのプラグインは自動更新されません。この処置を執らないとせっかくアップグレードしたのに起動しないという事態が発生します。

sudo /usr/share/elasticsearch/bin/elasticsearch-plugin remove analysis-icu

sudo /usr/share/elasticsearch/bin/elasticsearch-plugin remove analysis-kuromoji

プラグインの再インストール

sudo /usr/share/elasticsearch/bin/elasticsearch-plugin install analysis-icu

sudo /usr/share/elasticsearch/bin/elasticsearch-plugin install analysis-kuromoji

growiディレクトリに移動します

cd /home/www-data/growi && pwd

自分の環境に合わせます。(筆者環境/home/www-data/growi)

リリースタグを確認します。

リリースタグ取得

sudo git fetch --tags

リリースタグ確認

sudo git tag -l

スペースで確認していき、上記リリースサイトと同じバージョンがあることを確認します。

チェックアウトとインストールを行います。

変更を一時的に退避

sudo git stash

チェックアウト

sudo git checkout 【バージョン】

リリースタグは再確認しましょう。

pnpm install

sudo pnpm i

ビルド

sudo npm run app:build

ElasticsearchとGrowiの再開

Elasticsearchサービス開始

sudo systemctl restart elasticsearch.service

サービス開始確認

systemctl status elasticsearch.service

active(running)を確認します。

バージョンアップ確認

curl -X GET "localhost:9200"

"number" : "9.1.3",など、9系にアップグレードされていることを確認します。

Growiサービス開始

sudo systemctl restart growi.service

サービス停止確認

systemctl status growi.service