タイムドインストールマニュアル

タイムド版インストール

タイムド版インストール

0. ご注意・免責事項

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

  • Lychee RedmineにはRedmineのデータベース構造を変更するなど、Redmineに対して大幅な拡張をしているものが含まれております。
  • Lychee Redmineをインストールする際には、既存環境のバックアップを取った上での導入をおすすめいたします。

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

  • トラッカー設定画面の「実開始日」「実終了日」がOFFの状態でRedmine3.4以上にアップデートすると、標準フィールドの「説明」がOFFになり「実終了日」がONになる問題があります。

    Redmineのバージョンアップ後、以下のコマンドを実行してください。 

    $ cd /var/rails/redmine
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lad:correct_fields_bits
  • Lycheeガントチャート「v3.9.5」以上をインストールした状態でRedmine4.0以上にアップデートすると、ガントチャートが表示できなくなる場合があります。 Redmineのバージョンアップ後、以下のコマンドを実行してください。 
    $ cd /var/rails/redmine
    $ RAILS_ENV=production bundle exec rake redmine:plugins:lgc:fix_lgc_options_type

1. 本マニュアルにつきまして

1-1. 本マニュアルの想定環境

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

  • 環境
    • Linux OS 64bit
  • Redmine ルートディレクトリ
    • /var/rails/redmine
  • rgloader 展開先
    • /tmp
  • Timed版Lychee Redmine展開先
    • /tmp/LycheeRedmine

1-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スケジュール管理(ガントチャート)
      • lgc
      • lgc_pro
    • Lycheeアジャイル(Neoバックログ)
      • lychee_agile
    • Lycheeガントチャート5
      • lychee_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 EVM
      • levm
      • lychee_issues_evm
    • Lycheeプロジェクトレポート
      • lychee_project_report
    • Lycheeカスタムフィールド
      • lychee_custom_field
    • Lychee SAML認証
      • lychee_saml_auth
    • Lychee CCPM
      • lychee_ccpm
      • lychee_remaining_estimate
    • Lycheeグループ
      • lychee_groups
    • Lychee機械管理
      • lychee_manufacturing
    • Lycheeフィルター
      • lychee_filter

2. 事前準備

2-1. Timed版Lychee Redmineの配置/展開

  • ダウンロードした圧縮ファイルをインストールするマシン上に配置し、解凍してください。
    Linux用のファイルをWindows上で解凍すると、実行権限が失われてしまいます。
    ご注意ください。

※ 補足 以下の各フォルダには、関連する複数のプラグインフォルダがまとめて格納されております。プラグインをインストールする際には、まとめフォルダ内の各プラグインフォルダを所定のフォルダに配置する必要があります。

  • 本マニュアルではローダーは /tmp に、プラグインは /tmp/LycheeRedmine に展開されているものと仮定します。
  • Lycheeベーシックの場合
    • 解凍すると lychee_basic というフォルダが生成されます。
    • lychee_basic に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lycheeスケジュール管理(ガントチャート)の場合
    • 解凍すると lgc というフォルダが生成されます。
    • lgc に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lychee工数リソース管理(タイムマネジメント)の場合
    • 解凍すると lychee_time_management というフォルダが生成されます。
    • lychee_time_management に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lychee EVMの場合
    • 解凍すると levm というフォルダが生成されます。
    • levm に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。
  • Lychee CCPMの場合
    • 解凍すると lychee_ccpm というフォルダが生成されます。
    • lychee_ccpm に含まれている全てのフォルダを /tmp/LycheeRedmine に移動したものとします。

2-2. 依存ライブラリのインストール

  • 下記の中から、ご使用のディストリビューションに合うコマンドを実行してください。
  • Macをご使用の方はこの作業は必要ありません。

Ubuntu 14.04 64-bit

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

Debian 8.0 64-bit

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

CentOS 7.0 64-bit

$ sudo yum -y install libjpeg libpng12 libXrender libXext fontconfig

CentOS 6.3 64-bit

$ sudo yum -y install libjpeg libpng libXrender libXext fontconfig
$ sudo yum upgrade libstdc++
$ sudo yum -y install ld-linux.so.2 libjpeg.so.62 libpng12.so.0 libXrender.so.1 libfontconfig.so.1 libXext.so.6 libstdc++.i686

2-3. Lycheeガントチャート5（ver.5.1.0以上）をご利用で、
PDF印刷をご利用いただく場合は以下のライブラリをインストールしてください

※Dockerコンテナー上で動作させるためには、以下の環境変数の値を「1」 に設定していただく必要があります。

LYCHEE_GANTT_CHART_CHROME_NO_SANDBOX

※Systemdを用いてApacheやNginxを動かし、その上でLychee Redmineをお使いの場合、`MemoryDenyWriteExecute` 及び `RestrictNamespaces` が有効だとPDF出力できません。
PDF出力するにはコメントアウトして頂く必要があります。ご了承ください。尚、その場合、 `LYCHEE_GANTT_CHART_CHROME_NO_SANDBOX` の設定は不要で構いません。

Lycheeガントチャート5（ver.5.1.0以上）でPDF出力するには、
以下のソフトウェア(ライブラリ)が必要です。
・Chromium

以下は Ubuntu 24.04 のインストール例です。
※ご利用の環境に合わせて読み替えをお願いします。

■ Chromium の用意

https://storage.googleapis.com/chrome-for-testing-public/135.0.7004.0/linux64/chrome-headless-shell-linux64.zip から「chrome-headless-shell-linux64.zip」をダウンロードします。
chrome-headless-shell-linux64.zipを展開します。
展開して得られる「chrome-headless-shell-linux64」ディレクトリーをRedmine rootへ移動する。
「chrome-headless-shell-linux64」ディレクトリーを「chrome」にリネームする。
「chrome/chrome-headless-shell」を「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

2-4. lychee_themes について

Lychee_themesプラグインをインストールする場合、
plugins/lychee_themes/assets/themes フォルダへの書き込み権限が必要です。
Rails の実効ユーザが書き込める権限にしておいてください

3. Timed版Lychee Redmineの配置

※ファイル配置の際の注意点※

１．プラグインフォルダを適切に配置する。
下記プラグインは関連するプラグインが複数あるため、その情報をまとめるためのフォルダの中に各プラグインのフォルダが格納されています。プラグインのインストールの際には、まとめフォルダの中にあるプラグインフォルダをそれぞれ「/plugins」ディレクトリに配置する必要があります。

  • 　・lgc
  • 　・levm
  • 　・lychee_basic
  • 　・lychee_ccpm
  • 　・lychee_time_management

例）lychee_basicの場合
　　lychee_basicを配置するのではなく、その中にあるalmなどを/pluginsに配置する。

参考イメージ：Lycheeプラグインをplugins以下にすべて配置した場合

２．ファイルオーナーを適切にする。
plugins フォルダ配下が root になっているなどの場合は、適切な chwon -R コマンドを実行する必要があります。

参考イメージ：ファイルオーナーの状況

3-1. ローダーの配置

  • 以下のコマンドを実行してください。 
    $ cp -R /tmp/rgloader /var/rails/redmine

3-2. Timed版 ライセンス管理プラグイン(alm)の配置

  • /tmp/LycheeRedmine にある almのディレクトリ以下のファイルを /var/rails/redmine/plugins に配置するため、以下のコマンドを実行してください。 
    $ cp -R /tmp/LycheeRedmine/alm /var/rails/redmine/plugins

3-3. 必要ライブラリのインストール

  • 以下のコマンドを実行してください。 
    $ cd /var/rails/redmine
    $ bundle install --without 'development test'

3-4. ライセンス管理プラグイン用のテーブル作成

  • 以下のコマンドを実行してください。 
    $ cd /var/rails/redmine
    $ bin/rails redmine:plugins RAILS_ENV=production

3-5. Redmineインスタンスの再起動

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

例

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

4. ライセンス認証

  1. ご使用のRedmine環境に管理権限でログインし、[管理]メニューをクリックしてください。
  2. [Lychee Redmine ライセンス管理]をクリックしてください。
  3. 利用規約が表示されますので、お読みの上、[同意する]を選択してください。
  4. 「認証コード」の入力画面が表示されますので、弊社よりご案内いたしております「認証コード」を入力し、[ライセンスキーを登録]をクリックしてください。
  5. 「ライセンス登録が完了しました」というメッセージが表示されれば、ライセンス登録は完了です。

5. Timed版Lychee Redmineの配置

  • 既に配置済みのライセンス管理プラグイン以外のTimed版Lychee Redmineプラグインを配置するため、以下のコマンドを実行してください。
  • 2.事前準備で展開した「LycheeRedmine」内のプラグインのデータを「plugins」ディレクトリに配置します。 
    $ rm -rf /tmp/LycheeRedmine/alm
    $ cp -R /tmp/LycheeRedmine/* /var/rails/redmine/plugins

6. Timed版Lychee Redmineのインストール

6-1. 必要ライブラリのインストール

  • 以下のコマンドを実行してください。 
    $ cd /var/rails/redmine
    $ bundle install --without 'development test'

6-2. Lychee Redmine　プラグインのDBとリソースファイルのセットアップ

  • 以下のコマンドを実行してください。 
    $ cd /var/rails/redmine # ← Redmineのディレクトリ。お客様の環境に合わせてください
    $ bin/rails redmine:plugins RAILS_ENV=production
    ※Redmine6以上をお使いの場合は↓も実行してください
    $ bin/rails assets:clobber assets:precompile RAILS_ENV=production
     
    補足: サブディレクトリ方式(Sub-URI)で運用されている場合、RAILS_RELATIVE_URL_ROOT の設定が必要です。
     
    例) $ bin/rails assets:clobber assets:precompile RAILS_ENV=production 
    RAILS_RELATIVE_URL_ROOT=/foo # foo はお客様の環境にあわせてください
     
    Sub-URI を使っている場合は rake や bin/rails コマンドを使用する際に常に 
    RAILS_RELATIVE_URL_ROOT の変数をセットが必要になります
    または config.relative_url_root = "/foo" をセットしてください。
    詳細は https://guides.rubyonrails.org/configuring.html#deploy-to-a-subdirectory-relative-url-root を参照してください。

6-3. Redmineインスタンスの再起動

6-4. Lychee製品の有効化

  • 以下のプラグインはプロジェクトごとにモジュールの有効/無効を切り替えられるようになっております。
    • Lycheeスケジュール管理(ガントチャート)
    • Lycheeスケジュール管理(ガントチャート5)
    • Lycheeアジャイル（Neoバックログ）
    • Lycheeスケジュール管理(カンバン)
    • Lycheeスケジュール管理(バックログ)
    • Lycheeスケジュール管理(チケットセット)
    • Lychee工数リソース管理(タイムマネジメント)
    • Lychee工数リソース管理(リソースマネジメント)
    • Lycheeチケット関連図
    • Lycheeコストマネジメント
    • Lychee EVM
    • Lycheeプロジェクトレポート
    • Lycheeカスタムフィールド
    • Lychee CCPM
    • Lycheeダッシュボード
  • 上記プラグインを有効化するには、プロジェクトの[設定]タブにある[モジュール]タブにおいて該当プラグインを有効にしてください。

以上で、Timed版Lychee Redmineのインストールは完了です。

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

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

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

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

補足. Lychee EVM スナップショット作成

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

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

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

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

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

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

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

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

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

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

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

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

    目次

    TOP