インストールの準備をする

インストールに必要な情報やWebサーバーサービスのインストールなど、Garoonをインストールするために必要な準備を説明します。

インストールに必要な情報を準備する

Garoonのインストールに必要な情報は、次のとおりです。

項目 説明
インストーラー 最新版のインストーラーを次のページからダウンロードします。
https://garoon.cybozu.co.jp/support/package/download/
Administrator (Windows) またはroot (Linux) のパスワード Garoonを管理するユーザーのパスワードです。Garoonを初期化するために必要です。
システム管理者の情報 Garoonを管理するシステム管理者の情報です。
  • ユーザー名
  • ログイン名
  • パスワード
お客様情報 Garoonを導入するお客様の情報です。次の情報を準備します。
  • 法人名
  • 法人名(読みがな)
    画面に表示するロゴを変更する場合は、次のどちらかを準備します。
    • 画像ファイル
    • 画像ファイルの保存先を示すURL
データベース管理ユーザーのパスワード MySQLを管理するユーザー(cbroot)のパスワードです。パスワードは厳重に管理してください。
データベース接続ユーザーのパスワード MySQLに接続するユーザーのパスワードです。パスワードは厳重に管理してください。
インストール識別子 Garoonを識別するための文字列です。使用できる文字は、次のとおりです。
  • 「a」から「z」までの、小文字のアルファベット
  • 「A」から「Z」までの、大文字のアルファベット
  • 「_」(アンダーバー)
  • 「0」から「9」までの数字
CGIディレクトリー GaroonのCGIプログラムや、設定ファイルなどを保存するディレクトリーです。
初期設定で選択されるディレクトリーは次のとおりです。
  • Windows環境: C:\Inetpub\scripts
  • Linux環境: /var/www/cgi-bin
ドキュメントルートディレクトリー GaroonのHTMLファイルや画像ファイルなどを保存するディレクトリーです。
初期設定で選択されるディレクトリーは次のとおりです。
  • Windows環境: C:\Inetpub\wwwroot
  • Linux環境: /var/www/html

(OS共通)Webサーバーサービスをインストールする

サーバーにWebサーバーサービスをインストールし、CGIを実行できるように設定します。
Webサーバーサービスをインストール済みの場合でも、アクセス権や仮想ディレクトリーの設定など、Garoonの運用のために追加設定が必要な場合があります。
新規インストールの場合も、インストール済みの場合でも、必ず、事前にWebサーバー/Webブラウザーのインストールと設定を参照し、必要な設定を行ってください。
インストール後は、Webサーバーサービスが起動していることを確認します。

(OS共通)Webサーバーのアクセスログを設定する

Webサーバーのアクセスログでは、Garoonへの分間アクセス数や現象発生時のリクエスト内容、およびリクエストの処理時間などを確認できます。
使用するWebサーバーの種類により出力内容や設定は異なりますが、アクセスログに次の情報が含まれるようにしてください。

  • 日時
  • 接続元クライアントIP
  • メソッド(GET、POSTなど)
  • リクエストURL
  • クエリ文字列
  • HTTPステータス
  • サーバーからクライアントへ送信したバイト数
  • 処理時間
  • UserAgent
  • リファラー
Apacheを利用している場合

Apacheの初期設定では、アクセスログに処理時間を出力する設定になっていない場合があります。
下記の手順に沿って、アクセスログに処理時間を出力するように設定します。

操作手順:
  1. httpd.confを編集し、「%D」を記述します。

    • 設定例(変更前):
    LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
    
    • 設定例(変更後):
    LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\" %D" combined
    

  2. Apacheを再起動、または設定ファイルを再読み込みして、設定を反映させます。

(OS共通:インストール済みのMySQLを使用する場合のみ)MySQLの設定を変更する

Garoonのインストーラーには、MySQLが同梱されています。同梱されているMySQLを使用してGaroonを構築することを推奨しますが、すでにインストールされているMySQLを使用することも可能です。
MySQLは、Garoonのインストーラーに同梱されているMySQLと同じ、バージョン 8.0.28のみ使用できます。
インストール済みのMySQLを使用する場合は、次の操作が必要です。

インストール前にMySQLの設定ファイル(my.iniまたはmy.cnf)を修正する

Garoonをインストールする前に、my.iniファイル、またはmy.cnfファイルに値を追記します。

操作手順:
  1. MySQLサービスを停止します。

  2. 設定ファイルが存在するディレクトリーに移動します。

    • Windows環境のディレクトリーの例:C:\ProgramData\MySQL\MySQL Server 5.7\my.ini
    • Linux環境のディレクトリーの例:/usr/my.cnf

  3. テキストエディターで設定ファイルを開き、次の値を記載して保存します。

    すでに値が設定されている場合は、その値の行をコメントアウトして次の値を記載してください。

    • Windows環境の場合 (my.ini)
    [mysqld]
    sql_mode=NO_ENGINE_SUBSTITUTION
    • Linux環境の場合 (my.cnf)
    [mysqld]
    sql_mode=NO_ENGINE_SUBSTITUTION
    character-set-server = utf8mb4
    collation-server = utf8mb4_general_ci
    skip-character-set-client-handshake
    [client]
    default-character-set=utf8mb4

  4. MySQLサービスを起動します。

インストール中にMySQLの接続情報を入力する

インストーラーの画面で「サーバーにインストール済みのMySQLを使用する」を選択し、MySQLの次の接続情報を入力します。

  • MySQLがインストールされているディレクトリー
  • MySQLのポート番号
  • MySQLのルートパスワード
インストール後にMySQLサービスを再起動する

Garoonのインストール完了後、MySQLサービスを再起動する必要があります。

全文検索サーバーの構築手順をサイボウズに問い合わせる

インストール済みのMySQLを使用する場合は、全文検索サーバーの構築に専用の設定が必要になります。サイボウズまでお問い合わせください。
Garoonのインストーラーに同梱されているMySQLを使用する場合は、通常の手順で全文検索サーバーを構築できます。

(Windows環境の場合のみ)仮想ディレクトリーを設定する

仮想ディレクトリーは、Webブラウザーで指定されるURLと、サーバー上の実ディレクトリーとを結びつける役割をします。Garoonをインストールする前に、WebサーバーのCGIディレクトリーを仮想ディレクトリーとして設定する必要があります。
仮想ディレクトリーについては、仮想ディレクトリーの作成方法を参照してください。

(Linux環境の場合のみ)ApacheのKeepAlive設定を無効にする

Apache2.4(Red Hat Enterprise Linux 7と8に同梱)の初期設定では、KeepAliveが有効です。KeepAliveを無効にするため、設定ファイルに「KeepAlive Off」を記述します。

操作手順:
  1. httpd.confを編集し、KeepAliveの設定を無効にします。

    変更前:

    User apache  
    Group apache

    変更後:

    User apache  
    Group apache  
    KeepAlive Off

  2. 設定を変更したあとは、サーバーマシンのWebサーバーサービスを再起動します。

    [root@garoon admin]# systemctl restart httpd.service

(Linux環境の場合のみ)transparent hugepages(THP)機能を無効にする

THP機能を無効にします。THP機能が有効な場合、Garoon4.10以降のバージョンでは性能が劣化する場合があります。

操作手順:
  1. THP機能が無効になっていることを確認します。

    [root@garoon admin]# cat /sys/kernel/mm/transparent_hugepage/enabled

    「never」が[ ]で囲まれていれば、THP機能は無効になっています。
    例:

    always madvise [never]

    「[always] madvise never」または「always [madvise] never」と表示された場合はTHPが有効になっています。手順2に進みます。
    THPが無効になっている場合は、手順3に進みます。

  2. THP機能を無効にします。

    [root@garoon admin]# echo never > /sys/kernel/mm/transparent_hugepage/enabled

  3. /etc/rc.d/rc.localに記述を追加し、再起動後もTHP機能が無効になるように設定します。

    変更するファイル:/etc/rc.d/rc.local
    変更前:

    touch /var/lock/subsys/local

    変更後:

    touch /var/lock/subsys/local  
    echo never > /sys/kernel/mm/transparent_hugepage/enabled

  4. /etc/rc.d/rc.localに実行権を設定します。

    # chmod u+x /etc/rc.d/rc.local

(Linux環境の場合のみ)SELinuxを無効にする

Linux環境の場合はSELinuxを無効にします。有効になっていると、Garoonは正常に動作しません。

操作手順:
  1. SELinuxが有効か確認します。

    次のコマンドを実行します。

    [root@garoon admin]# getenforce

    次のいずれかが表示されます。

    • Enforcing: 有効
    • Permissive:デバッグモード(アクセス制限はかからないが、有効時と同様のログを出力)
    • Disabled: 無効

  2. SELinuxを無効にします。

    SELinuxが有効な場合、SELinuxの設定ファイル(/etc/sysconfig/selinux)を開き、「SELINUX」の値を変更します。

    • 変更前:
    SELINUX=enforcing
    • 変更後:
    SELINUX=disabled

  3. OSを再起動します。

(Linux環境の場合のみ)Garoonに必要なライブラリーをインストールする

Linux環境の場合は、Garoonを運用するために必要なライブラリーがインストールされていることを確認します。
Garoonが使用するライブラリーの詳細は、Linux環境で必要なライブラリー(Garoon 5.x.x以降)を参照してください。