タグ: view_customize_plugin

RedmineのView Customize Pluginを利用して、ちょっとだけサイトを装飾してみました。

やったこと

このように、Redmineサイトのヘッダに画像を入れました。

https://atelier.reisalin.com/

前提

• Redmine View Customize Pluginが導入済みであること。
• https://atelier.reisalin.com/projects/zettel/knowledgebase/articles/31

画像ロゴを用意します。

用意した後、適切な箇所にアップロードします。（筆者はDMSFプラグインでアップロードしています）

表示を変更していきます。

画面遷移

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

設定

以下の通り設定します。

• パスのパターン:
• 空白
• プロジェクトのパターン:
• 空白
• 挿入位置:
• 全ページのヘッダ
• 種別
• CSS
• コード

#header {
background-image: url("画像への適切なパス");
background-repeat: no-repeat;
background-size: contain;
background-position: 80% center;
height: 100px; 
/* 位置・高さはサイトやテーマに合わせてください */
}

設定後、「有効」にチェックを入れて「作成」をクリックします。

表示を確認します。

ヘッダに設定した画像が出てくれば成功です。

概要

こちらの「matomoとRedmineの連携」にて「view_customize_pluginで設定がうまくいなかった」件について、Redmine_jpの代表様から直々のコメントをいただきました。

View Customizeプラグインでのトラッキングコード挿入がうまくいかなかった件、matomoで生成したトラッキングコードから と の計2行を削除するとうまくいきそうな気がします。

アクセス解析システムmatomoとredmineの連携。コメント

これを元に設定を行いました。

実施した手順

さっくりとした手順

1. SSHクライアントからベースファイルの切り戻しを行います。
2. RedmineのWeb画面「表示のカスタマイズ」から再設定を行います。
3. matomo管理画面からアクセス解析が有効であることを確認します。

前提

• Redmine上にview_customize_pluginが導入済みであること。
  • (インストール方法については筆者管理の公開用Redmineで紹介しています)
• ウェブ解析システムmatomoが導入済みであり、対象Redmineのトラッキングコードを控えていること。

Redmineサーバで実施する作業

ベースファイルのバックアップから切り戻しを行います。

sudo cp -pi /path/to/backup/directory/base.html.erb.$(date +%Y%m%d --date '1 Day ago') /var/lib/redmine/app/views/layouts/base.html.erb
# 変数「date」でバックアップを取っているので、作業した日付に修正します
# 2日前なら'2 Days ago'、1週間前なら'1 Week ago'、3年前なら'3 Years ago'など応用が利きます

diff -u /path/to/backup/directory/base.html.erb.$(date +%Y%m%d --date '1 Day ago') /var/lib/redmine/app/views/layouts/base.html.erb
# バックアップと差分がないことで切り戻しを確認します

切り戻し後にWebサービスの再起動を行います。

sudo systemctl restart apache2.service

aystemctl status apache2.service

# 自分が使っているWebサービスに合わせます

Redmine管理画面で実施する作業

Redmineに管理者アカウントでログインします。

1. 管理＞表示のカスタマイズに進みます。
2. 「新しい表示のカスタマイズ」をクリックします。

トラッキングコードを設定します。

• パスのパターン：空白
• プロジェクトのパターン：空白
• 挿入位置：全ページのヘッダ
• 種別：JavaScript
• コード：matomoで提示されたトラッキングコードから、「上部の<script>と下部の </script>を外したコード

設定後、「有効」にチェックを入れ「保存」をクリックします。

保存後、Redmineサイト内のページをいくつか表示させます。

Web解析システムmatomoで実施する作業

解析対象のRedmineで解析されていることを確認します。

今回の学び

• ダメだった手順を載せることに意義がありました。
• ソース修正の時に「ヘッダを確認する」のところで、「view_customize_pluginで設定済みの他のヘッダ」を確認すべきでした。そうすれば、設定の誤りに気づくことができました。