1 システム要件

Backlogはウェブアプリケーションであり、稼働させるためにはサーバが必要となります。また、Backlogを使用するにはウェブブラウザが必要です。

1.1 サーバ要件

Backlogスタンダード(Version 1.9.0)が稼働するサーバの要件は次のとおりです。

1.1.1 ハードウェア

ハードウェア
CPU 2.5GHz以上
メモリ 2GB以上
ハードディスク 30GB以上

1.1.2 OS

下記のOSで動作します。

  • Red Hat Enterprise Linux 5 server
  • Red Hat Enterprise Linux 6 server
  • CentOS 5
  • CentOS 6

タイムゾーンは日本標準時(JST)に設定してください。
またデータベースサーバやSMTPサーバなど、他に利用するミドルウェアのタイムゾーンも
全て日本標準時で稼働している事を確認してください。

1.1.3 Java

  • Java SE 8 JDK 最新版 ( Oracle 社が配布するRPM形式でのインストールを推奨 )

1.1.4 アプリケーションサーバ

下記のアプリケーションサーバで動作します。

  • Apache Tomcat 7.0

1.1.5 データベース

下記のデータベースで動作します。

  • PostgreSQL 9.3
  • PostgreSQL 9.4
  • MySQL 5.5
  • MySQL 5.6

1.1.6 SMTPサーバ

SMTP認証なしでメール送信が可能なSMTPサーバが必要です。
Red Hat Enterprise Linux や CentOS に標準でインストールされる Sendmail や Postfix が利用できます。

1.1.7 Active Directory サーバ

Backlog のユーザ認証に Active Directory を利用する場合に必要です。( 1.5.0 からの新機能 )
Backlog は、DNS の SRV リソースレコードにより Active Directory サーバを見付け接続し、ユーザを認証します。
Active Directory 用のゾーン定義や SRV リソースレコードの設定があらかじめ必要です。
Windows Server 2008 での Active Directory に対応しています。

1.2 ウェブブラウザ要件

Backlogの利用に適したOSとウェブブラウザは次のとおりです。

1.2.1 Windows Vista / Windows 7 / Windows 8 の場合

  • Internet Explorer 9, 10, 11 ( 互換モードでは正しく表示されませんので、互換モードを無効にしてご利用ください )
  • Microsoft Edge
  • Mozilla Firefox 最新版
  • Google Chrome 最新版

1.2.2 Mac OSX の場合

  • Apple Safari 最新版
  • Mozilla Firefox 最新版
  • Google Chrome 最新版

上記以外のウェブブラウザでも動作する可能性はございますが、サポート対象外とさせて頂いております。ご了承ください。

2 Java のフォント設定

Backlogが生成するバーンダウンチャート等の画像に日本語を表示するために、Javaのフォント設定が必要です。
次の手順で設定できます。

2.1 フォントのインストール

次のコマンドにて日本語フォントパッケージをインストールします。

  • Red Hat Enterprise Linux 5 server または CentOS5 の場合
    # yum install fonts-japanese
  • Red Hat Enterprise Linux 6 server または CentOS6 の場合
    # yum install ipa-pgothic-fonts

2.2 Javaインストールディレクトリへフォントをリンク

下記手順にてインストールしたフォントをリンクします。ここで、JAVA_HOME 環境変数はJavaのインストールディレクトリです。( 例: /usr/java/default )

  • Red Hat Enterprise Linux 5 server または CentOS5 の場合
    # mkdir $JAVA_HOME/jre/lib/fonts/fallback
    # ln -s /usr/share/fonts/ja/TrueType/kochi-*.ttf $JAVA_HOME/jre/lib/fonts/fallback/
  • Red Hat Enterprise Linux 6 server または CentOS6 の場合
    # mkdir $JAVA_HOME/jre/lib/fonts/fallback
    # ln -s /usr/share/fonts/ipa-pgothic/ipagp.ttf $JAVA_HOME/jre/lib/fonts/fallback/

3 Apache Tomcat の設定

3.1 HTTP コネクタの設定

Backlogを利用するためにはTomcatを HTTP コネクタにて利用することが必須です。またその設定ファイル「server.xml」の「Connector」の属性に「URIEncoding="UTF-8"」を追加する必要があります。

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

もし AJP コネクタを併用する場合には、そちらも「URIEncoding="UTF-8"」の設定を追加してください。

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

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

ここで指定する全文検索用のディレクトリのパスは、インストーラ実行時の二つ目の手順である、「スペースおよびユーザアイコン画像を保存したり検索インデックスの作成を行うディレクトリを絶対パスで指定してください」で指定するパスに「/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"

3.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/

4 インストール

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

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

画面:ダウンロード画面

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

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

4.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.38.zip
# cp mysql-connector-java-5.1.38/mysql-connector-java-5.1.38-bin.jar /tmp/backlog-1.9.0/

4.3 データベースの設定 (MySQLのみ)

Backlogでは課題やWikiの添付ファイルをデータベースに格納します。
MySQLの場合大きいサイズのデータを登録可能にするために max_allowed_packet の設定が必要です。
my.cnf に以下の設定を追加して、MySQLサーバを起動してください。

[mysqld]
max_allowed_packet = 16M

また、Backlog のテーブルは InnoDB を利用する事を前提としており、InnoDB が有効になっていないと正しく動作しません。MySQL 起動後に InnoDB が有効になっているかを確認し、有効になっていない場合は設定やインストレーションの確認をしてください。

InnoDB が有効になっているかどうかは、MySQL にアクセスして以下のコマンドを打つ事で確認できます。有効になっている場合は YES と表示されます。

mysql> show variables like "have_innodb";
+---------------+----------+
| Variable_name | Value    |
+---------------+----------+
| have_innodb   | YES      |
+---------------+----------+

4.4 データベースの作成

Backlogは初期設定では、次の設定でデータベースに接続します。

データベース設定
データベース名 backlog
データベースユーザ名 backlog
データベースパスワード backlog

ユーザ名・パスワードはインストール時および設定ファイルで変更できます。あらかじめデータベースユーザの作成は行っておいてください。

  • PostgreSQLの場合の例
    # createuser -S -d -R -P backlog
  • MySQLの例
    # mysql -u root -p
    mysql> GRANT ALL PRIVILEGES ON *.* TO 'backlog'@'localhost' IDENTIFIED BY 'backlog' WITH GRANT OPTION;

下記例のようにして、Backlogが利用するデータベースを作成します。

  • PostgreSQLの場合の例 (データベースエンコーディングに「UTF-8」を指定してください)
    # createdb -U backlog -E UTF8 backlog
  • MySQLの例
    # mysqladmin -u backlog -p create backlog

4.5 インストーラの起動

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

Backlogパッケージアーカイブを展開したディレクトリに移動してインストーラの起動を行ってください。

# java -jar backlog-installer.jar
======================================================================
  ____             _    _
 |  _ \           | |  | |            This Backlog
 | |_) | __ _  ___| | _| | ___   __ _           installer
 |  _ < / _` |/ __| |/ / |/ _ \ / _` |
 | |_) | (_| | (__|   <| | (_) | (_| |
 |____/ \__,_|\___|_|\_\_|\___/ \__, |
                                 __/ |
                                |___/  [http://backlog.backlog.jp]
======================================================================

バックログのインストールを開始します。

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

warファイルを配備するディレクトリを絶対パスで指定してください []

Backlogアプリケーションのwarファイルを配備するディレクトリパスを指定してください。
(通常は "Tomcatのインストールされているパス/webapps" を指定します。)

スペースおよびユーザアイコン画像を保存したり検索インデックスの作成を行うディレクトリを絶対パスで指定してください []

スペースおよびユーザアイコン画像を保存したり、検索インデックスの作成を行う作業ディレクトリを指定します。
(課題やWikiへの添付ファイルはここには保存されません)

なお、指定したディレクトリが存在しない場合は、インストーラが作成します。

注)ここで作成される作業ディレクトリの所有者とグループには、Backlogを起動するユーザ(アプリケーションサーバの実行ユーザ)を指定する必要があります。

BacklogにアクセスするURLを設定してください [http://localhost:8080]
(設定したURLに /backlog がコンテキストパスとして追加されます)

BacklogをWebブラウザから参照できるURLを指定します。
これは、課題に対する変更時に発行するメールに記載されるURLのベースになります。

例) http://localhost:8080 と指定した場合、課題「ISSUE-01」に対する通知メールには http://localhost:8080/backlog/ISSUE-01 と記載されます。

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

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

SMTPサーバのホスト名を指定してください [localhost]

メール送信時に使用するSMTPサーバのホスト名を指定します。(POP before SMTPやSMTP-AUTHなどの認証形式には対応していません)

使用のデータベースを選択してください ( m<MySQL> / p<PostgreSQL> )

Backlogで使用するデータベースを選択します。
続いて、「データベースサーバホスト名」、「データベースサーバポート番号」、「データベースサーバアクセスユーザ名」、「データベースサーバアクセスパスワード」を指定します。

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 <続ける> / r <やり直し>)
  • データベースの設定が終了した後、設定の確認が行われ「y<続ける>」を選択することでインストールが開始されます。
  • 「r<やり直し>」を選択した場合は、現在の設定値を保持したままBacklogアプリケーションのインストール先の指定からやり直します。
  • データベースでMySQLを使用した場合は、JDBCドライバの選択を行います。
使用するJDBCドライバを選択してください。
1:mysql-connector-java-5.1.38.jar

データベースの接続検証が行われた後、Backlogの初期テーブルの作成を行います。(すでに作成済みの場合は、作成処理をスキップすることができます。)

テーブルの新規作成を開始します。
CREATE TABLE space
...
CREATE TABLE space_field
テーブルの新規作成が終了しました。

warファイルを配備します >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> 終了
インストールが完了しました。

Tomcatを起動してください。
引き続き http://localhost:8080/backlog/Setup.action にアクセスし、ライセンス情報や管理者ユーザ情報を登録してください。

インストール完了メッセージが表示されBacklogのインストールが完了します。
(インストール済みの環境に再インストールした場合は、配備済みのwarファイルは日付を元に付けられた別名で保存されます。)

Webブラウザよりインストール完了メッセージに表示されるURLにアクセスして初期設定とユーザ情報を登録を行ってください。

5 初期設定

インストーラによる作業が完了したら、まず初期設定を行う必要があります。
初期設定では、ライセンスキーや管理者情報を登録します。
まず、次の初期設定用URLにアクセスしてください。

[インストール時に設定したBacklogサーバへのアクセスURL]/backlog/Setup.action
( 例:http://localhost:8080/backlog/Setup.action )

画面:初期設定について

5.1 スペース情報の入力

画面:スペース情報の入力

ここではBacklogのスペース名、ライセンスキーを入力します。
「スペース名」はログイン画面やダッシュボードの上部に表示されるスペースの名称です。
「スペースURL」は課題メールなどに記載されるURLを作成するために使用します。
「ライセンスキー」はご購入時に取得いただいたライセンスキーです。
ヌーラボの利用規約を必ずお読みになり、「利用規約に同意する」にチェックしてください。

5.2 管理者ユーザ情報の入力

画面:管理者ユーザ情報の入力

ここでは管理者ユーザ(スペースオーナ)の情報を入力します。スペースオーナは通常の管理者の機能の他に次の機能が利用できるユーザです。
(機能の詳細については「ヘルプ」を参照してください)

  • アクセス制限の編集
  • ライセンスキーの変更
  • スペースオーナの変更

重要なユーザですので、メールアドレス等に間違いのないよう入力してください。

5.3 初期設定完了

画面:設定内容の確認

設定内容・ライセンス情報に間違いないかを確認してください。

画面:設定完了

この画面が表示されれば、初期設定は完了です。自動的にBacklogのトップページ(ダッシュボード)に移動します。

画面:ダッシュボード

また、初期設定完了の通知がスペースオーナのメールアドレス宛に送信されますので、その内容も確認してください。

BacklogのURLは、次のようになります。

[環境設定にて指定したBacklogサーバへのアクセスURL]/backlog

( 例:http://localhost:8080/backlog/ )

6 インストール・初期設定がおわったら

  • まず初めに、プロジェクトおよびユーザを追加しましょう。
  • 追加されたユーザには、BacklogのURLとログインに必要な情報がメールで通知されます。
  • プロジェクトを作成したら、マイルストーンやカテゴリを作成しましょう。
  • 詳細な機能の説明については、いつも画面の右上に表示されている「ヘルプ」を参照してください。
  • Linuxは、Linus Torvalds氏の日本およびその他の国における登録商標または商標です。
  • Red Hatは米国およびその他の国におけるRed Hat, Incの登録商標または商標です。
  • OracleとJavaは、Oracle Corporation 及びその子会社、関連会社の米国及びその他の国における登録商標です。文中の社名、商品名等は各社の商標または登録商標である場合があります。
  • その他記載されている会社名および商品名は各社の登録商標または商標です。

Author: Backlog Support <support@backlog.jp>

Date: 2017-02-06 15:07:12 JST