Backlogエンタープライズ 2.4.0
運用ガイド

ディレクトリ構成

Backlogは以下の構成でインストールされます。

<インストール先のディレクトリ>
├── backlog-job-worker
│     └── hikaricp.properties #データベース接続の最大コネクション数
├── data #Backlogの各データの保存先
├── logs #Backlogの各ログの保存先
├── .env #各設定値
├── docker-compose.yml #Backlogの各コンテナ定義
└── Licenses.txt #Backlogが利用しているオープンソースソフトウェアの情報

Backlogの停止・起動

cd <インストール先のディレクトリ>
docker-compose down

cd <インストール先のディレクトリ>
docker-compose up -d

使用するサービス

利用するポート番号

以下のポート番号を利用してサービスを公開しますので、iptables等を利用されている場合は、下記のポート番号への外部からのアクセスを許可してください。

ファイルデータの保存ディレクトリ

Backlogのファイルデータは、以下のディレクトリに保存されます。

data
├── attachment
│       └── pull_request
├── davsvn
│       ├── share
│       └── svn
├── elasticsearch
├── git
├── image
└── solr
        ├── issue
        ├── pull_request
        ├── shared_file
        └── wiki

ログの保存ディレクトリ

<インストール先のディレクトリ>/logsに各サービスのログが保存されます。

logs
├── ${tag[1]} #ログの一時保存領域
│       └── ${tag[1]}
├── backlog-api
├── backlog-davsvn
├── backlog-davsvn-mntlog
│       ├── dav-job-worker
│       ├── httpd-davsvn
│       ├── svn-hook
│       └── svnserve
├── backlog-job-worker
├── backlog-solr
├── backlog-web
├── database-migration
├── elasticsearch
├── elasticsearch-init
├── git-http
├── git-rpc
├── git-rpc-mntlog
├── git-ssh
├── kanban-backend
├── kanban-notification
├── memcached
├── nginx
└── redis

.envのパラメーター

データをバックアップする

Backlogで扱うデータは以下に保存されています。これらのファイルは定期的にバックアップすることを推奨します。

• データベース
• ファイルデータの保存ディレクトリ
• ログの保存ディレクトリ

詳細設定ファイルを作成する

docker-compose.ymlと同じ階層にdocker-compose.override.ymlを作成します。
docker-compose.override.ymlには、変更したいサービスとその設定値を記載します。
作成後は、起動と同じコマンドで再起動してください。
例

services:
  backlog-web:
    environment:
    ...

  backlog-api:
    environment:
    ...

詳しくは以下のサイトをご覧ください。
https://docs.docker.jp/compose/extends.html#understanding-multiple-compose-files

Active Directoryと連携する

backlog-api:
  environment:
    - LDAPS_PORT=8636 #デフォルト 636

backlog-web:
  environment:
    - LDAPS_PORT=8636 #デフォルト 636

backlog-api:
  volumes:
    - /path/to/cert/dir:/mnt/certs #`/path/to/cert/dir`を証明書を配置したディレクトリに書き換えてください
  command: -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true

backlog-web:
  volumes:
    - /path/to/cert/dir:/mnt/certs #`/path/to/cert/dir`を証明書を配置したディレクトリに書き換えてください
  command: -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true

検索インデックスを再生成する

キーワード検索の結果が正しく表示されない場合、検索インデクシングを再生成するコマンドを実行してください。インデクシングデータが多い場合、再生成には時間がかかります。

docker-compose up elasticsearch-tool

java.lang.OutOfMemoryError: Java heap space

backlog-solr:
  environment:
    - SOLR_JAVA_MEM=-Xms1024m -Xmx1024m #デフォルト -Xms512m -Xmx512m

docker-compose up solr-tool

docker-compose up solr-tool

検索インデックスの再生成の速度を変更する

詳細設定ファイルのインデクシングジョブの制限値を変更します。
編集後は、起動と同じコマンドで再起動してください。

backlog-job-worker:
  environment:
    - BACKLOG_WORKER_JOB_INDEXING_ISSUE_JOB_PERMITS=16 #デフォルト 6

リクエストのパケットサイズ上限を変更する

Wikiの文字数が多すぎて保存ができなくなった場合などは、詳細設定ファイルのパケットサイズの制限値を変更します。
編集後は、起動と同じコマンドで再起動してください。

backlog-api:
  environment:
    - MAX_MEMORY_BUFFER=25MB #デフォルト 20MB
    - MAX_DISK_BUFFER=25MB #デフォルト 20MB

backlog-web:
  environment:
    - MAX_MEMORY_BUFFER=25MB
    - MAX_DISK_BUFFER=25MB

Nginxの同時接続数の最大値を変更する

以下のコマンドでnginx.confをローカルにコピーします。
編集後は、起動と同じコマンドで再起動してください。

docker-compose cp nginx:/etc/nginx/nginx.conf .

nginx.confを編集し、docker-compose.override.ymlを編集します。

nginx:
  volumes:
    - ./nginx.conf:/etc/nginx/nginx.conf

nginx.confの設定について詳しくは以下のサイトをご覧ください。
nginx documentation

MySQL 5.7の利用時の注意点

[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

商標について

• MySQLとJavaは、Oracle Corporation及びその子会社、関連会社の米国及びその他の国における登録商標です。文中の社名、商品名等は各社の商標または登録商標である場合があります。
• Dockerは、米国及びその他の国におけるDocker, Inc. の商標または登録商標です。
• Nginxは、米国及びその他の国におけるNginx Software Inc. 及びその子会社、関連会社の登録商標です。
• Active DirectoryとWindows Serverは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。
• その他記載されている会社名および商品名は各社の登録商標または商標です。