Manualmaton's Laboratory

タグ: redmineプラグイン Page 2 of 6

Redmine 5.xにknowlegebaseをインストール。

By

オン 2024年5月25日

カテゴリー: Linux, redmine, ガジェット

筆者にとってRedmineのキラーアプリだったknowlegebase。その5.x対応版が出たので導入を行います。

https://github.com/yzzy/redmine_knowledgebase

環境

  • Ubuntu 22.04
  • Apache 2.4
  • MySQL 8.0.3
  • Redmine 5.1

導入時

  • Gem追加：要
  • DBマイグレーション：要

※Redmine 4.2で実施した設定ファイルの退避や修正は不要でした。

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. 新規ジェムをインストール
  4. DBマイグレーション
  5. Webサービス再起動

ディレクトリに移動します。

cd /home/www-data/redmine/plugins && pwd

自分の環境に合わせます。

プラグインを配置します。

  • git clone
sudo -u www-data git clonehttps://github.com/yzzy/redmine_knowledgebase
  • clone確認
ls -ld redmine_knowledgebase/

このディレクトリがあることを確認します

Gemをインストールします。

  • Redmineのルートディレクトリに移動
cd /home/www-data/redmine && pwd

自分の環境に合わせます。

  • bundle install
sudo -u www-data bundle install

DBのマイグレーションを行います。

  • Redmineのルートディレクトリに移動
cd /home/www-data/redmine && pwd

自分の環境に合わせます。

  • マイグレーション
sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作後の確認

  1. Redmineに管理者アカウントでログインします。
  2. 任意のプロジェクトを選択して設定をクリックします。
  3. モジュール「knowledge」にチェックを入れて保存します。
  4. このように、プロジェクトにナレッジベースのタブが表示されていれば設定完了です。

Redmine: ガントチャートの見た目を調整。

By

オン 2024年5月23日

カテゴリー: Linux, redmine

https://atelier.reisalin.com/projects/ryza3/issues/gantt

メモ帳代わりのRedmineに『ライザのアトリエ3』のクエスト一覧を出しています。

ここのガントチャートが標準だと見切れてしまうので、プラグインで対応します。

プラグイン「redmine_gantt_tweak」

https://github.com/sk-ys/redmine_gantt_tweak

Redmineのプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins && pwd

自分の環境に合わせます。

git cloneを行います。

sudo -u www-data git clone https://github.com/sk-ys/redmine_gantt_tweak

www-dataはredmineの実行ユーザにします。

Redmine(Webサービス)の再起動を行います。

sudo systemctl restart apache2.service

Redmineで設定を行います。

  1. プラグインを導入したRedmineサイトに管理者権限でログインします。
  2. 任意のプロジェクトに移動します。
  3. モジュール「Gantt Tweak」にチェックを入れて保存します。

保存後、「gantt teak」のタブが表示されるので、これをクリックします。

任意の幅（ここでは600）を指定して保存します。

保存後、ガントチャートに移動し、表示幅が広がっていることを確認します。

Redmineにダークモードを追加する。

By

オン 2024年5月20日

カテゴリー: redmine

概要

Redmineにダークモードを追加するプラグインを導入しました。

動作を確認した環境

  • Redmine 4.2
    • Ubuntu 20.04
  • Redmine 5.1
    • Ubuntu 22.04

ともにApache2.4 / MySQLです。

さっくりとした手順

  1. gitでリポジトリをcloneします。
  2. Webサービス(Redmine)の再起動を行います。
  3. 動作を確認します。

Redmineのプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins && pwd

自分の環境に合わせます。

git cloneをします。

sudo -u www-data git clone https://github.com/fraoustin/redmine_dark

サービス再起動を行います。

sudo systemctl restart apache2.service

動作確認

プラグインを入れたRedmineにアクセスすると、画面右上に「dark mode」が表示されるので、これをクリックします。

例：https://atelier.reisalin.com/

クリック後、画面が切り替わればOKです。

  • 再度「dark mode」をクリックすれば元に戻ります。
  • 本プラグインはブラウザから見た目を変更するため、全てのユーザ（未登録ユーザ含む）が利用可能です。

redmine5.1にインストールされているAdditilonals/Addtional_tagsプラグインをアップデート

By

オン 2024年5月1日

カテゴリー: Linux, redmine

概要

Redmineに強力なマクロをもたらすAdditonal Pluginsとタグ付けでチケット間の横断検索を可能にするAdditional_tagsプラグインをアップデートします。

環境

  • Ubuntu 22.04
  • Redmine 5.1
  • Apache2
  • MySQL
  • Ruby 3.0

で稼働しています。

※このプラグインの2024/04/30現在の最新バージョンは、Redmine 4.2には非対応です※

さっくりとした手順

  1. DBのバックアップを取ります。
  2. additonalsのバージョンアップを行います。
  3. additonal_tagsのバージョンアップを行います。
  4. 動作を確認します。

DBバックアップ

影響範囲が大きいので、DBのバックアップは取っておきます。

  • バックアップディレクトリに移動
cd /path/to/backup/directory && pwd

任意のディレクトリを指定します。

  • DBバックアップ
mysqldump -h localhost -u redmine -p --no-tablespaces --single-transaction redmine > redmine_backup.$(date +%Y%m%d).sql
  • u redmineのDBユーザー
  • --no-tablespaces --single-transaction DB名

です。自分の環境に合わせます。

  • DBバックアップ確認
less redmine_backup.$(date +%Y%m%d).sql

内容が閲覧できることを確認します。

Additonalsアップデート

  • プラグインディレクトリに移動
cd /home/www-data/redmine/plugins/additonals && pwd

Redmineのプラグインディレクトリは自分の環境に合わせます。

  • git pull
sudo -u www-data git pull
  • Redmineのルートディレクトリに移動
cd ../../ && pwd
  • bundle
sudo -u www-data bundle install
  • マイグレーション
sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  • Redmine(apache)サービス再起動
sudo systemctl restart apache2.service

Additonal_tagsアップデート

  • プラグインディレクトリに移動
cd /home/www-data/redmine/plugins/additional_tags && pwd

Redmineのプラグインディレクトリは自分の環境に合わせます。

  • git pull
sudo -u www-data git pull
  • Redmineのルートディレクトリに移動
cd ../../ && pwd
  • bundle
sudo -u www-data bundle install
  • マイグレーション
sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  • Redmine(apache)サービス再起動
sudo systemctl restart apache2.service

additonal_tagsがadditonalsに依存しているプラグインのため、安全策として1回ずつ再起動しています。

動作確認

Redmineに管理者権限でログインし、正常に動作することを確認できれば動作完了です。

Redmineサイトの区別。(Watermarkプラグイン)

By

オン 2024年2月26日

カテゴリー: redmine

家と公開用のRedmineで同じテーマを使っているので、「どちらのサイトにいるか」が少し分からなくなります。

そこで、こういうプラグインを付けてみました。

Redmine Watermark

https://github.com/witcan/redmine_watermark

その名の通り、サイト全体にウォーターマークをつけるプラグインです。

インストール

  • Redmineのプラグインディレクトリに移動
cd /var/lib/redminep/pugins && pwd

自分の環境に合わせます。

  • git clone
sudo -u www-data git clone https://github.com/witcan/redmine_watermark
  • サービス再起動
sudo systemctl restart apache2.service

アプリを動かしているサービスを再起動させます。

導入後の設定

Redmineに管理者権限でログイン後、

管理＞プラグイン＞Redmine Watermarkに進みます。

  • Enable watarmark ：チェック
  • ユーザ名や現在日付、テキストなどを入力して保存します。

サイトの背景にすかしが表示されれば設定完了です。

Redmineにチケットの終了日を知らせるプラグイン。

By

オン 2024年2月23日

カテゴリー: Linux, redmine

概要

そのチケットがいつ閉じられたかを詳細に表示させます。

シンプルで便利なプラグインです。

動作を確認した環境

  • Ubuntu 20.04 / Redmine 4.2
  • Ubuntu 22.04 / Redmine 5.1

両方で動きました。また、両方ともApache環境です。

手順

  • ディレクトリ移動
cd /var/lib/redmine/plugins && pwd

自分の環境に合わせます。

  • git clone
sudo -u www-data git clone https://github.com/fraoustin/redmine_closed_date
  • マイグレーション
sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  • サービス再起動
sudo systemctl restart apache2.service
  • 動作確認

クローズしたチケット詳細に「クローズしたチケット」とその日付が出てくればOKです。

再評価の全文検索プラグイン。(Redmine 5.1検証)

By

オン 2024年2月9日

カテゴリー: redmine

Redmine4.2に全文検索プラグインをインストール。(とアンインストール)

ほぼ一年前、涙を呑んでアンインストールした全文検索プラグイン。

事情が変わったので再評価です。

理由1：プラグインでの支障が無くなった

これを諦めた最大の理由は、knowlegebaseプラグインの存在。

各種文書を記録できるこのプラグインは、導入当初：このプラグインがRedmine 4.2までしか対応していないからバージョンを落として使っていたほどです。

ところが5.0以降では（githubでは)使えないということで開き直ることができました。

knogwlegebaseという足かせがなくなれば、

  • チケットを細かく検索できる
  • 設定によって類似したチケットを表示する

このプラグインは高評価となります。

理由2:文書の保管に適したツールを見つけた

Bookstackを見つけたのが思いのほか大きいです。これによって、Wiki形式の文書のストックをこちらに出すことができます。

こちらも全文検索機能付きでバージョン管理も容易。

「使った当初は諦めたけど、事情やバージョンにより評価が変わる」話でした。

Redmine5.1検証-4.2で使っていたプラグインの稼働可否(動いたプラグイン)-

By

オン 2024年1月26日

カテゴリー: redmine

概要

Ubuntu 20.04系のEOLに備えて、Redmineも5.1で動かし筒あります。そんな中で、「今まで使っていたプラグインが動くかどうかを確かめました。

動いたプラグイン

まずは動いたプラグインです。

プラグイン名機能URL備考
Redmine Logsログの表示や削除を行うhttps://github.com/haru/redmine_logs最初に入れます（障害切り分けのため）
Additionals様々なマクロを提供https://github.com/alphanodes/additionals使い勝手が大きく変わります
Additonal Tagsチケットのタグ付けを行うhttps://github.com/alphanodes/additional_tags/上記、Addtionalsが必須です
full_text_searchチケット全文検索https://github.com/clear-code/redmine_full_text_search逆に4.2で動かしていなかったものです
RedMica UI extensionMermaid対応/バーンダウンチャート追加などhttps://github.com/redmica/redmica_ui_extensionこれも最初の方に入れるプラグインです
DMSFファイル機能拡充https://www.redmine.org/plugins/redmine_dmsfRedmineが機能不全に陥る可能性がありますのでインストール時は要注意
Redmine Issue Badge割り当てられているチケットの数を表示https://github.com/akiko-pusu/redmine_issue_badgeモチベーション維持に有用です
Redmine Issue Templateチケットやコメントのテンプレート化https://github.com/agileware-jp/redmine_issue_templates4.2対応版とメンテナが変わっています。
Redmine Local Avatarsアカウントのアイコンを任意の画像に変えるhttps://github.com/ncoders/redmine_local_avatarsこれも個人で使っているならモチベーション維持につながります
Redmine Message Cutomize各種用語を変更しますhttps://github.com/farend/redmine_message_customizeローカライズされていないもの（誤訳）などに対応
Redmine View Customize見た目や機能の拡充など、Redmineにおけるアーミーナイフのような頼れる存在ですhttps://github.com/onozaty/redmine-view-customize非常に優先度が高いプラグインです

動かなかったプラグインやワークアラウンドは後日。

Redmine View Customize Pluginでのアイコンサイズ変更。

By

オン 2024年1月24日

カテゴリー: redmine

やりたいこと

Redmineのチケット表示画面に出てくるこのアイコンを大きくします。

環境

  • Redmine 4.2 Redmine 5.1
  • 要：ViewCustomize Pluginの導入

共通手順

  1. Redmineに管理者権限でログインします。
  2. 管理＞表示のカスタマイズに移動します。
  3. 「新しい表示のカスタマイズ」をクリックします。

カスタマイズ1

以下の通り指定します。

  • パスのパターン:空白
  • プロジェクトのパターン:空白
  • 挿入位置:全ページのヘッダ
  • 種別:JavaScript
  • コード
$(document).ready(function() {
  // 表示環境やテーマに合わせて任意のサイズを指定
$('.gravatar').css('width', '70px').css('height', '70px');
});

コード入力後、有効にして「保存」をクリックします。

設定反映後、

と、サイズが大きくなりました。

しかし、全てに適用されるので

ガントチャートのアイコンもそれに合わせて大きくなります。それを抑制する措置を執ります。

カスタマイズ2

以下の通り指定します。

  • パスのパターン:/gantt
  • プロジェクトのパターン:空白
  • 挿入位置:全ページのヘッダ
  • 種別:JavaScript
  • コード
$(document).ready(function() {
  // 表示環境やテーマに合わせて任意のサイズを指定
   $('.gravatar').css('width', '10px').css('height', '10px');
});

適用後、

ガントチャートのアイコンサイズも設定できました。

まとめ

  • アイコンが全てに及ぶため、かなり乱暴な手を取っています。
  • そのため、カスタマイズを2つ挟む結果になりました。
  • もっとスマートな手があると思いますので、要検証です。

Redmine 5.1にIssue Template Pluginをインストール。

By

オン 2024年1月22日

カテゴリー: redmine

Redmine View Customizeを利用した、チケット作成時の定型文挿入。-1-（Issue Template Pluginのワークアラウンド）

この記事を書いて程なくして、直々に別リポジトリにメンテナが引き継がれていたとの情報を戴きましたので、

早速、インストールします。

環境

  • Ubuntu 22.04
  • Redmine 5.1
  • Ruby 3.0
  • Apache 2.4

導入時

Gem追加：要
DBマイグレーション：要

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. 新規ジェムをインストール
  4. DBマイグレーション
  5. Webサービス再起動

ディレクトリに移動します。

cd /home/www-data/redmine/plugins
# 自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/agileware-jp/redmine_issue_templates

ls -ld redmine_issue_templates

Gemをインストールします。

cd /home/www-data/redmine/plugins
# 自分の環境に合わせます。

sudo -u www-data bundle install

DBのマイグレーションを行います。

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作

  1. Redmineに管理者アカウントでログインします。
  2. 任意のプロジェクトを選択して設定をクリックします。
  3. モジュール「チケットテンプレート」にチェックを入れて保存します。
  4. プロジェクトにチケットテンプレートのタブが表示されていれば設定完了です。

このプラグインの有無がRedmine 5.1に移行できるかの鍵の一つだったので、大いに助かりました。

Page 2 of 6

前

次

Powered by WordPress & Theme by Anders Norén