2 Apache Tomcat の設定

2.1 HTTP コネクタの設定

Version 1.6.0 よりBacklogを利用するためにはTomcatの HTTP コネクタの設定が必須となりました。これまで、AJP コネクタのみを利用していた場合、ご利用の Tomcat のバージョンにあわせて、HTTP コネクタの設定を追加してください。

またその設定ファイル「server.xml」の「Connector」の属性に「URIEncoding="UTF-8"」を追加する必要があります。1.5 まで利用していた「useBodyEncodingForURI="true"」という設定は 削除してください。削除しない場合には全文検索機能が正常に動作しません。

以下は、Tomcat 7.0 での HTTP コネクタの設定例です。

<Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" URIEncoding="UTF-8"/>

もし AJP コネクタを併用する場合には、そちらも上記同様「useBodyEncodingForURI="true"」の設定があれば削除し「URIEncoding="UTF-8"」を追加してください。

2.2 Java 起動オプションの設定

全文検索機能のために、Tomcat の Java の起動オプションとして「-Dsolr.solr.home=<全文検索用のディレクトリのパス>」を追加する必要があります。

ここで指定する全文検索用のディレクトリのパスは、アップデータ起動時の現在インストールされているBacklogの設定確認画面にある「Backlog 作業パス」に「/solr」を追加したものとなります。例えば、指定されているパスが「/var/lib/backlog」の場合は以下のようになります。

  • -Dsolr.solr.home=/var/lib/backlog/solr

また、Wiki 名に "/" を含む場合にも正しく表示させるために、下記のオプションを指定します。

  • -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true

値の設定方法はご利用環境にあわせた形となります。例として <Tomcat のインストールディレクトリ>/bin/catalina.sh を利用する場合には、同じディレクトリに setenv.sh というファイルを作成し、以下のように環境変数 CATALINA_OPTS にて指定してください。(既にある場合は追記してください)

export CATALINA_OPTS="-Dsolr.solr.home=/var/lib/backlog/solr -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true"

2.3 全文検索機能の依存ライブラリの設定

Version 1.8.0 以降、全文検索機能を利用するための依存ライブラリを Tomcat に追加しておく必要があります。
下記ダウンロードリンクから、依存ライブラリをまとめたファイルをダウンロードして、<Tomcat のインストールディレクトリ>/lib にコピーしてください。

https://www.backlog.jp/package/doc/standard/solr-ext.zip

# wget https://www.backlog.jp/package/doc/standard/solr-ext.zip
# unzip solr-ext.zip
# cp solr-ext/* /usr/local/apache-tomcat/lib/

また、コピーしたファイルの中にログ出力を制御する log4j.properties があります。
log4j.properties 中のログ出力ディレクトリの設定を、ご利用環境に合わせて <Tomcat のインストールディレクトリ>/logs に変更してください。

solr.log=/usr/local/apache-tomcat/logs/

3 アップデート

3.1 Backlogパッケージアーカイブのダウンロードと展開

ご購入時にお知らせしましたダウンロードサイトにアクセスします。アクセスにはユーザ名・パスワードが必要です。

images/thumb/backlog_download.jpg

上記よりアップデート用のBacklogパッケージアーカイブがダウンロードできます。ダウンロード完了後、適当な場所に展開してください。

  • 例:「/tmp」ディレクトリに展開する場合
    # cd /tmp
    # tar zxfv backlog-updater-1.10.0.tar.gz

3.2 データベースドライバのダウンロード (MySQLの場合のみ)

データベースにMySQLを使用する場合、データベースドライバをダウンロードする必要があります。下記URLのダウンロードサイトより「Platform Independent (Architecture Independent), ZIP」の最新バージョンをダウンロードし、展開します。

http://dev.mysql.com/downloads/connector/j/

画面:MySQLドライバのダウンロードサイト

展開したファイルの「mysql-connector-java-XXX-bin.jar」を、Backlogパッケージアーカイブを展開したディレクトリにコピーしてください。

# unzip mysql-connector-java-5.1.42.zip
# cp mysql-connector-java-5.1.42/mysql-connector-java-5.1.42-bin.jar /tmp/backlog-1.10.0/

3.3 アップデータの起動

Backlogアップデートアーカイブに同封しているアップデータを使用して、Backlogアプリケーションのアップデートを行います。

Backlogアップデートアーカイブを展開したディレクトリに移動してアップデータの起動を行ってください。

※ 事前に必ずデータベースのバックアップとTomcatの停止を行ってください ※

※ 1.4.0 以前 (2011年7月11日以前) からご利用のお客様が、現在のご利用バージョンにかかわらず 1.7.0 以降にアップデートする場合、
  追加でデータベースの変更作業が必要です。お手数ですが詳細は support@backlog.jp までご連絡ください。

# java -jar backlog-updater.jar
バックログ アップデータを起動します。
しばらくお待ちください。

**********************************************************************
**********************************************************************
*******************************

Tomcatの停止の確認及び、データベースのバックアップを確認するメッセージが表示されます。

問題なければ、アップデート処理を始めてください。

======================================================================
   Backlog updater
    ____             _    _
   |  _ \           | |  | |
   | |_) | __ _  ___| | _| | ___   __ _
   |  _ < / _` |/ __| |/ / |/ _ \ / _` |
   | |_) | (_| | (__|   <| | (_) | (_| |
   |____/ \__,_|\___|_|\_\_|\___/ \__, |
                                   __/ |
                                  |___/  to the Version: 1.10.0

                                         [http://www.backlog.jp]
======================================================================

バックログのアップデートを開始します。

アップデータ起動タイトル表示され、アップデートが開始します。
メッセージ中に表示される[]の値は、未入力時に既定値として設定されます。

Backlogをインストールしているディレクトリを絶対パスで指定してください

Backlogアプリケーションがインストールされているディレクトリを絶対パスで指定してください。
(Backlogで使用しているTomcatのインストール先が/usr/local/apache-tomcatの場合、/usr/local/apache-tomcat/webappsを指定します。)

Tomcat の HTTP コネクタのポートを指定してください [8080]

HTTP コネクタの設定で server.xml で指定した HTTP コネクタのポート番号を指定します。

Backlog アップデート先  [/usr/local/apache-tomcat/webapps]
Backlog 作業パス        [/var/lib/backlog]
Backlog URL             [http://localhost:8080]
Tomcat HTTPポート       [8080]
SMTPサーバホスト        [localhost]
データベース            [MySQL]
 サーバホスト          [localhost]
 ポート番号            [3306]
 ユーザ                [backlog]
 パスワード            [backlog]

よろしいですか?
(y <続ける> / n <やめる>
  • 現在インストールされているBacklogの設定確認が行われ「y<続ける>」を選択することでアップデートが行われます。
  • 「n<やめる>」を選択した場合は、アップデートを中止します。

注)1.6.0 より「Backlog 作業パス」以下に、全文検索機能用の solr ディレクトリが作成されます。作成されたディレクトリに対してBacklogを起動するユーザが読み込みと書き込みを行える様にアクセス権限を付与しておいてください。

3.3.1 テーブルの変更

今回のアップデートでデータベースの変更が必要な場合、データベースに対する変更処理を行います。

使用するJDBCドライバを選択してください。
1:mysql-connector-java-5.1.42.jar

データベースでMySQLを使用している場合は、JDBCドライバの選択を行います。
backlog-updater.jarのカレントディレクトリに置かれた、mysql-connector-java-XXX.jarを選択対象として表示します。

データベースの接続検証後、テーブルの変更を行います。

テーブルの変更を開始します。*********************** 終了
テーブルの変更が終了しました。

3.3.2 warのデプロイ

warファイルを配備します >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 終了
正常にアップデートが完了しました。

引き続き Backlogをご利用ください。

デプロイの終了後、アップデート完了メッセージが表示されBacklogのアップデートが完了します。
(アップデート前に配備済みのwarファイルは日付を元に付けられた別名で保存されます。)

Tomcatを再起動して、Backlogに正しく接続できることをご確認ください。

4 アップデートがおわったら

運用に関する情報を、運用ガイドでご確認ください。

  • Linuxは、Linus Torvalds氏の日本およびその他の国における登録商標または商標です。
  • Red Hatは米国およびその他の国におけるRed Hat, Incの登録商標または商標です。
  • OracleとJavaは、Oracle Corporation 及びその子会社、関連会社の米国及びその他の国における登録商標です。文中の社名、商品名等は各社の商標または登録商標である場合があります。
  • その他記載されている会社名および商品名は各社の登録商標または商標です。

Author: Backlog Support <support@backlog.jp>

Date: 2017-06-15 12:31:59 JST