WebRelease 2.70M インストールマニュアル (OS X / macOS 用)

本マニュアルでは WebRelease 2.70M を OS X (Server) または macOS にインストールする方法を説明しています。以下の説明をお読みの上 WebRelease 2.70M のインストールを行なってください。

1 動作環境

WebRelease 2.70M をインストールして稼働させるサーバには下記の条件を満たす稼働環境をご用意ください。

1.1 オペレーティングシステム

WebRelease 2.70M は以下のいずれかの OS を塔載したマシンにインストールして使用してください。

WebRelease 2.70M は OS X (Server) v10.8.2 以前にはインストールできません。

WebRelease 2.70M は以下の構成にはインストールできません。

OS X と OS X Server の組み合わせでお使いになる場合には、OS X の上に、先ず OS X Server をインストールし、その後で WebRelease をインストールしてください。WebRelease インストール後に OS X Server をインストールした場合、再度 WebRelease 2.70M をインストールしなおしてください。

OS は最新の状態になるようにアップデートを適用しておいてください。

1.2 必要メモリ容量

マシンのメモリ容量は WebRelease の性能を大きく左右します。なるべく多くのメモリを搭載したマシンでご利用ください。最小でも 1G Byte 以上のメモリを搭載したサーバをご用意ください。2G Byte 以上を推奨致します。

ごく大雑把な目安として 10,000 ページあたり 4G Byte 程度のメモリをご用意頂くと WebRelease を快適にご利用頂けるようです。

サーバに搭載されている実メモリの内どれだけを WebRelease に割り当てるかを指定するために WebRelease の起動パラメタを調節する必要があります。インストール終了後、後述の「動作メモリサイズの設定」に従って WebRelease に割り当てるメモリサイズの指定を行ってください。

1.3 必要ディスク容量

WebRelease は稼働のためのユーザアカウント wr2 を作成して使用します。WebRelease をインストールするとインストーラがサーバ上に同アカウントを自動作成します。

ユーザ wr2 のホームディレクトリ下には WebRelease のアプリケーション本体がインストールされます。また、WebRelease2.storage というサブディレクトリが作成され、そこには WebRelease の運用に必要となる全てのデータが格納されるリポジトリが構築されます。

ユーザ wr2 のホームディレクトリ下には WebRelease で管理したいと考えているコンテンツ総量の 10 倍以上のディスク容量を確保してください。たとえば、公開サーバー上で 3G Byte 程度となるであろうコンテンツを WebRelease で運用管理したい場合には、ユーザ wr2 のホームディレクトリ以下に 30G Byte 以上の領域を確保してください。

この必要ディスク容量の値は目安です。この値はコンテンツ構成や更新頻度、各種ログの保存状況などにより変化します。WebRelease の運用を開始したらディスク残量については随時監視を行ない、ユーザ wr2 のホームディレクトリ以下のディスク消費量と同量以上の空きディスクスペースを維持した状態で WebRelease を運用してください。

ユーザ wr2 のホームディレクトリは必ずローカルディスク上になければなりません。もし、WebRelease のインストーラを実行した結果、ユーザ wr2 のホームディレクトリが NAS (Network Attached Storage)上に作られてしまった場合には、運用を開始する前に、同ユーザのホームディレクトリをローカルディスク上に移動してください。この際、インストーラが作成したユーザ wr2 のホームディレクトリ下のファイルをすべて移動先の新ホームディレクトリに移動する必要があります。

2 HTTP サーバ Apache の準備

WebRelease は HTTP サーバの Apache と連携して動作します。WebRelease のインストール作業を開始する前に Apache の準備を行ってください。

OS X v10.8
OS X v10.9 の場合

Apache の設定はシステムの設定ファイルを修正して行います。この修正作業にはシステム管理者権限が必要です。sudo コマンドなどを併用して作業を行ってください。

# vi /System/Library/LaunchDaemons/org.apache.httpd.plist

ファイル先頭付近にある下記の部分

   <key>Disabled</key>
   <true/>

を下記のように書き換えます。

   <key>Disabled</key>
   <false/>

true を false に書き換えます。

この変更を加えると OS を起動時に apache が自動起動するようになります。

OS X v10.10
OS X v10.11 の場合

Apache は下記のコマンドで自動起動するように設定します。このコマンドの実行にはシステム管理者権限が必要です。sudo コマンドなどを併用して作業を行ってください。

# launchctl load -w /System/Library/LaunchDaemons/org.apache.httpd.plist

このコマンドを実行すると apache が起動します。また、次回 OS 起動時に自動起動するようになります。

macOS Sierra v10.12
macOS High Sierra v10.13
macOS Mojave v10.14 の場合

まず、mod_proxy を有効にする設定を行います。macOS Sierra v10.12, macOS High Sierra v10.13 および macOS Mojave v10.14 では、デフォルトでは apache の mod_proxy は有効になっていませんのでそれを有効にしておきます。/etc/apache2/httpd.conf を編集して設定を行います。作業には管理者権限が必要です。sudo コマンドなどを併用して作業を行ってください。

# vi /etc/apache2/httpd.conf

httpd.conf の中の mod_proxy 関連のコメントを外します。

#LoadModule proxy_module libexec/apache2/mod_proxy.so

の行頭の # を外して下記のようにします。

LoadModule proxy_module libexec/apache2/mod_proxy.so

少し下に、もう一ヶ所あります。

#LoadModule proxy_http_module libexec/apache2/mod_proxy_http.so

の先頭の # を外して下記のようにします。

LoadModule proxy_http_module libexec/apache2/mod_proxy_http.so

修正を終えたらファイルを保存してください。

次に、Apache を下記のコマンドで自動起動するように設定します。このコマンドの実行にはシステム管理者権限が必要です。sudo コマンドなどを併用して作業を行ってください。

# launchctl load -w /System/Library/LaunchDaemons/org.apache.httpd.plist

このコマンドを実行すると apache が起動します。また、次回 OS 起動時に自動起動するようになります。

OS X v10.8 + OS X Mountain Lion Server
OS X v10.9 + OS X Server
OS X v10.10 + OS X Server
OS X v10.11 + OS X Server の場合

Apache の設定は「Server」ツールの「Web」パネルで行います。パネルにある「Web サーバ」のスイッチを「入」側にすると Apache が稼動を開始します。

OS X v10.8, v10.9 の場合、Apache を稼動状態にすると、そのマシン上にアカウントを持つユーザのホームディレクトリ下にある Sites というディレクトリ以下が Apache 経由で外部に公開されるようになります。例えば、ユーザ admin のホームディレクトリにある Sites というディレクトリの内容が http://<your.computer>/~admin という URL で Apache 経由で公開されるようになります。

Apache は稼働させたいが「ユーザの Sites の公開」は行いたくない、という場合は Apache に mod_userdir が組み込まれないように httpd.conf の設定を変更してください。設定変更の手順は下記の通りです。

  1. /etc/apache2/httpd.conf を編集します。管理者権限が必要なので sudo コマンドを併用すると良いでしょう。

    % sudo vi /etc/apache2/httpd.conf
    
  2. 下記の行がある場合、行の先頭に # を入れて行をコメントアウトします。

    ....
    # LoadModule userdir_module     libexec/apache2/mod_userdir.so
    ...
    
  3. また、下記の行がある場合、行の先頭に # を入れて行をコメントアウトします。

    ....
    # LoadModule apple_userdir_module libexec/apache2/mod_userdir_apple.so
    ...
    
  4. さらに、下記の行がある場合、それもコメントアウトします。

    ....
    # Include /private/etc/apache2/extra/httpd-userdir.conf
    ...
    
  5. 修正結果を保存します。

この修正を加えた後に Apache を再起動すると「ユーザの Sites の公開」の動作が止まります。Apache を再起動するときにはシステムを再起動してください。

Apache の準備はこれで完了です。ブラウザで http://<your.computer>/ にアクセスしてみて Apache が稼働しているかどうか確認しておいてください。

Apache の安全確実な稼動のために、お使いの OS に附随するドキュメントや Apache のマニュアルを参考に httpd.conf の設定内容を確認し、必要があれば設定変更を行なった上でシステムを運用してください。

apache に対して SSL や アクセス制限などの諸設定を行いたい場合には、一旦 WebRelease のインストールと動作確認までを終えた後で諸設定を行うことをお薦めします。

3 WebRelease 2.70M のインストール

ディレクトリ OS-X に置かれているパッケージ WebRelease2.pkg をダブルクリックしてください。その後はインストーラの指示に従ってインストールしてください。インストールの最後でマシンを再起動してください。

参考:インストーラの実行内容の概要は下記の通りです。

  1. ユーザ wr2 の作成

    WebRelease が稼働するために必要となるユーザ wr2 を作成します。このインストールがアップグレードインストールであり、既にユーザ wr2 が作成されている場合にはユーザ wr2 の作成は行われません。

  2. 稼働中の WebRelease の停止

    稼働中の WebRelease がある場合にはそれを停止します。

  3. WebRelease のインストール

    ユーザ wr2 のホームディレクトリに WebRelease2 と ThirdPartyProducts という二つのディレクトリを作成し、そこに WebRelease の稼働に必要な全てのプログラムをインストールします。

    ディレクトリ WebRelease2 には WebRelease の本体がインストールされます。

    ディレクトリ ThirdPartyProducts には Tomcat、Oracle Java Runtime Environment、JavaMail、ganymed-ssh2 等の、他社製のソフトウェアがインストールされます。

    WebRelease はここにインストールされている Tomcat や JRE を使います。プラットフォームにインストールされている他の Tomcat や JRE は使用しません。

  4. 自動起動ファイルの設定

    マシンが起動した時に自動的に WebRelease がサービスを開始するように設定されます。下記のディレクトリが作成され、その中に自動起動に必要なスクリプトが納められます。

    OS X v10.8, v10.9 の場合
    /Library/StartupItems/WebRelease2
    OS X v10.10, v10.11, macOS Sierra v10.12, macOS High Sierra v10.13, macOS Mojave v10.14 の場合
    /Library/LaunchDaemons/jp.co.frameworks.WebRelease2.plist
  5. 旧バージョンの WebRelease 関連ファイルの削除

    旧版の WebRelease がインストールされていた場合、それらのバージョンが使用していたファイルを全て削除します。

    ユーザ wr2 のホームディレクトリに保持されている旧版を使用して作成したコンテンツデータ WebRelease2.storage は削除されることなくインストールした新版に引き継がれます。

  6. Apache と WebRelease の接続のための mod_proxy の設定

    OS X v10.8, v10.9, v10.10, v10.11, macOS Sierra v10.12, macOS High Sierra v10.13, macOS Mojave v10.14 の場合

    apache と WebRelease の接続に使用する mod_proxy の設定のために、/etc/apache2/other/webrelease2.conf というファイルが以下の内容で作成されます。

    <IfModule mod_proxy.c>
      ProxyPass             /WebRelease2    http://127.0.0.1:50002/WebRelease2
      ProxyPassReverse      /WebRelease2    http://127.0.0.1:50002/WebRelease2
      ProxyTimeout          1800
    </IfModule>
    
    OS X v10.8 + OS X Mountain Lion Server
    OS X v10.9 + OS X Server
    OS X v10.10 + OS X Server の場合

    apache と WebRelease の接続に使用する mod_proxy の設定のために、 /Library/Server/Web/Config/apache2/other/webrelease2.conf
    というファイルが以下の内容で作成されます。

    <IfModule mod_proxy.c>
      ProxyPass             /WebRelease2    http://127.0.0.1:50002/WebRelease2
      ProxyPassReverse      /WebRelease2    http://127.0.0.1:50002/WebRelease2
      ProxyTimeout          1800
    </IfModule>
    
    OS X v10.11 + OS X Server の場合

    apache と WebRelease の接続に使用する mod_proxy の設定のために、 /Library/Server/Web/Config/Proxy/apache_serviceproxy_slash_default_webrelease2.conf
    というファイルが以下の内容で作成されます。

    <IfModule mod_proxy.c>
      ProxyPass             /WebRelease2    http://127.0.0.1:50002/WebRelease2
      ProxyPassReverse      /WebRelease2    http://127.0.0.1:50002/WebRelease2
      ProxyTimeout          1800
    </IfModule>
    

4 シリアルキーと期間ライセンスコードの設定

インストール終了後にマシンを再起動すると WebRelease は Port 50002 で HTTP/1.1 でのリクエストを受け付ける状態で稼働を開始します。下記 URL にローカルマシン上のブラウザからアクセスしてみてください。

http://127.0.0.1:50002/WebRelease2

また、Apache との連携が正常にできている場合にはネットワーク経由で他のマシンから下記の URL にアクセス可能になっているはずです。

http://<your.computer>/WebRelease2

正常にインストールできている場合には「シリアルキーの設定」画面が表示されます。画面の指示に従い製品に添付されているシリアルキーを入力してください。シリアルキーを入力すると WebRelease を使用できるようになります。

インストールした製品が Enterprise AL の場合、シリアルキーの入力に続いて期間ライセンスコードの入力が必要です。シリアルキー入力後に期間ライセンス入力画面が表示されますので、製品に添付されている「期間ライセンスコード」(12桁の数字) を入力してください。

「シリアルキー」と「期間ライセンスコード」は製品の一部ですので大切に保管してください。紛失しないでください。

5 管理者 (admin) パスワードの設定

WebRelease を新規にインストールした場合には、下記の手順に従って WebRelease の管理者アカウント admin のパスワードの再設定を行ってください。

インストール直後の状態では WebRelease には下記のユーザ ID とパスワードでログインできるようになっています。

ユーザIDadmin
パスワードwebrelease

インストールを終えたら、なるべく早くこのユーザのパスワードを変更しておいてください。パスワードを変更しておかないと外部から不正にログインされてしまう危険があります。

アップグレードインストールを行った場合は、アカウント情報やコンテンツデータはそのまま引き継がれていますので、admin のパスワードの再設定は必要はありません。

6 動作メモリサイズの設定

インストール直後は WebRelease には仮の値として 512M Byte のメモリを割り当てた状態になっています。この値を実際のマシンに搭載されたメモリサイズに合わせて指定しなおしてください。

指定の変更は下記の手順で行います。

  1. WebRelease に admin でログインします。

  2. 「サイト選択」画面右上に表示されている「システム管理」ボタンをクリックします。

  3. 「メモリー設定」タブにある「割り当てるメモリサイズ」の欄に適切な値を指定します。画面の指示に従って値を決めてください。

  4. 指定したら画面右上の「保存」ボタンをクリックして指定した値を保存します。

  5. 同じ画面にある「再起動」ボタンをクリックして WebRelease を再起動します。この時、ブラウザの画面に proxy error のメッセージが表示される場合がありますが異常ではありません。

画面から WebRelease を再起動すると、再起動が完了してサービスが再開されるまでの間はブラウザから WebRelease にアクセスできなくなります。しばらく待ってからもう一度 WebRelease にアクセスして「メモリー設定」タブの値が指定した値となって起動されているかどうか確認してください。

7 WebRelease のマニュアル

WebRelease の機能とその利用方法については、ユーザーズマニュアルをご参照ください。WebRelease にログインした状態で画面の上部中央付近にある「?」マークのボタンをクリックするとマニュアルを参照できます。

8 その他

WebRelease は複数のインスタンスを起動して負荷分散する方式で運用することはできません。同一のマシン上で複数の WebRelease を起動する設定を行うと二つ以上の WebRelease インスタンスが同時にデータ領域を更新しあいリポジトリが破損する場合があります。

9 付記

WebRelease 2.70M には Apache Software Foundation の Tomcat が同梱されています。この WebRelease をインストールすると Tomcat は ~wr2/ThirdPartyProducts/tomcat 以下に配置されます。この Tomcat 部分については Apache License, Version 2.0 が適用されます。この Tomcat は Apache Software Foundation から配布されているものと同一であり FrameWorks Software, Inc. によるコードやドキュメンテーションの修正はありません。

WebRelease 2.70M には Oracle 社製の Java Runtime Environment が同梱されています。この WebRelease をインストールすると Java Runtime Environment は ~wr2/ThirdPartyProducts/jre 以下に配置されます。この Java Runtime Environment 部分については、同ディレクトリ以下に置かれたファイルに記されているライセンスが適用されます。この Java Runtime Environment は、同ライセンスに基づいて FrameWorks Software, Inc. が WebRelease の実行を目的として再配布しているものです。これらの Java Runtime Environment は Oracle 社から配布されているものと同一であり FrameWorks Software, Inc. によるコードやドキュメンテーションの修正はありません。

WebRelease 2.70M には Oracle 社製の JavaMail が同梱されています。この WebRelease2 をインストールすると JavaMail は ~wr2/ThirdPartyProducts/javamail 以下にインストールされます。javaMail は、再配布ライセンスに基づいて FrameWorks Software, Inc. が WebRelease2 の実行を目的として再配布しているものです。この JavaMail は Oracle 社から配布されているものと同一であり FrameWorks Software, Inc. による修正は加えられていません。

WebRelease は株式会社フレームワークスソフトウエアの登録商標です。その他の記載したソフトウエア名、商品名、製品名は、一般に開発元・販売元各社の商標または登録商標です。

Copyright (C) 2002-2019 FrameWorks Software, Inc. All rights reserved. 不許複製・転載