Redmineの導入と初期設定まとめ｜インストール・テーマ・メール通知

はじめに

Redmineは入れただけでは使いにくく、管理画面での初期設定をひととおり済ませて実用になります。導入から設定までの流れをまとめました。

環境は Ubuntu 22.04 LTS、Redmine 5.1.1 / Ruby 3.2.3 での作業記録です。

Ubuntuにインストールする

公式のRedmine 5.0 をUbuntu 22.04 LTSにインストールする手順に沿って進められます。バージョンだけ適宜読み替えてください。

管理画面での初期設定

管理 > 設定から、最低限やっておくとよい項目です。

全般

• ホスト名とパス … 実際のホスト名に変更する
• プロトコル … HTTPSに変更する
• テキスト書式 … CommonMark Markdown (GitHub Flavored) に変更する

テキスト書式は、後から変えると既存チケットの表示が崩れます。使い始める前に決めてください。

表示

• テーマ … 後述
• デフォルトの言語 … Japanese (日本語)
• 添付ファイルのサムネイル画像を表示 … チェックを入れる

認証

• 認証が必要 … 「はい」に変更する

これを設定しないと、ログインしていない人にもチケットが見えます。社内利用でも最初に変更してください。

プロジェクト

• デフォルトで新しいプロジェクトは公開にする … チェックを外す

チェックが入ったままだと、新規プロジェクトが既定で全体公開になります。作成のたびに気づけるものではないので、ここで切っておきます。

ユーザー

• 追加メールアドレス数の上限 … 0 に変更する

ファイル

• 添付ファイルとリポジトリのエンコーディング … UTF-8,CP932,EUC-JP を追加する

日本語のファイル名や、Windowsで作られたテキストを扱うなら入れておきます。これがないと文字化けします。

リポジトリ

• 参照用キーワード … 末尾に * を追加する

コミットメッセージからチケットを参照するときのキーワード設定です。

参考: Redmineを使い始めるための初期設定

テーマを適用する

標準テーマは情報量が多く見づらいので、変更をおすすめします。ここでは circle テーマを例にします。

1. テーマフォルダをサーバーへ転送する（WinSCPなど）

2. www-data ユーザーでテーマディレクトリにコピーする

$ sudo -u www-data cp -r circle /var/lib/redmine/public/themes

3. Apacheを再起動する

$ sudo systemctl restart apache2

4. 管理 > 設定 > 表示でテーマを選択する

メール通知を設定する

config/configuration.yml で設定します。ファイルがない場合はサンプルからコピーして作ります。

# 場所が分からないときは探す
$ find / -name configuration.yml -print

# サンプルからコピーして作成する
$ sudo -u www-data cp config/configuration.yml.example config/configuration.yml

TLSを使うSMTPサーバー（SendGridの例）の設定です。

default:
  email_delivery:
    delivery_method: :smtp
    smtp_settings:
      enable_starttls_auto: true
      address: "smtp.sendgrid.net"
      port: 587
      domain: "smtp.sendgrid.net"
      authentication: :plain
      user_name: "apikey"
      password: "YOUR API KEY"

設定後にApacheを再起動します。

$ sudo systemctl restart apache2

YAMLはインデントに厳密なので、タブではなくスペースを使ってください。インデントが崩れているとRedmineが起動しなくなります。

おわりに

Redmineは設定項目が多いぶん、最初にまとめて済ませておくと後が快適です。特に「認証が必要」と「新規プロジェクトを公開にしない」の2つは、気づかないまま運用すると情報が見えてしまうので、導入直後に確認しておいてください。