このページのいちばん上です

Backlog スタンダード 運用ガイド

このページの本文へ

目次

  1. 1 システム要件
  2. 2 バックアップ
    1. 2.1 バックアップ
  3. 3 インストール後の再設定
    1. 3.1 通知メールの送信元メールアドレスの変更
    2. 3.2 検索エンジンのクロールの制御
    3. 3.3 LDAP 署名に対応した Active Directory 連携
  4. 4 自動対話式モード
    1. 4.1 インストール時
    2. 4.2 アップデート時
  5. 5 MySQL 5.7の利用時の注意点
    1. 5.1 クエリキャッシュを無効にする
  6. 改訂履歴

1 システム要件

本ドキュメントは Backlog スタンダード 最新版がインストールされており、 その環境はBacklog スタンダード インストールガイド システム要件 を満たしている事を前提とします。

2 バックアップ

2.1 バックアップ

以下の一点についてバックアップを定期的に取得することをおすすめします。

  • データベースのダンプ

データベースのタンプについて、mysqldumpなどが利用可能です。

3 インストール後の再設定

3.1 通知メールの送信元メールアドレスの変更

Backlogから送信されるメールの送信元メールアドレスには、 課題の登録などを実行した人のメールアドレスを使用しています。
そのため、送信元メールアドレスと実際に送信したドメインが異なる場合があり、メール受信サーバーによっては、なりすましやスパムと判定される場合があります。

送信元メールアドレスを変更することで、これを防止できます。
設定方法は以下です。

3.1.1 Tomcat を停止します

Tomcat を停止してください。

3.1.2 ご希望の送信元メールアドレスを設定します

以下のファイルを開いてください。

  • <Tomcatのインストールディレクトリ>/webapps/backlog/WEB-INF/classes/env.properties

以下の項目に送信元メールアドレスを指定してください。

例）
mail.notificationsAddressFormat=notifications@backlog.jp

3.1.3 Tomcatを起動します

Tomcat を起動してください。

3.1.4 オプション設定

次のように送信元メールアドレスに送信者IDを含めて、送信者ごとに一意にすることもできます。
[notifications@backlog.jp] -> [notifications-21@backlog.jp]
送信元メールアドレスが固定の場合、Gmailでは同一送信先からのメールと判定され、送信者名が一人だけしか表示されなくなります。
送信者名をスレッド上に表示させるには、以下の手順で送信元メールアドレスを設定し直してください。

送信者IDを埋め込みたい箇所に %d を指定してください。

例）
mail.notificationsAddressFormat=notifications-%d@backlog.jp
実際の送信元メールアドレスの例）
notifications-21@backlog.jp

修正した後は、Tomcat を再起動させてください。これで、アクションを行ったユーザー一人一人の名前が Gmail の受信トレイ上に表示されます。

3.2 検索エンジンのクロールの制御

この設定により、Google などの検索エンジンが Backlogのログイン画面およびiCal以外の画面を不必要にクロールしなくなります。
ログイン画面はクロールされますが、 METAタグに noindex を指定しているため、各検索エンジンの検索インデックスに登録されることはありません。

3.2.1 robots.txt を配置します

以下の内容をコピーして robots.txt という名前で保存し、ホストの最上位ディレクトリに配置してください。
ファイルの配置場所については、Googleのサイトを参考にしてください。 

User-Agent: Googlebot
Allow: /backlog/ical/
Allow: /$
Allow: /backlog/LoginDisplay.action$
Disallow: /

User-agent: *
Allow: /$
Allow: /backlog/LoginDisplay.action$
Disallow: /

3.3 LDAP 署名に対応した Active Directory 連携

Backlog で Active Directory と連携しており LDAP 署名に対応したい場合は、次の設定を行ってください。
Backlog と Active Directory との通信にプロトコルとして LDAPS (LDAP over SSL/TLS) を使用するためには、事前に Active Directory にサーバー証明書をインストールする必要があります。

3.3.1 サーバー証明書を Active Directory にインストールします

下記のいずれかの方法でサーバー証明書を発行し Active Directory にインストールしてください。

  • Active Directory 証明書サービスの場合

    下記のページを参考に設定してください。
    Step by Step Guide to Setup LDAPS on Windows Server
    インストールした証明書をエクスポートし、 Backlog サーバー上で keytool コマンドを使用して JRE キーストアにインポートしてください。

3.3.2 Tomcat を停止します

Tomcat を停止してください。

3.3.3 Backlog が使用する環境変数を編集します

以下のファイルを開いてください。

  • <Tomcatのインストールディレクトリ>/webapps/backlog/WEB-INF/classes/env.properties

以下の項目 ldap.using を true にし、LDAPS プロトコルでの通信を有効にします。ldap.using を false に設定すると LDAPS を使用せずに LDAP プロトコルで通信します。

変更前）ldaps.using=false ※ false の場合は LDAP プロトコルで通信します
変更後）ldaps.using=true ※ true の場合は LDAPS プロトコルで通信します

以下の項目 ldaps.port で LDAPS のポート番号を指定してください。
この設定項目は ldaps.using が false の場合は使用されません。

例）
ldaps.port=636

3.3.4 必要に応じて Tomcat の起動オプションを追記します

Active Directory 証明書サービスを使用している場合、Active Directory へユーザーを検索する際にエラーが発生する場合があります。以下のオプションを Tomcat の設定 CATALINA_OPTS に追記し、エラーを回避させてください。

-Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true

3.3.5 Tomcatを起動します

Tomcat を起動してください。

4 自動対話式モード

インストール、アップデートは基本対話式で実行されますが、自動対話式で実行することも可能です。

4.1 インストール時

4.1.1 自動対話式用の設定ファイルのテンプレートをコピーします

インストーラには std-init-interactive.properties.template というファイルが含まれています。
このテンプレートファイルをコピーしてください。コピー先のファイル名は任意で構いません。
以下の例では、コピー先のファイル名を std-init-interactive.properties として説明します。

cp std-init-interactive.properties.template std-init-interactive.properties

4.1.2 設定値を修正します

コピーしたファイルを開いて、設定値を適宜修正してください。
設定が必須の項目には説明欄に
# 【必須】
と記載されています。それ以外は、未設定でも構いませんがデフォルト値が使われます。
詳細はファイルに記載されている説明欄をご確認ください。
行の先頭の「#」はコメント行を表します。設定を有効にするには先頭の「#」を削除してください。
また、行の途中で「#」と記述してもコメントとして扱われません。設定を無効にしたい場合は行の先頭に「#」と記述してください。

4.1.3 保存したファイルを -i で指定して、インストーラーを実行します

インストールガイドの 4.5 インストーラーの起動 で、-i を指定してください。

java -jar backlog-installer.jar -i std-init-interactive.properties

4.2 アップデート時

4.2.1 自動対話式用の設定ファイルのテンプレートをコピーします

アップデーターには std-update-interactive.properties.template というファイルが含まれています。
このテンプレートファイルをコピーしてください。コピー先のファイル名は任意で構いません。
以下の例では、コピー先のファイル名を std-init-interactive.properties として説明します。

cp std-update-interactive.properties.template std-update-interactive.properties

4.2.2 設定値を修正します

4.1.2 インストールと同様にコピーしたファイルを開いて、設定値を適宜修正してください。

4.2.3 保存したファイルを -i で指定して、アップデーターを実行します

アップデートガイドの 3.3 アップデーターの起動 で、-i を指定してください。

java -jar backlog-updater.jar -i std-update-interactive.properties

5 MySQL 5.7の利用時の注意点

5.1 クエリキャッシュを無効にする

my.cnfでquery_cache_typeに0を指定してクエリキャッシュを無効にしてください。

BacklogがMySQL 8.0に対応したことにより、MySQLのクエリキャッシュを有効にするとBacklogが正しく動作しなくなるおそれがあります。

なお、MySQL 5.7でquery_cache_typeのデフォルト値は0のため、my.cnfで設定していない場合は追加する必要はありません。

[mysqld]
  max_allowed_packet = 16M
  character-set-server=utf8mb4
  sql_mode = "NO_ENGINE_SUBSTITUTION"
  query_cache_type = 0

  [mysql]
  default-character-set=utf8mb4

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

改訂履歴

2024-02-29

  • MySQL 5.7の利用時の注意点について追記しました。

2023-08-29

  • PostgreSQLについて削除しました。

2021-01-29

  • 「3.3 LDAP 署名に対応した Active Directory 連携」項を追記しました。

2018-10-15

  • 「3.2 検索エンジンのクロールの制御」項を追加しました。

    • 2018-10-05

    • 改訂履歴を本ドキュメントに追加しました。
    • 改訂履歴欄の追加に伴い、本ドキュメントの更新日時欄を削除しました。
    • 「1 システム要件」項で、「Backlog スタンダード (1.10.4) がインストールされており」を「Backlog スタンダード 最新版がインストールされており」に文言を変更しました。