変更履歴

それは、すまんの_(.__.)_の記録……

項番	版	変更日	変更内容
1	v1.0.0	2023-06-07	初版作成
2	v1.0.1	2023-06-10	nginxのpassenger設定を修正シンボリックリンクのコマンドを修正

ITSが欲しい!!切実に

皆さんの会社は課題管理システム使ってますか?
私は

自分のタスクの総量が把握できなくなる
どれから手を付けるか悩むときがある
締め切りをしばしばプッチする
炎上具合がわからない
というマネジメントダメダメマンなので「難しいことは全部システムに任せた!!」と今までやってきました。
この度、プロジェクト運営を考えていくうえで、上のようなお悩み点が噴出してしまい「もうやだ……Redmine入れよ……」と久しぶりに(5年ぶり4回目くらい) Ubuntu Server 22.04上にRedmineを構築してみました。
私史上初の試みで「ApacheもいいけれどNginxもよくない?」とちょっと調べてみたところ、NginxだとApacheでやっていた「httpの80番で受け取ったリクエストをRubyの3001番に回す」みたいなのをしないでNginxがAPサーバーみたいなことをしてくれるらしいので、その方向で構築してみました。

前提条件と環境

仮想環境: Hyper-V
ホストOS: Windows10 (21H2)
ゲストOS: Ubuntu 22.04 Jammy Jerryfish
Nginx: 1.18.0
Passenger: 6.0.17
PostgreSQL: 14+238

作業手順

1. インストール用のisoのダウンロードと仮想マシンの作成

何はなくとも公式からisoデータをダウンロードしてきます。
記事作成時点(2023年06月03日ですとUbuntu 23.04も公開されていますが、今回は以前触ってた(そしてGitLab運用してた)という理由でUbuntu 22.04を選択しました。
続いて、Hyper-Vマネージャーを開いて(Hyper-Vマネージャーの有効化についてはこちら(Microsoft Learn)を参照)第2世代で仮想マシンを作成していきます。

久しぶりでハマったのが「トラステッドプラットフォームモジュールを有効にする」にしないと上手いこと接続して画面が表示できなかったことでしょうか。
ウィザード作成後に「設定」を開いてここの設定。

2. Ubuntuの起動と初期設定

Hyper-Vの仮想マシンが作成出来たら、さっそく起動していきます。
初期設定は普通で(参考サイトを参考文献に入れました)。途中で固定IPアドレス設定だけはしておきました。
更新をかけながらインストールすることもできますが、今回は「後でaptで更新しよう」という方針でインストールを優先。

3. 環境固有の設定

ここからはRedmine.JPさんのblog記事を参考に作業していきます。

3.1 ロケールの設定

PostgreSQLで日本語を取り扱うための設定だそうです(latin1問題……苦しんだなぁ)

ロケールにja_JP.UTF-8を追加＆確認

$ sudo locale-gen ja_JP.UTF-8
$ locale -a
# こんな感じで"ja_JP.utf8が含まれる
C
C.UTF-8
POSIX
en_US.utf8
ja_JP.utf8

3.2 タイムゾーンの設定

標準だと日本になっていないみたいなので、timedatectlで設定します。

タイムゾーンをAsia/Tokyoに設定

$ timedatectl set-timezone Asia/Tokyo

3.3 パッケージの更新

パッケージは全部aptで導入します。システムの更新もありますので、一度apt full-upgradeをかけてから必要なパッケージを導入します。

パッケージの更新と導入

$ sudo apt update
$ sudo apt -y full-upgrade
# ここでゴリっとシステム関係の更新が入ると思うので、更新が終わったら一度再起動して再ログインします。
$ sudo reboot now
# --------
# さ　い　き　ど　う
# --------
# ここから再起動後。パッケージリポジトリの内容は変わらないと思うけれどもおまじない的に更新
$ sudo apt update
# RubyとPassengerのビルドに必要なものを導入
$ sudo apt install -y build-essential zlib1g-dev libssl-dev libreadline-dev libyaml-dev libcurl4-openssl-dev libffi-dev
# PostgrerSQLとヘッダファイルの導入
$ sudo apt install -y postgresql libpq-dev
# 日本語フォントの導入
$ sudo apt install -y imagemagick fonts-takao-pgothic
# バージョン管理システム(SubversionとGitの導入∵Redmineをリポジトリから引っ張ってくるのでsvnを入れます)
$ sudo apt install -y subversion git

3.4 Rubyをビルドしてインストール

私が「ルビーわからんおじさん」なので「aptで入らんのですか??」と思いつつ、ソースコードからビルドしてインストールします。
尚、Redmine のtrunk版ではRuby 3.2系が使えるらしいですが(Redmineの使用推奨環境)安定板では3.1系までだそうなので、公式の安定版である3.1.4を使用します。

Rubyのソースコードをダウンロードしてインストールするまで

# ホームディレクトリで作業することを想定
$ pwd
/home/fattoton/
# curlコマンドでソースコードをダウンロードします
$ curl -O https://cache.ruby-lang.org/pub/ruby/3.1/ruby-3.1.4.tar.gz
# tarコマンドで解凍(gzだけれどもxvfでいけた)
$ tar xvf ruby-3.1.4.tar.gz
# 解凍したフォルダーに移動
$ cd ./ruby-3.1.4

# ソースコードのビルドとインストール
# ----  ここから  ----
$ ./configure --disable-install-doc
$ make
$ sudo make install
# ----  ここまで  ----

# インストール完了後にRubyのバージョンを確認
$ ruby -v
ruby 3.1.4p223 (2023-03-30 revision 957bb7cb81) [x86_64-linux]

3.5 NginxとPassengerの導入

Passengerはinstall gem passengerで導入することもできますが、提供元であるPhusionのマニュアルによれば「aptにリポジトリを追加してそっから突っ込んでね!!(意訳)」ということらしいので英語を見ながらぽちぽちやっていきます。
ここで結構悩んだんですが(よくよく考えれば当たり前な話)NginxとPassengerそれぞれを導入するだけではダメで、それらの間をつないでやるライブラリが必要です。
図にするとこんな感じ

あとは古い情報だと、キーチェーンを使わないでPGP暗号鍵をストアする方法も出てくるんですが、それだと「もうそのやり方やめてって言ったでしょ～💢」とUbuntuに怒られたので、公式ででてる今っぽい(?)やり方で導入してます。

Nginxとpassengerの導入

# PGP暗号鍵の復号とhttps経由でのダウンロードをするために必要なモジュールの導入
$ sudo apt install -y dirmngr gnupg apt-transport-https ca-certificates curl
# 暗号鍵のダウンロードとキーチェーンへの登録
# (最後出力を/dev/nullに突っ込んでるのはバイナリファイルの内容をコンソールに表示させないため)
$ curl https://oss-binaries.phusionpassenger.com/auto-software-signing-gpg-key.txt | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/phusion.gpg >/dev/null
# aptにリポジトリを追加
$ sudo sh -c 'echo deb https://oss-binaries.phusionpassenger.com/apt/passenger jammy main > /etc/apt/sources.list.d/passenger.list'
# aptの情報を更新
$ sudo apt update

# (1)Nginx, (2)Passenger, (3)Passenger+Nginxのライブラリの順で導入
$ sudo apt install -y nginx
$ sudo apt install -y passenger
$ sudo apt install -y libnginx-mod-http-passenger

# libnginx-mod-http-passengerの設定ファイルがあるか確認の上シンボリックリンクをうまい具合につくってくれる
$ if [ ! -f /etc/nginx/modules-enabled/50-mod-http-passenger.conf ]; then sudo ln -s /usr/share/nginx/modules-available/mod-http-passenger.load /etc/nginx/modules-enabled/50-mod-http-passenger.conf ; fi
$ sudo ls /etc/nginx/conf.d/mod-http-passenger.conf

ここで公式によると「もしも/etc/nginx/conf.d/mod-http-passenger.confがなかったら自分で作ってね!!」だそうで

mod-http-passenger.conf

passenger_root /usr/lib/ruby/vendor_ruby/phusion_passenger/locations.ini;
passenger_ruby /usr/bin/passenger_free_ruby;

というのが要ることが稀にあるらしい。私は遭遇しなかったので無視して問題ないとは思います。
以上でNginx, Passenger, libnginx-mod-http-passengerが導入できたので、systemdでサービスを再起動してやります。

Nginxのサービスを再起動して状態を確認

# サービス再起動
$ sudo systemctl restart nginx
# サービスのステータス確認
$ sudo systemctl status nginx
# Passengerの動作状態確認
$ sudo passenger-memory-stats

こんな感じの表示が出てきます(Apache動いてないって言ってるけれどもこれはどうすればいいんでしょうね??)

3.6 データベースの設定

PostgreSQLにRedmineが使用するユーザーを作成したあと、Redmine用のデータベースを作成します。

PostgreSQLにRedmine用の設定を実施

# PostgreSQLにユーザーredmineを追加
$ sudo -i -u postgres createuser -P redmine
# パスワードを設定するように求められます
Enter pasword for new role:   # PostgreSQLにユーザー名redmineでアクセスする際のパスワードを入力
Enter it again:               # パスワードを再入力

# PostgreSQLにデータベースを作成
# ここで一番最初にやった"ja_JP.UTF-8"を使う
$ sudo -i -u postgres createdb -E UTF-8 -l ja_JP.UTF-8 -O redmine -T template0 redmine

3.7 Redmineのダウンロード

Redmineのセットアップの流れを一応おさらい的に書いておくと、

すごーく昔のRedmine
- 手作業でGemを一つずつ流し込むんで超めんどい
  & Gem間で依存パッケージの管理ができてなくて(プラグインで)時々詰む
bundlerが導入されてからのRedmine
- Gem.lockの中にバージョン指定が書いてあるからあとはbundlerが良きに計らってくれるよ!!
  何なら特定の場所にGemを配置して複数のRubyの環境が同居できるようになるよ!!

という感じなので、どのみちRedmineをダウンロードしたらあとは勝手に動くわけではないのです。わけのわからないエラーで苦しまなくなったのでだいぶ楽になったけどね。
なのでRedmineを特定のフォルダーにダウンロードして、設定ファイルをいじってからGemをbundlerで導入します。
今回はRedmine.JPさんの記事と同じ/var/lib/redmineにファイルを配置します¹。

RedmineをRedmine.orgからチェックアウト

sudo mkdir /var/lib/redmine
sudo chown www-data /var/lib/redmine
# redmine.orgからver.5.0の安定版を/var/lib/redmine/以下にダウンロード
sudo -u www-data svn co https://svn.redmine.org/redmine/branches/5.0-stable /var/lib/redmine

3.8 database.ymlとconfiguration.ymlの設定

RubyからPostgreSQLへ接続するための接続情報と、メール配信や添付ファイルの保存領域などの設定をそれぞれファイルに記載します。
それぞれ
/var/lib/redmine/config/database.yml.example
/var/lib/redmine/config/configuration.yml.example
というお手本のファイルがあるのでコピーして拡張子の.exampleを取って使うと楽です。

設定ファイルをコピーして作成

#作業ディレクトリの確認
$ pwd
/var/lib/redmine/config/
# /var/lib/redmine以下の所有者がwww-dataなので、sudoにユーザーを指定して実行
$ sudo -u www-data cp ./database.yml.example ./database.yml
$ sudo -u www-data cp ./configuration.yml.example ./configuration.yml

database.yml

production:
  adapter: postgresql
  database: redmine
  host: localhost
  username: redmine
  password: "********" # 3.6で設定したPostgreSQLにアクセスするためのパスワード
  encoding: utf8

confiugration.yml

default:
  # 今回はメール送信は設定しなかったので割愛
  # email_delivery:
  #   delivery_method: :smtp
  #   smtp_settings:
  #     address: "localhost"
  #     port: 25
  #     domain: "example.com"
  # 添付ファイルの保存フォルダーを設定
  attachements_storage_path: /var/lib/redmine/files
  # バージョン管理システム(使用するもののみ)のコマンドを設定
  scm_git_command: git
  # 日本語用フォントを設定
  rmagick_font_path: /usr/share/fonts/truetype/takao-gothic/TakaoPGothic.ttf

3.9 Redmineで使用するRuby Gemの導入

bundlerを使ってGemを導入します。

bundlerでGemを導入

$ cd /var/lib/redmine
# オプションの--without development testをつけることでProduction版以外の環境の作成を抑止する
$ sudo bundle install --without development test

3.10 Redmineを起動させるための設定

セッション改ざん防止用秘密鍵とデータを保存するためのテーブルを作成します。

秘密鍵とテーブルの作成

# 【重要】必ずRedmineのルートディレクトリで実施すること
$ pwd
/var/lib/redmine/
# セッション改ざん防止用秘密鍵の作成
$ sudo -u www-data bin/rake generate_secret_token
# PostgreSQLのデータベースにテーブルを作成
$ sudo -u www-data RAILS_ENV=production bin/rake db:migrate

3.11 Nginxの設定

Nginxで公開するサイトの設定をします。
にわか知識の理解で書くと

Nginxの設定ファイルの大元は/etc/nginx/nginx.conf
nginx.confの中でプラグインの設定は/etc/nginx/conf.d/*.confから、Virtual Hostの設定は/etc/nginx/sites-enabled/*からそれぞれ参照して読み込む
/etc/nginx/sites-enabled/以下には/etc/nginx/sites-available/以下にある.confファイルへのシンボリックリンクを配置することで、サイトを簡単に挿げ替えできるようになっている(シンボリックリンクの向きを変えるだけで良い。
ということらしいです。
図にするとこんな感じ。

ただ、最初は当然redmineというシンボリックリンクはなく、defaultという名前のファイルがあるだけなので

defaultを削除
redmine_server.confを作る
シンボリックリンクをredmineという名前で作る
をやってやります。

nginxの設定

# 作業フォルダーは/etc/nginx/
$ pwd
/etc/nginx/
# 先にnginxのサービスを止める
$ sudo systemctl stop nginx
# シンボリックリンクの削除(rmでもできるけれどもunlinkで)
$ unlink ./sites-enabled/default
# sites-availableにあるdefaultの設定を名前を変えてコピーしてやる
$ cp ./sites-available/default ./sites-available/redmine.conf
# シンボリックリンクの作成(フルパスで指定してね(^o^)/)
$ ln -s /etc/nginx/sites-available/redmine.conf /etc/nginx/sites-enabled/redmine

あとはdefaultをコピーして作ったredmine.confの中身を修正してやります。

redmine.confでServerの設定

server {
    listen 80;
    server_name redmine;
    # passeengerを有効に設定
    passenger_enabled on;
    # passengerに指定するrubyのインストールパス
    passenger_ruby /usr/local/bin/ruby;
    # Redmineを実行するためのルートディレクトリの設定
    root /var/lib/redmine/public;
}

修正が完了したらnginxを起動する前に必ず文法チェックを通しましょう(通さないでnginxが起動せず苦しんだ)。

Nginxで設定ファイルの文法チェック

$ sudo nginx -t
# 問題なければ以下のように表示される
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

ここまで来たらnginxのサービスを起動してブラウザーでページにアクセスしてログイン画面が出れば完了です。

nginxのサービス起動とステータス確認

sudo systemctl start nginx
sudo systemctl status nginx

感想

Nginxの設定が思った以上にあっさり行ったのは驚きでした。
逆にハマったポイントとしては

よく訳が分かっていない状態でsudo apt install passengerとsudo gem install passengerを両方やって見事にぶつかった。何なら途中でpassengerに「なんか2つ入ってるんですけど?💢」と怒られた
NginxとPassengerとlibnginx-mod-http-passengerの関係がよくわからず3回くらい入れたり消したりして、途中で/etc/以下の設定ファイルを手で消したらもうどうしようもなくなってサーバーをつぶしてもう1回作り直した(aptって --purgeしても設定ファイルから作り直ししてくれないの……)
勇み足でRuby 3.2.2を入れたらbundlerに冷たく「つかえねーっつーの」と怒られた
という所でしょうか?
兎にも角にもこれで手順が固まったのでまたあちこちにRedmine(に限らず課題管理システム)を布教していきたいなぁと思う所です。

参考文献

個人的には以前は/opt/redmine/とかに置いてたけれども、どこに置くのが正解なんですかね?? ↩