Dockerイメージを使用しDBにMySQLを指定して起動する（バージョン1.4.17.1以前）

はじめに¶

本手順は、以下2件のマニュアルの手順通りプリザンターの公式Dockeイメージを使用の上、パラメータファイルを変更して起動できることを前提としています。

1. Dockerで起動する
2. Dockerイメージを使用しパラメータを既定値から変更して起動する

未読の場合は先に上記マニュアルを参照し、プリザンターの公式Dockeイメージを使用の上、パラメータファイルを変更して起動できることを確認してください。

制限事項¶

1. MySQLでDockerイメージを利用する際、プリザンターのバージョンは1.4.10.0以降としてください。プリザンターはVer1.4.9.0以降でMySQLに対応しましたが、本手順はVer1.4.10.0以降でなければ実施できません。
2. Dockerでプリザンターを運用する場合、パラメータファイルの設定変更時は、プリザンターの停止・再起動だけでなく、docker compose buildコマンドによるビルドを再実施してください。ビルドを行っていない状態では、プリザンターを再起動してもパラメータファイルの変更が反映されません。
3. バージョン1.4.18.0以降を使用する場合はDockerイメージを使用しDBにMySQLを指定して起動するを参照ください。

前提条件¶

1. 本手順ではデータベースとしてMySQLを使用します。PostgreSQLを使用する手順は「Dockerで起動する」および「Dockerイメージを使用しパラメータを既定値から変更して起動する」を参照してください。

MySQL使用時に必要となるDockerの追加設定¶

本手順では、以下設定によりプリザンターのDBにMySQLを指定してコンテナを起動します。

1. Rds.jsonの内容をMySQL用の記述に変更する。
2. プリザンター（およびCodeDefiner）のコンテナの環境変数に、MySQL用の接続文字列を登録する。

また、MySQLの利用に付随して必要となる以下の設定を行います。

1. MySQLのユーザアカウント作成用SQLを記述する。（SQLはMySQLのコンテナを起動する際に自動実行）
2. プリザンター（およびCodeDefiner）の起動時のエラーを防ぐため、MySQLの起動が完了しているかチェックする設定を、compose.yamlファイルに記述する。

1. ファイル配置¶

フォルダを以下のように構成し、ファイルを配置します。

.
|-- compose.yaml
|-- .env
|
+-- app_data_parameters
|   +-- 拡張機能用フォルダ
|   |   +-- 拡張機能用ファイル
|   |  
|   +-- パラメータファイル
|
+-- docker-entrypoint-initdb.d
|   +-- pleasanter.sql
|
+-- CodeDefiner
|   +-- Dockerfile
|
+---Pleasanter
    +-- Dockerfile

1-1. app_data_parametersフォルダ¶

以下手順でRds.jsonおよび既定値から変更したいパラメータファイルを配備します。

1. ダウンロードセンターから、プリザンターをダウンロードします。特段理由がない場合は最新バージョンをダウンロードしてください。過去にリリースした特定のバージョンが必要な場合は、該当のバージョンのプリザンターをダウンロードしてください。
2. zipファイルを解凍します。
3. 解凍したフォルダ配下にある「\pleasanter\Implem.Pleasanter\App_Data\Parameters\Rds.json」をapp_data_parametersフォルダ配下にコピーします。
4. コピーしたRds.jsonを編集し、使用するデータベースサーバをMySQLに変更して保存します。
5. その他にパラメータを既定値から変更したい場合は、変更済みのパラメータファイルをapp_data_prametersフォルダに格納してください。

以下、Rds.jsonの修正例です。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
    "Dbms": "MySQL",
    "Provider": "Local",
    "SaConnectionString": null,
    "OwnerConnectionString": null,
    "UserConnectionString": null,
    "SqlCommandTimeOut": 0,
    "MinimumTime": 3,
    "DeadlockRetryCount": 4,
    "DeadlockRetryInterval": 1000,
    "DisableIndexChangeDetection": true,
    "SysLogsSchemaVersion": 2,
    "MySqlConnectingHost": "%"
}

1-2. CodeDefinerフォルダ¶

/CodeDefiner/Dockerfileを以下の内容で作成します。

1
2
3
4

FROM implem/pleasanter:codedefiner

COPY app_data_parameters/ /app/Implem.Pleasanter/App_Data/Parameters/
ENTRYPOINT [ "dotnet", "Implem.CodeDefiner.dll" ]

1-3. Pleasanterフォルダ¶

/Pleasanter/Dockerfileを以下の内容で作成します。

1
2
3
4
5

ARG VERSION=latest
FROM implem/pleasanter:${VERSION}

COPY app_data_parameters/ App_Data/Parameters/
ENTRYPOINT [ "dotnet", "Implem.Pleasanter.dll" ]

1-4 .envファイル¶

.envファイルを作成します。

MySQLのDocker公式イメージで必須とされる環境変数のうち、本手順ではデフォルトのスーパーユーザアカウント（root）のパスワード設定先であるMySQL_ROOT_PASSWORDを記述します。

MySQL - Official Image | Docker Hub
docker-library/MySQL: Docker Official Image packaging for MySQL Community Server

環境変数PLEASANTER_VERを用意し、プリザンターのバージョンを指定します。

SaConnectionStringは最初にMySQLにスーパーユーザで接続するための設定が一行で表現されています。MySQLの環境変数の内容とSaConnectionStringに記述されている内容を合わせる必要があります。

OwnerConnectionStringとUserConnectionStringはそれぞれのユーザで接続するための設定が一行で表現されています。

実際のファイルの例です。{{ ... }}は適宜修正してください。

1
2
3
4
5

MYSQL_ROOT_PASSWORD={{Sa Password}}
PLEASANTER_VER={{Version}}
Implem_Pleasanter_Rds_MySQL_SaConnectionString='Server=db;Database=mysql;UID=root;PWD={{Sa password}}'
Implem_Pleasanter_Rds_MySQL_OwnerConnectionString='Server=db;Database=#ServiceName#;UID=#ServiceName#_Owner;PWD={{Owner password}}'
Implem_Pleasanter_Rds_MySQL_UserConnectionString='Server=db;Database=#ServiceName#;UID=#ServiceName#_User;PWD={{User password}}'

1-5. docker-entrypoint-initdb.dフォルダ¶

説明¶

後述するcompose.yamlファイル内dbサービス配下のvolumesの設定により、MySQLのコンテナのdocker-entrypoint-initdb.dディレクトリに自動的にマウントされるフォルダです。

コンテナにマウントされたdocker-entrypoint-initdb.dディレクトリ内のファイルに記載されているSQLコマンドは、MySQLのコンテナの起動時に自動実行されます。

記述するSQLの内容¶

以下、docker-entrypoint-initdb.dフォルダ内に配置するpleasanter.sqlファイルの例です。

1
2
3
4
5

create user 'Implem.Pleasanter_Owner'@'%' identified by '{{Owner password}}';
grant create, alter, index, drop on `Implem.Pleasanter`.* to 'Implem.Pleasanter_Owner'@'%';
grant select, insert, update, delete, create routine, alter routine on `Implem.Pleasanter`.* to 'Implem.Pleasanter_Owner'@'%' with grant option;
create user 'Implem.Pleasanter_User'@'%' identified by '{{User password}}';
grant select, insert, update, delete, create routine, alter routine on `Implem.Pleasanter`.* to 'Implem.Pleasanter_User'@'%';

上記の例では、プリザンターのデータベース名にService.jsonの"Name"の既定値である「Implem.Pleasanter」を指定しています。Service.jsonの"Name"を既定値から変更する場合、SQL文でデータベース名を指定している箇所（上記Implem.Pleasanterの箇所）を、Service.jsonの"Name"の変更後と揃えてください。

また、identified byの後で指定する各MySQLユーザアカウントのパスワード文字列は、上記.envファイルと一致させてください。

1-6 compose.yamlファイル¶

compose.yamlファイルを作成します。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

services:
  db:
    container_name: mysql
    image: mysql:8.4
    environment:
      - MYSQL_ROOT_PASSWORD
    volumes:
      - type: volume
        source: my_data
        target: /var/lib/mysql
      - ./docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
    healthcheck:
        test: mysqladmin ping -h 127.0.0.1 -u root -p${MYSQL_ROOT_PASSWORD}
        interval: 10s
        timeout: 10s
        retries: 6
  pleasanter:
    build:
      context: .
      dockerfile: ./Pleasanter/Dockerfile
      args:
        - VERSION=${PLEASANTER_VER}
    container_name: pleasanter_${PLEASANTER_VER}
    depends_on:
      db:
        condition: service_healthy
    ports:
      - '50001:8080'
    environment:
      Implem.Pleasanter_Rds_MySQL_SaConnectionString: ${Implem_Pleasanter_Rds_MySQL_SaConnectionString}
      Implem.Pleasanter_Rds_MySQL_OwnerConnectionString: ${Implem_Pleasanter_Rds_MySQL_OwnerConnectionString}
      Implem.Pleasanter_Rds_MySQL_UserConnectionString: ${Implem_Pleasanter_Rds_MySQL_UserConnectionString}
  codedefiner:
    build:
      context: .
      dockerfile: ./CodeDefiner/Dockerfile
    container_name: codedefiner
    depends_on:
      db:
        condition: service_healthy
    environment:
      Implem.Pleasanter_Rds_MySQL_SaConnectionString: ${Implem_Pleasanter_Rds_MySQL_SaConnectionString}
      Implem.Pleasanter_Rds_MySQL_OwnerConnectionString: ${Implem_Pleasanter_Rds_MySQL_OwnerConnectionString}
      Implem.Pleasanter_Rds_MySQL_UserConnectionString: ${Implem_Pleasanter_Rds_MySQL_UserConnectionString}
volumes:
  my_data:
    name: ${COMPOSE_PROJECT_NAME:-default}_my_data_volume

2. コンテナイメージのビルド¶

以下コマンドを実行します。

docker compose build

3. CodeDefinerの実行¶

以下コマンドを実行します。

docker compose run --rm codedefiner _rds /l "<言語>" /z "<タイムゾーン>"

日本語環境で利用する場合は、以下コマンドとなります。

docker compose run --rm codedefiner _rds /l "ja" /z "Asia/Tokyo"

途中でType "y" (yes) if the license is correct, otherwise type "n" (no).と表示されたら Y を入力してください。

<INFO> Starter.Main: Implem.CodeDefiner 1.4.10.1

4. プリザンター起動¶

コンテナを作成、プリザンターを起動します。

docker compose up -d pleasanter

ブラウザでアクセスします。

http://localhost:50001

ログイン画面にて「ログインID: Administrator」、「初期パスワード: pleasanter」を入力します。ログイン後、パスワードの変更を求められますので適宜パスワードを設定してください。

5. コンテナの停止と削除¶

コンテナの停止は以下のコマンドで行います。

docker compose stop

停止したコンテナを再開する場合は以下のコマンドを実行します。

docker compose start

コンテナを停止してもDBデータは削除されません。再開する際にはデータがそのまま利用できます。

コンテナの削除は以下のコマンドで行います。
コンテナを削除してもDBデータ（ボリューム）は削除されません。

docker compose down

なおコンテナを削除した場合は、再開はできません。起動したい場合はコンテナを作成してください。
以下のコマンドを実行します。これによりDBのコンテナも一緒に作成され残っているDBデータもそのまま利用できます。

docker compose up -d pleasanter

コンテナを削除する時に同時にデータ（ボリューム）を削除する場合はボリュームを削除するオプションを付けて実行します。

docker compose down -v

対応バージョン¶

関連情報¶

• Dockerで起動する
• Dockerイメージを使用しパラメータを既定値から変更して起動する
• Dockerイメージのプリザンターをバージョンアップする