インストールおよび設定記録を作る際のバージョン情報の重要性

自分の管理しているメールサーバーでSMTP認証+SMTP over TLSを実現しようと思って、postfix、 cyrus-sasl、OpenSSLをインストールして一生懸命設定をやった。参考にしたのはGoogleで検索して見つけることができた他の方のインストールおよび設定記録。大変参考になったのだが、少しというかかなり問題発声発生。それはそのインストール記録および設定記録がいつの時点で、何のバージョンのときにかかれたものなのかがわからないこと。

管理しているメールサーバーがSolarisなのでソースファイルからのコンパイルでインストールしたのだけれども、使用するソフトウェアのバージョンによってつけるべきフラグや設定項目が違う。このため、postfixを8回ぐらい、cyrus-saslを10回以上コンパイルしてインストールするはめになってしまった。フリーソフトウェアオープンソースソフトウェアは、無料で手に入れられる代わりにドキュメントが不十分であったり、仕様ががらっと変わる場合がよくあるし、それに文句がある人は使ってはいけないもの。なので、自分のメモ代わりとしてでも、インストール記録および設定記録をWeb上で公開するという行為はとても貴重でありがたい。でも、仕様の変更があるのでバージョン情報やそのインストール記録がいつの時点で作成されたのかがわからないと逆に困った事態に陥る。

今回手こずった経験からインストール記録および設定記録を記録してWebで公開する場合には、以下の情報も含めて置くと未来の自分が便利なだけではなく、他の人にとっても、とてもうれしい情報となると思う。

  • 必ずあるべき
    • インストールしたソフトウェアのバージョン情報は何か?
    • どこからダウンロードしてきたのか?
    • 何のプラットフォームにインストールしたのか?(プラットフォームのバージョン情報もあれば素敵)
  • あったらうれしい
  • このインストール記録の作成/更新日
  • configureや設定ファイルをどうしてそのように設定したのかの根拠(ソースドキュメントをリンクしてくれているとうれしい)

Railsチュートリアルのときにも書いたけれどもやはりバージョン情報は重要。ホットなツールや話題ほど更新も早いのでいつの時点での話なのかの情報は必ず入れた方がよい。