【Ubuntu20】RedmineでPlantUMLを使う

ネコニウム研究所

PCを利用したモノづくりに関連する情報を掲載するブログ

【Ubuntu20】RedmineでPlantUMLを使う

2022-4-19 | ,

Ubuntu20にインストールしたRedmineでPlantUMLを使ってUML図を描きたい!

概要

この記事では、Ubuntu20にインストールしたRedmineでPlantUMLを使ってUML図を描ける環境を構築する手順を掲載する。

仕様書

環境

  • Ubuntu 20.04 LTS

手順書

環境構築編、Redmine設定編、テスト編の3部構成です。

環境構築編

  1. PlantUML」は「Java」で動く。「JDK」か「JRE」が必要なのでインストールする。下記の例では「JDK」をインストールしてる。
    sudo apt install default-jdk
  2. インストールした「Java」のバージョンを確認する。
    java -version

    私の環境では下記のように出力された。

    openjdk version "11.0.14.1" 2022-02-08
    OpenJDK Runtime Environment (build 11.0.14.1+1-Ubuntu-0ubuntu1.20.04)
    OpenJDK 64-Bit Server VM (build 11.0.14.1+1-Ubuntu-0ubuntu1.20.04, mixed mode, sharing)
  3. 「PlantUML」の実行に必要なパッケージ「graphviz」をインストールする。
    sudo apt install graphviz
  4. 「graphviz」のバージョンを確認する。
    dot -v

    私の環境では下記のように出力された。(バージョンが表記されてる部分)

    dot - graphviz version 2.43.0 (0)
  5. 日本語フォントをインストールする。下記は、「takao」と「IPAフォント」をインストールする例。
    sudo apt install fonts-takao fonts-ipafont fonts-ipaexfont
  6. 「PlantUML」の配布サイトから「PlantUML」をダウンロードする。
  7. ZIPファイルの中の「plantuml.jar」をサーバーの任意の場所にアップロードする。この記事では参考にさせてもらったページと同様に/usr/local/bin/plantuml.jarにアップロードする。
  8. /usr/bin/plantumlを作成して、中身を下記のように入力する。
    #!/bin/bash
    export LANG=ja_JP.UTF-8;
    /usr/bin/java -Djava.io.tmpdir=/var/tmp -Djava.awt.headless=true -jar /usr/local/bin/plantuml.jar  -charset UTF-8 ${@}
  9. /usr/bin/plantumlに権限を設定する。
    sudo chmod 755 /usr/bin/plantuml
  10. Redmineのプラグインをインストールするのに「Git」があると便利なのでインストールする。
    sudo apt install git
  11. インストールした「Git」のバージョンを確認する。
    git --version

    私の環境では下記のように出力された。

    git version 2.25.1
  12. Redmineをインストールしたディレクトリ直下のpluginsに移動する。この記事ではRedmineが/usr/share/redmine/にインストールされてるものとする。
    cd /usr/share/redmine/plugins

    もし、pluginsが存在しない場合は作る。lib/pluginsでは無いので注意!

    mkdir /usr/share/redmine/plugins
  13. 「Git」を使ってプラグインをクローンする。
    git clone https://github.com/dkd/plantuml.git
  14. plantumlの権限を設定する。
    sudo chown -R $USER:$USER plantuml
  15. Redmineをインストールしたディレクトリに戻る。
    cd /usr/share/redmine
  16. Redmineにプラグインを読み込む。
    sudo bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  17. Redmineをインストールしたディレクトリ直下のfilesの権限や所有権を設定する。この記事ではRedmineが/usr/share/redmine/にインストールされてるものとする。
    sudo chmod 755 /usr/share/redmine/flies
    sudo chown -R www-data:www-data /usr/share/redmine/flies

    もし、filesが存在しない場合は作る。

    mkdir /usr/share/redmine/files
  18. Apacheを再起動する。
    sudo systemctl restart apache2

Redmine設定編

  1. ブラウザでRedmineにアクセスして「管理」->「プラグイン」を開く。
  2. 「PlantUML plugin for Redmine」の行の右側にある「設定」をクリックする。
  3. 「PlantUMLのパス」に/usr/bin/plantumlと入力して「適用」をクリックする。

テスト編

  1. Wikiに下記を入力する。
    {{plantuml(png)
    Bob -> Alice : hello
    }}
  2. 「保存」をクリックして下記のような画像が表示されればOKだ!

まとめ(感想文)

RedmineでいろんなUML図を描きまくれば良いじゃん!

ちなみに下記の記事の環境で動作確認してるよ!

引用・参考文献

下記のページを参考にさせていただきました。ありがとうございました。