共通インストールマニュアル

インストールマニュアル共通事項

1. ご注意

まず初めに、注意事項に関して記載します。

1.1 Lychee Redmine インストール時の注意事項

  • Lychee Redmine は Redmine のデータベース構造を変更するなど、Redmine に対して大幅な拡張をしているものが含まれております。
  • インストール前に必ず既存環境のバックアップを取得してください。

1.2 Redmine バージョンアップ時の注意事項

Redmine をバージョンアップした際は、以下のコマンドの実行が必要になる場合があります。バージョンアップ後に実行してください。

1.2.1 トラッカー設定フィールドの修正（Redmine 3.4 以上へのアップデート時）

トラッカー設定画面で「実開始日」「実終了日」がOFFの状態で Redmine 3.4 以上にアップデートすると、標準フィールドの「説明」がOFFになり「実終了日」がONになる問題が発生します。
Redmineのバージョンアップ後、以下のコマンドを実行してください。

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:lad:correct_fields_bits

1.2.2 ガントチャート表示の修正（Redmine 4.0 以上へのアップデート時）

Lychee ガントチャート v3.9.5 以上をインストール済みの状態で Redmine 4.0 以上にアップデートすると、ガントチャートが表示できなくなる場合があります。
Redmineのバージョンアップ後、以下のコマンドを実行してください。

$ cd /var/rails/redmine
$ RAILS_ENV=production bundle exec rake redmine:plugins:lgc:fix_lgc_options_type

2. 環境

ここでは本マニュアルにおけるインストール環境やファイル構成などに関して記載します。

2.1 マニュアル想定環境

本マニュアルは以下の環境を想定しています。ご使用の環境に合わせて、適宜読み替えていただきますようお願いいたします。

項目値
OSLinux 64bit
Redmine ルートディレクトリ/var/rails/redmine
rgloader 展開先/tmp
Lychee Redmine 展開先/tmp/LycheeRedmine

2.2 各ファイルについて

下記のディレクトリは、ご利用プラグインの種類に関係なく配置していただきますようお願いいたします。

  • rgloader

プラグインの種類によっては複数のディレクトリを配置する必要があります。以下をご参照いただき、ご購入内容に合わせてマニュアルを適宜読み替えてください。

契約内容プラグイン名
Lycheeベーシックalm
lychee_version_start_date
lychee_project_view
lychee_easy_assigned_user
lychee_workdays
lychee_issue_spread_sheet
lychee_status_color
lychee_profile_icon
lychee_notification
lychee_help
lychee_project_term
lychee_message_box
lychee_project_dashboard
lychee_issueform
Lycheeアジャイル（Neoバックログ）lychee_agile
Lycheeスケジュール管理（ガントチャート）lgc
lgc_pro
Lycheeガントチャート5lychee_gantt_chart
Lycheeスケジュール管理（カンバン）lychee_kanban
Lycheeスケジュール管理（チケットセット）lychee_issue_set
Lycheeスケジュール管理（プロジェクトテンプレート）lpt
Lycheeスケジュール管理（アクチュアルデイト）lad
Lychee工数リソース管理（タイムマネジメント）lychee_time_management
lychee_work_plan
Lychee工数リソース管理（リソースマネジメント）lrm
Lycheeチケット関連図lac
Lycheeコストマネジメントlychee_cost
Lychee EVMlevm
lychee_issues_evm
Lycheeプロジェクトレポートlychee_project_report
Lycheeカスタムフィールドlychee_custom_field
Lychee SAML認証lychee_saml_auth
Lychee CCPMlychee_ccpm
lychee_remaining_estimate
Lycheeグループlychee_groups
Lychee 機械管理lychee_manufacturing
Lycheeフィルターlychee_filter

3. 事前準備

インストールを開始する前の準備作業について説明致します。

3.1 ファイルの展開

ダウンロードした圧縮ファイルは Linux 上で展開してください。Windows 上で解凍するとファイルの実行権限が失われます。

3.2 依存ライブラリのインストール

お使いの OS に合わせてインストールしてください。

Ubuntu 24.04

$ sudo apt-get update && sudo apt-get install -y libjpeg-dev libfontconfig-dev

Debian 13.0

$ sudo apt-get update && sudo apt-get install -y libjpeg-dev libfontconfig-dev libxrender1

3.3 PDF出力を使用する場合（Lychee ガントチャート 5 v5.1.0 以上）

Chromium のインストールおよび以下の環境変数の設定が必要です。

$ LYCHEE_GANTT_CHART_CHROME_NO_SANDBOX=true

Chromium のインストール手順（Ubuntu 24.04 の例）

以下の URL から chrome-headless-shell をダウンロードし、Redmine ルートディレクトリに配置してください。

$ # ダウンロードして展開
$ wget https://storage.googleapis.com/chrome-for-testing-public/135.0.7004.0/linux64/chrome-headless-shell-linux64.zip
$ unzip chrome-headless-shell-linux64.zip
$ mv chrome-headless-shell-linux64 /var/rails/redmine/chrome

$ # シンボリックリンクの作成
$ ln -s /var/rails/redmine/chrome/chrome-headless-shell /var/rails/redmine/chrome/chrome

⚠️ 注意: シンボリックリンクでは期待通りに動作しない場合があります。chrome コマンドのパスはリンク先のファイルをフルパスで指定してください。

Chromium の動作に必要なライブラリをインストールしてください。

$ apt update && apt install -y --no-install-recommends   ca-certificates fonts-liberation libasound2 libatk-bridge2.0-0 libatk1.0-0   libatspi2.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libdrm2 libexpat1   libgbm1 libglib2.0-0 libgtk-3-0 libnspr4 libnss3 libpango-1.0-0   libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1   libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6   wget unzip xdg-utils

Systemd 環境での追加設定

Systemd を使用している環境では、MemoryDenyWriteExecute および RestrictNamespaces が有効になっているとPDF出力が動作しません。Redmine の service ファイルで該当行をコメントアウトしてください。

$ #MemoryDenyWriteExecute=true
$ #RestrictNamespaces=true

AppArmor が有効な環境での追加設定

/etc/apparmor.d/chrome-lychee-redmine を以下の内容で作成してください。

$ abi <abi/4.0>,
$ include <tunables/global>

$ profile chrome {chromeのパス} flags=(unconfined) {
$   userns,

$   # Site-specific additions and overrides. See local/README for details.
$   include if exists <local/chrome>
$ }

作成後、以下のコマンドで AppArmor をリロードしてください。

$ sudo service apparmor reload

⚠️ 注意: {chromeのパス} はシンボリックリンクでは期待通りに動作しません。リンク先のファイルをフルパスで指定してください。

3.4 lychee_themes プラグインを使用する場合

plugins/lychee_themes/assets/themes フォルダへの書き込み権限を確認してください。

4. インストール手順

  • インストール手順に関して記載します。
  • 「買取版」と「評価版・タイムド版」でインストール手順が若干異なりますので、ご注意ください。

4.1 買取版

4.1.1 ローダーの配置

$ cp -R /tmp/rgloader /var/rails/redmine

4.1.2 プラグインの配置

$ cp -R /tmp/LycheeRedmine/* /var/rails/redmine/plugins

⚠️ 注意: lgc、levm、lychee_basic、lychee_ccpm、lychee_time_management のように複数プラグインがまとめられているフォルダがあります。その場合は親フォルダごとではなく、内部の個別プラグインフォルダを /plugins 直下に配置してください。

ファイルオーナーを Redmine 実行ユーザーに合わせて設定してください。

4.2 評価版・タイムド版

4.2.1 ローダーの配置

$ cp -R /tmp/rgloader /var/rails/redmine

4.2.2 ライセンス管理プラグイン（alm）の先行配置

ライセンス認証に必要なため、alm プラグインを先にインストールします。

$ cp -R /tmp/LycheeRedmine/alm /var/rails/redmine/plugins

$ cd /var/rails/redmine
$ bundle install --without 'development test'
$ bin/rails redmine:plugins RAILS_ENV=production

production 環境で Redmine を再起動してください。

4.2.3 ライセンス認証

管理者でログイン後、[管理] → [Lychee Redmine ライセンス管理] を開き、利用規約に同意のうえ、弊社から発行された認証コードを入力して登録を完了してください。

4.2.4 残りプラグインの配置

$ rm -rf /tmp/LycheeRedmine/alm
$ cp -R /tmp/LycheeRedmine/* /var/rails/redmine/plugins

⚠️ 注意: lgc、levm、lychee_basic、lychee_ccpm、lychee_time_management のように複数プラグインがまとめられているフォルダがあります。その場合は親フォルダごとではなく、内部の個別プラグインフォルダを /plugins 直下に配置してください。

ファイルオーナーを Redmine 実行ユーザーに合わせて設定してください。

4.3 共通（買取版・評価版・タイムド版）

4.3.1 ライブラリのインストールとDB反映

$ cd /var/rails/redmine
$ bundle install --without 'development test'
$ bin/rails redmine:plugins RAILS_ENV=production

Redmine 6 以上の場合は追加で実行してください。

$ bin/rails assets:clobber assets:precompile RAILS_ENV=production

Sub-URI（サブディレクトリ方式）で運用している場合は以下を実行してください。

$ bin/rails assets:clobber assets:precompile RAILS_ENV=production RAILS_RELATIVE_URL_ROOT=/foo

4.3.2 Redmine の再起動

  • ご使用の環境に合わせた、Redmineインスタンスの再起動手順を行ってください。
  • 起動する際は、必ず「production環境」として起動してください。

例

$ cd /var/rails/redmine
$ bundle exec rails server -e production

4.3.3 モジュールの有効化

以下のプラグインはプロジェクトごとにモジュールの有効/無効を切り替えられるようになっております。

  • Lycheeスケジュール管理（ガントチャート）
  • Lycheeスケジュール管理（ガントチャート5）
  • Lycheeスケジュール管理（カンバン）
  • Lycheeスケジュール管理（バックログ）
  • Lycheeアジャイル（Neoバックログ）
  • Lychee CCPM
  • Lychee EVM
  • Lychee工数リソース管理（リソースマネジメント）
  • Lycheeコストマネジメント
  • Lychee工数リソース管理（タイムマネジメント）
  • Lycheeプロジェクトレポート
  • Lycheeダッシュボード
  • Lycheeスケジュール管理（チケットセット）
  • Lycheeカスタムフィールド
  • Lycheeチケット関連図

上記プラグインを有効化するには、プロジェクトの[設定]タブにある[モジュール]タブにおいて該当プラグインを有効にしてください。

5. 補足

以下、補足の設定を記載致します。

5.1 Lycheeガントチャート チケットステータスの表示色設定

  • チケットのステータスの表示色を自動で設定する場合は、Redmineのルートディレクトリにて下記のコマンドを実行してください。
  • 管理画面から手動で設定する場合は、下記の実行は不要です。
$ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_status_color:set_default_status_colors

5.2 Lychee EVM エクスポート時の外部サーバへの接続許可の設定

  • システム管理者でログインし、管理＞プラグイン＞Lychee EVM＞設定 画面から設定できます。
  • 設定をオフにした場合はエクスポートボタンが印刷ボタンになります。

5.3 Lychee EVM スナップショット作成

  • Lychee EVMではスナップショットを取得しておくことで、現在と過去の状況を比較できます。
  • スナップショット機能を有効にする場合は、下記のコマンドを実行するようにcronタスクとして設定してください。
  • 業務に影響がおよばないよう、一日一回以下かつ深夜に実行することをおすすめいたします。
  • プロジェクト数やスナップショットを保存する頻度によっては、データベースの容量が大きくなるのでご注意ください。
$ RAILS_ENV=production bundle exec rake redmine:plugins:levm:snapshot:fixed

5.4 Lycheeプロジェクトレポート 集計データの生成設定

  • プロジェクトレポートを生成する前に以下の設定が必要です。
  • 集計タスクの登録レポートに必要な集計データを生成するため、以下のコマンドを毎日一回実行するよう、cronタスクとして設定してください。
  • 業務に影響がおよばないよう、深夜に実行することをおすすめいたします。
$ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_project_report:daily_reporting

5.5 Lycheeプロジェクトレポート 指標サンプルの作成

  • Lycheeプロジェクトレポートではインストール時に、使用例として指標のサンプルがいくつか作成されます。
  • 削除した場合は、以下のコマンドで再作成ができます。
$ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_project_report:add_indice_settings

5.6 Lychee CCPM フィーバーチャートの描画データの生成設定

  • Lychee CCPMではフィーバーチャートを描画するために以下の設定が必要です。
  • フィーバーチャートに必要な集計データを生成するため、以下のコマンドを毎日一回実行するよう、cronタスクとして設定してください。
  • 業務に影響がおよばないよう、深夜に実行することをおすすめいたします。
$ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_ccpm:aggregate_consumption_rates

5.7 Lychee CCPM フィーバーチャートの期日の自動更新の設定

  • Lychee CCPMでは残工数からチケットの期日を自動で更新することができます。自動更新するには、以下の設定が必要です。
  • システム管理者でログインし、該当のプロジェクト＞設定＞CCPMタブ の「バッチ処理で残工数からチケットの期日を自動更新する」にチェックが必要です。
  • また、以下のコマンドを毎日一回実行するよう、cronタスクとして設定してください。
  • 業務に影響がおよばないよう、深夜に実行することをおすすめいたします。
$ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_ccpm:calculate_due_date_for_issues

5.8 Lycheeタイムマネジメント 予定の実績変換方法（カレンダー形式をご利用される場合のみ）

Lycheeタイムマネジメントの表示形式について、表形式とカレンダー形式の2種類があります。デフォルトでは表形式ですが、カレンダー形式を選択した場合には以下の設定が必要です。

  • 入力された作業予定を作業実績に変換するため、以下のコマンドを毎時間一回実行するよう、タスクスケジューラーで設定してください。
  • 設定中のタイムゾーンにより、コマンドが実行された時刻が深夜0時台となるユーザーの作業予定が作業実績に変換されます。
  • ユーザーのタイムゾーンが未設定の場合、Redmineが動作しているタイムゾーンが設定されているものとして扱われます。
  • サーバーの時計の時刻が実際の時刻とずれてしまう可能性を考え、毎時0分ではなく、毎時5分などに実行することをおすすめいたします。
$ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_time_management:work_plans_to_time_entries

5.9 LycheeIssueForm チケット更新時のメール通知設定（評価版・タイムド版のみ）

  • IssueFormでチケットを更新した場合、更新内容はそのままではメール通知されません。
  • 更新内容がメール通知されるように、以下のコマンドを定期実行するよう、cronタスクとして設定してください。
  • 長い時間間隔に設定すると、更新をしてもメールがすぐにこない、または沢山の更新内容が一度のメールで来てしまい更新確認がし辛い恐れがあるため、毎時5分などに実行することをおすすめいたします。
  • なお、定期実行時に更新内容が複数ある場合は、チケットごとに複数の内容がメール本文にまとめて通知されます。
$ RAILS_ENV=production bundle exec rake redmine:plugins:lychee_issue_form:send_notification_for_journals

6. アンインストール手順

アンインストール手順について記載します。

⚠️ 警告: アンインストールを実行するとプラグインに関連するデータが完全に削除されます。必ず事前にバックアップを取得してください。

各プラグインのマイグレーションを 0 にリセットしてからディレクトリを削除してください。

$ cd /var/rails/redmine

$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lad VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lpt VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_version_start_date VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issue_form VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_view VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_easy_assigned_user VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_workdays VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issue_spread_sheet VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_status_color VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_profile_icon VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_notification VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_term VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_message_box VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_help VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_checklist VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_dashboard VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lgc VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lgc_pro VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_gantt_chart VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_kanban VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issue_set VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_time_management VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_work_plan VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lrm VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lac VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_cost VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=levm VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_issues_evm VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_project_report VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_custom_field VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_saml_auth VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_ccpm VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_remaining_estimate VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_groups VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_manufacturing VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_themes VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=alm VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_agile VERSION=0
$ RAILS_ENV=production bundle exec rake redmine:plugins:migrate NAME=lychee_filter VERSION=0

マイグレーションの実行後、以下のコマンドでファイルを削除してください。

$ rm -rf rgloader
$ rm -rf public/plugin_assets/{alm,lad,lpt,lychee_version_start_date,lychee_issue_form,lychee_project_view,lychee_easy_assigned_user,lychee_workdays,lychee_issue_spread_sheet,lychee_status_color,lychee_profile_icon,lychee_notification,lychee_project_term,lychee_message_box,lychee_help,lychee_checklist,lychee_project_dashboard,lgc,lgc_pro,lychee_gantt_chart,lychee_kanban,lychee_issue_set,lychee_time_management,lychee_work_plan,lrm,lac,lychee_cost,levm,lychee_issues_evm,lychee_project_report,lychee_custom_field,lychee_saml_auth,lychee_ccpm,lychee_remaining_estimate,lychee_groups,lychee_manufacturing,lychee_themes,lychee_filter,lychee_agile}
$ rm -rf plugins/{alm,lad,lpt,lychee_version_start_date,lychee_issue_form,lychee_project_view,lychee_easy_assigned_user,lychee_workdays,lychee_issue_spread_sheet,lychee_status_color,lychee_profile_icon,lychee_notification,lychee_project_term,lychee_message_box,lychee_help,lychee_checklist,lychee_project_dashboard,lgc,lgc_pro,lychee_gantt_chart,lychee_kanban,lychee_issue_set,lychee_time_management,lychee_work_plan,lrm,lac,lychee_cost,levm,lychee_issues_evm,lychee_project_report,lychee_custom_field,lychee_saml_auth,lychee_ccpm,lychee_remaining_estimate,lychee_groups,lychee_manufacturing,lychee_themes,lychee_filter,lychee_agile}

削除後、production 環境で Redmine を再起動してください。

TOP