サイボウズ 全文検索サーバー バージョン 2.0 ガイド

サイボウズ 全文検索サーバー
バージョン 2.0
ガイド
第 2.2 版
サイボウズ株式会社
はじめに
はじめに
本書は、サイボウズ 全文検索サーバー バージョン 2.0 の機能と、インストールや保守などの運用管理方法を説
明しています。
対象読者
全文検索サーバーのインストールやアンインストールの作業担当者
全文検索サーバーとサイボウズ ガルーンを管理する権限を持つ管理者
本書で使用している表記
本書では、次の表記を使用しています。
表記
意味
重要
注意
特に重要な注意事項
操作に注意が必要な事項や制限事項
補足
[ ]
操作の補足説明や別の操作方法、知っていると便利な情報
画面上のボタン、リンクまたはタブ
- ###ページ
参照先のページ
本書の作成環境
本書の作成環境は、次のとおりです。
OS: Windows 7 SP1、Windows Server 2012 Enterprise
Web ブラウザー: Internet Explorer 9
製品バージョン: サイボウズ 全文検索サーバー バージョン 2.0.1
サイボウズ ガルーン バージョン 4.0.0
本書で掲載している画面表示は、お使いの Web ブラウザーによって異なります。
本書で使用している製品名称と略称
本書では、次の略称を使用しています。
略称
全文検索サーバー
製品名
サイボウズ 全文検索サーバー バージョン 2.0.1
ガルーン
サイボウズ ガルーン バージョン 4.0.x
本書の取り扱いについて
この文書内における掲載情報の二次利用においては、ご自身の判断と責任の下に行ってください。
サイボウズ株式会社は、それらの情報をご利用になることにより発生したあらゆる商業的損害・損失を含め一切の
直接的、間接的、特殊的、付随的または結果的損失、損害について責任を負いません。
また、本文書を二次利用し作成した文書には、次のような当社の著作権表示文を記載してください。
「本文書は、サイボウズ株式会社による『サイボウズ 全文検索サーバー バージョン 2.0 ガイド』を一部引用してい
ます。」
2
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
はじめに
商標について
記載された商品名、各製品名は各社の登録商標または商標です。また、当社製品には他社の著作物が含まれて
いることがあります。
個別の商標・著作物に関する注記については、弊社の Web サイトを参照してください。
http://cybozu.co.jp/company/copyright/other_companies_trademark.html
なお、本文および図表中では、(TM)マーク、(R)マークは明記していません。
OpenSSL (Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.)
This product includes software developed by the OpenSSL Project for use in the OpenSSL
Toolkit.
(http://www.openssl.org/)
This product includes cryptographic software written by Eric Young
([email protected])
This product includes software written by Tim Hudson
([email protected])
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
3
目 次
目 次
はじめに ........................................................................................................................... 2
目
1章
次 .............................................................................................................................. 4
全文検索サーバーの概要 ............................................................................................. 7
1.1 全文検索サーバーのしくみ .................................................................................. 7
1.2 全文検索サーバーの試用について .......................................................................... 8
1.3 動作環境 ......................................................................................................... 8
1.3.1 全文検索サーバーの運用に必要なストレージの容量 ........................................... 9
1.3.2 ウイルススキャンの回避 .......................................................................... 10
2章
インストールする .................................................................................................... 11
2.1 作業の流れ .................................................................................................... 11
2.1.1 ガルーンと同じサーバーにインストールする ................................................. 11
2.1.2 ガルーンと異なるサーバーにインストールする ............................................... 12
2.2 インストール前の準備 ...................................................................................... 13
2.2.1 ネットワークを構築する .......................................................................... 14
2.2.2 ガルーンの情報を確認する ........................................................................ 16
2.2.3 必要なアーカイブを用意する ..................................................................... 16
2.2.4 インストール済みの MySQL を使用する場合.................................................. 16
2.3 Windows 環境にインストールする ...................................................................... 16
2.3.1 全文検索サーバーをインストールする .......................................................... 17
2.3.2 ガルーンと全文検索サーバーの接続を設定する ............................................... 17
2.3.3 添付ファイル保存領域を共有する ............................................................... 24
2.3.4 MySQL で通知を有効化する ...................................................................... 30
2.3.5 ガルーンで全文検索機能を有効化する .......................................................... 32
2.3.6 インデックスを作成する .......................................................................... 33
2.3.7 作業後の確認 ........................................................................................ 35
2.4 Linux 環境にインストールする ........................................................................... 37
2.4.1 全文検索サーバーをインストールする .......................................................... 38
2.4.2 ガルーンと全文検索サーバーの接続を設定する ............................................... 39
2.4.3 添付ファイル保存領域をマウントする .......................................................... 42
2.4.4 MySQL で通知を有効化する ...................................................................... 46
2.4.5 ガルーンで全文検索機能を有効化する .......................................................... 47
4
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
目 次
2.4.6 インデックスを作成する .......................................................................... 49
2.4.7 作業後の確認 ........................................................................................ 51
3章
アンインストールする .............................................................................................. 54
3.1 Windows 環境からアンインストールする .............................................................. 54
3.1.1 全文検索サーバーをインストールしたサーバーで行う作業 ................................. 54
3.1.2 ガルーンを運用しているサーバーで行う作業 ................................................. 55
3.2 Linux 環境からアンインストールする ................................................................... 56
3.2.1 全文検索サーバーをインストールしたサーバーで行う作業 ................................. 57
3.2.2 ガルーンを運用しているサーバーで行う作業 ................................................. 58
4章
DB 分割構成のガルーンで運用する ............................................................................ 61
4.1 全文検索サーバーをインストールする................................................................... 61
4.1.1 ガルーンと全文検索サーバーの接続を設定する ............................................... 62
4.1.2 添付ファイル保存領域をマウントする .......................................................... 66
4.1.3 MySQL で通知を有効化する ...................................................................... 69
4.1.4 ガルーンで全文検索機能を有効化する .......................................................... 71
4.1.5 インデックスを作成する .......................................................................... 72
4.1.6 作業後の確認 ........................................................................................ 74
4.2 全文検索サーバーをアンインストールする ............................................................. 76
4.2.1 全文検索サーバーをインストールしたサーバーで行う作業 ................................. 76
4.2.2 ガルーンを運用しているサーバーで行う作業 ................................................. 77
5章
全文検索サーバーの保守 ........................................................................................... 80
5.1 データをバックアップする ................................................................................ 80
5.2 データをリストアする ...................................................................................... 82
5.3 サーバーを移行する ......................................................................................... 84
5.4 キューの状況を確認する ................................................................................... 85
5.5 検索ログを出力する ......................................................................................... 86
5.6 インデックスを再作成する ................................................................................ 87
5.7 サービスの停止方法と起動方法 ........................................................................... 88
5.7.1 Windows 環境でサービスを停止する........................................................... 88
5.7.2 Linux 環境環境でサービスを停止する .......................................................... 89
5.7.3 Windows 環境でサービスを起動する........................................................... 89
5.7.4 Linux 環境でサービスを起動する................................................................ 90
6章
全文検索を使用する ................................................................................................. 91
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
5
目 次
6.1 検索できるアプリケーション .............................................................................. 91
6.2 検索できるデータ............................................................................................ 92
6.3 検索仕様 ....................................................................................................... 93
6.3.1 「差出人」を使用した検索と、検索結果の絞り込み ......................................... 94
6.3.2 キーワードやファイル形式に関する制限事項 ................................................. 94
6.3.3 検索できるファイル ................................................................................ 95
付録 A ログ一覧 ................................................................................................................ 97
付録 B エラーメッセージ .................................................................................................. 101
付録 B.1
システム管理画面に表示されるエラーメッセージ .............................................. 101
付録 B.2
インストール時のエラー ............................................................................ 101
付録 C ファイル構成 ........................................................................................................ 102
付録 C.1
Windows 環境 ......................................................................................... 102
付録 C.2
Linux 環境.............................................................................................. 103
付録 D 困ったときは ........................................................................................................ 105
6
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
1.1 全文検索サーバーのしくみ
全文検索サーバーの概要
1章
全文検索サーバーは、ガルーンで作成した文書や添付ファイルなどをまとめて検索するためのサーバーです。全文
検索の対象のアプリケーションで、どのデータがどの単語を含むかなどの情報を、インデックスに保存します。
ユーザーがガルーンで全文検索を実行すると、全文検索サーバーはインデックスを検索し、その結果を返します。イ
ンデックスを利用すると、検索処理にかかる時間を短縮できます。
全文検索を使用できるアプリケーションと、検索できるデータについては、次のページを参照してください。
「6.1 検索できるアプリケーション」 - 91 ページ
「6.2 検索できるデータ」 - 92 ページ
補足
バージョン 2.0 以降の全文検索サーバーは、「サイボウズ 全文検索サーバー for ガルーン バージョン
1.0.x」や「サイボウズ ガルーン 3 全文検索サーバー」との互換性はありません。
1.1
全文検索サーバーのしくみ
全文検索サーバーは、「Solr」と「Worker」で構成されます。Solr と Worker は、ガルーンのアプリケーションや
MySQL と連携して、次のように動作します。
ガルーン
全文検索サーバー
検索をリクエスト
アプリケーション
(5)
Solr
検索結果を送信
(1) データを追加
(2) 通知
データベースエンジン
(4) データを送信
Worker
(3) データを取得
添付ファイル
キュー
(3) データを取得
各経路の説明
経路
説明
(1)
(2)
ガルーンのアプリケーションは MySQL のキューに、ガルーンのデータと、添付ファイルのパスを追加します。
キューにデータが追加されると、ガルーンの MySQL は全文検索サーバーの Worker に通知します。
(3)
ガルーンの MySQL から通知を受けた Worker は、キューからデータを取得します。
Worker は、取得したデータに含まれるファイルパスをもとにガルーンの添付ファイルにアクセスし、データを取得し
ます。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
7
1 章 全文検索サーバーの概要
経路
(4)
(5)
説明
Worker は、取得したデータを Solr に送信します。
データを受け取った Solr は、検索に必要なインデックスを構成します。
ユーザーがガルーンで検索すると、ガルーンのアプリケーションは Solr に検索をリクエストします。
Solr は受け取ったキーワードに対応する検索結果をガルーンに送信します。
1.2
全文検索サーバーの試用について
全文検索サーバーは、ガルーンをインストールした日から 60 日間試用できます。
ガルーンの試用期間後も使用するには、ガルーンで継続サービスライセンスキーを登録する必要があります。
ライセンスの登録については、次のページを参照してください。
『サイボウズ ガルーン バージョン 4.0 管理者ガイド』の「ライセンスを管理する」
https://help.cybozu.com/ja/g40/admin/system/license/license.html
補足
試用やライセンスの有効期限が切れると、ガルーンの全文検索機能が無効になり、標準の検索機能に切り替わり
ます。
ただし、全文検索サーバーのインデックスの作成は継続されます。全文検索機能の使用を中止する場合は、全文
検索サーバーをアンインストールしてください。
1.3
動作環境
全文検索サーバーの動作環境は次のとおりです。(2014 年 12 月現在)
対応 OS
OS
バージョン
Windows(64bit)
Windows
Windows
Windows
Windows
Windows
Windows
Windows
Windows
Linux(64bit)
Red
Red
Red
Red
Hat
Hat
Hat
Hat
Server
Server
Server
Server
Server
Server
Server
Server
2012
2012
2012
2012
2008
2008
2008
2008
Enterprise
Enterprise
Enterprise
Enterprise
R2 Datacenter
R2 Standard
Datacenter
Standard
R2 Enterprise x64 (SP1)
R2 Standard x64 (SP1)
Enterprise x64 (SP2)
Standard x64 (SP2)
Linux
Linux
Linux
Linux
Server
Server
Server
Server
7
6
5 Advanced Platform
5
対応 Web ブラウザー
OS
Windows
Mac OS
8
Web ブラウザー
Internet Explorer 8、9、10(デスクトップ版)、11(Modern UI 版、デスクトップ版)
Mozilla Firefox 最新版
Google Chrome 最新版
Safari 最新版
Mozilla Firefox 最新版
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
1.3 動作環境
補足
Red Hat Enterprise Linux には、次の RPM パッケージがインストールされている必要があります。
glibc
libgcc
libstdc++
zlib
ガルーンを単体構成で運用している場合は、ガルーンと全文検索サーバーを同じサーバーで運用できます。
全文検索サーバーは、仮想化環境でも動作します。仮想化環境で使用する場合、お客様の環境によっては、パ
フォーマンスが低下する可能性があります。
Web ブラウザーの設定については、弊社 Web サイトで紹介しています。
https://manual.cybozu.co.jp/tech/webbrowser/
1.3.1
全文検索サーバーの運用に必要なストレージの容量
ガルーンを運用しているサーバーに必要な容量
ガルーンで「メール」アプリケーションを使用していると、メールの添付ファイルのインデックスを作成するため、ガルー
ンを運用しているサーバーに添付ファイルのコピーが作成されます。インデックスの作成が完了すると、添付ファイル
のコピーは削除されますが、ストレージに十分な空き容量を確保してください。
次の場合には、ガルーンに保存されたすべての添付ファイルがコピーされるため、ストレージの使用領域が一時的
に増加します。
運用中のガルーンに全文検索サーバーを導入する場合
インデックスを再作成する場合
ガルーンに保存されるメールの添付ファイルの合計サイズは、次のディレクトリーのサイズを目安にしてください。
(ガルーンのインストールディレクトリー)/mysql-5.0/files/(インストール識別子)/mail/
Windows 版での例:C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥mail
Linux 版での例:/usr/local/cybozu/mysql-5.0/files/cbgrn/mail/
DB 分割構成での例:/usr/local/cybozu/files/mail/
メールの添付ファイルは次のディレクトリーにコピーされます。
(ガルーンのインストールディレクトリー)/mysql-5.0/files/(インストール識別子)/mail/tmp_solr_index/
Windows 版での例:C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥mail¥tmp_solr_index
Linux 版での例:/usr/local/cybozu/mysql-5.0/files/cbgrn/mail/tmp_solr_index/
DB 分割構成での例:/usr/local/cybozu/files/mail/tmp_solr_index/
全文検索サーバーを運用しているサーバーに必要な容量
全文検索サーバーを運用するサーバーには、インストールディレクトリーに、インデックスやログを保存するための空
き容量が必要です。
標準のインストールディレクトリーと、全文検索サーバーの運用に必要な空き容量は、次のとおりです。
標準のインストールディレクトリー
Windows 版: C:¥Program Files¥Cybozu¥cbfts
Linux 版: /usr/local/cybozu/cbfts
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
9
1 章 全文検索サーバーの概要
運用に必要な空き容量
ガルーンのデータの 50%程度
ガルーンのデータ量の目安
ガルーンのデータ量は、次のデータの合計です。
MySQL のデータ量:
MySQL の「data」ディレクトリーのサイズです。
添付ファイルのデータ量:
MySQL の「files」ディレクトリーのサイズです。
ガルーンを既定の設定でインストールした場合、それぞれのディレクトリーのパスは次のとおりです。
Windows 版:
data ディレクトリー:C:¥Program Files¥Cybozu¥mysql-5.0¥data
files ディレクトリー:C:¥Program Files¥Cybozu¥mysql-5.0¥files
Linux 版:
data ディレクトリー:/usr/local/cybozu/mysql-5.0/data
files ディレクトリー:/usr/local/cybozu/mysql-5.0/files
DB 分割構成:
data ディレクトリー:/usr/local/cybozu/mysql-5.0/data
files ディレクトリー:/usr/local/cybozu/files
1.3.2
ウイルススキャンの回避
ガルーンを運用しているサーバーでウイルス対策ソフトウェアが動作している場合、インデックスを作成する前に、ウ
イルススキャンの対象から次のディレクトリーを外す必要があります。
(ガルーンのインストールディレクトリー)¥mysql-5.0¥files¥(インストール識別子)¥mail¥tmp_solr_index
例:
C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥mail¥tmp_solr_index
ウイルス対策ソフトウェアの監視対象に上記のディレクトリーが含まれていると、インデックスの作成に時間がかかる
場合があります。
10
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.1 作業の流れ
インストールする
2章
全文検索サーバーのインストールに必要な準備とインストール方法を説明します。
2.1
作業の流れ
全文検索サーバーには、次の 2 つのインストール方法があります。
ガルーンと同じサーバーに、全文検索サーバーをインストールする
単体構成のガルーンを運用しているサーバーに、全文検索サーバーをインストールします。
「2.1.1 ガルーンと同じサーバーにインストールする」 - 11 ページ
サーバー分離構成または DB 分割構成のガルーンを運用しているサーバーに、全文検索サーバーをインストー
ルする場合は、ガルーンと異なるサーバーにインストールする手順を参照してください。
ガルーンと異なるサーバーに、全文検索サーバーをインストールする
ガルーンを運用しているサーバーと異なるサーバーに、全文検索サーバーをインストールします。
「2.1.2 ガルーンと異なるサーバーにインストールする」 - 12 ページ
2.1.1
ガルーンと同じサーバーにインストールする
ガルーンを単体構成で運用している場合のみ、ガルーンと同じサーバーに全文検索サーバーをインストールできま
す。
ガルーンを運用しているサーバーに全文検索サーバーをインストールし、ユーザーが全文検索を使用できるようにな
るまでに必要な作業は、次のとおりです。
準備する
Step 1
全文検索サーバーの運用に必要なネットワークを構築します。
また、インストールに必要なアーカイブと情報を取得します。
「2.2 インストール前の準備」 - 13 ページ
全文検索サーバーをインストールする
Step 2
ガルーンと同じサーバーに全文検索サーバーをインストールします。
Windows 環境の場合: 「2.3.1 全文検索サーバーをインストールする」 - 17 ページ
Linux 環境の場合: 「2.4.1 全文検索サーバーをインストールする」 - 38 ページ
MySQL で通知を有効化する
Step 3
ガルーンの MySQL で、通知を有効化します。
通知を有効化すると、キューにデータが追加された際に、全文検索サーバーに通知されるようになり
ます。
Windows 環境の場合: 「2.3.4 MySQL で通知を有効化する」 - 30 ページ
Linux 環境の場合: 「2.4.4 MySQL で通知を有効化する」 - 46 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
11
2 章 インストールする
ガルーンで全文検索機能を有効化する
Step 4
ガルーンの設定ファイルを編集し、全文検索機能を有効化します。
ガルーンの画面に、全文検索用の検索ボックスが表示されるようになります。
Windows 環境の場合: 「2.3.5 ガルーンで全文検索機能を有効化する」 - 32 ページ
Linux 環境の場合: 「2.4.5 ガルーンで全文検索機能を有効化する」 - 47 ページ
全文検索サーバーでインデックスを作成する
Step 5
コマンドを実行し、インデックスの作成を開始します。
Windows 環境の場合: 「2.3.6 インデックスを作成する」 - 33 ページ
Linux 環境の場合: 「2.4.6 インデックスを作成する」 - 49 ページ
作業後の確認
Step 6
2.1.2
作業が正常に完了したことを確認します。
ガルーンにアクセスして検索できることを確認したら、全文検索サーバーの導入は完了です。
Windows 環境の場合: 「2.3.7 作業後の確認」 - 35 ページ
Linux 環境の場合: 「2.4.7 作業後の確認」 - 51 ページ
ガルーンと異なるサーバーにインストールする
ガルーンを運用しているサーバーと異なるサーバーに全文検索サーバーをインストールし、ユーザーが全文検索を
使用できるようになるまでに必要な作業は、次のとおりです。
準備する
Step 1
全文検索サーバーの運用に必要なネットワークを構築します。
また、インストールに必要なアーカイブと情報を取得します。
「2.2 インストール前の準備」 - 13 ページ
全文検索サーバーをインストールする
Step 2
ガルーンと別のサーバーに全文検索サーバーをインストールします。
Windows 環境の場合: 「2.3.1 全文検索サーバーをインストールする」 - 17 ページ
Linux 環境の場合: 「2.4.1 全文検索サーバーをインストールする」 - 38 ページ
DB 分割構成の場合: 「4.1 全文検索サーバーをインストールする」 - 61 ページ
接続を設定する
Step 3
12
ガルーンと全文検索サーバーの間の通信に必要な設定をします。
Windows 環境の場合: 「2.3.2 ガルーンと全文検索サーバーの接続を設定する」 - 17 ページ
Linux 環境の場合: 「2.4.2 ガルーンと全文検索サーバーの接続を設定する」 - 39 ページ
DB 分割構成の場合: 「4.1.1 ガルーンと全文検索サーバーの接続を設定する」 - 62 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.2 インストール前の準備
添付ファイル保存領域をマウントする
Step 4
Worker がガルーンの添付ファイルにアクセスできるようにします。
この設定によって、全文検索サーバーの Worker は、ガルーンの添付ファイルを解析し、検索に必要
なインデックスを作成できるようになります。
Windows 環境の場合: 「2.3.3 添付ファイル保存領域を共有する」 - 24 ページ
Linux 環境の場合: 「2.4.3 添付ファイル保存領域をマウントする」 - 42 ページ
DB 分割構成の場合: 「4.1.2 添付ファイル保存領域をマウントする」 - 66 ページ
MySQL で通知を有効化する
Step 5
ガルーンの MySQL で、通知を有効化します。
通知を有効化すると、キューにデータが追加された際に、全文検索サーバーに通知されるようになり
ます。
Windows 環境の場合: 「2.3.4 MySQL で通知を有効化する」 - 30 ページ
Linux 環境の場合: 「2.4.4 MySQL で通知を有効化する」 - 46 ページ
DB 分割構成の場合: 「4.1.3MySQL で通知を有効化する」 - 69 ページ
ガルーンで全文検索機能を有効化する
Step 6
ガルーンの設定ファイルを編集し、全文検索機能を有効化します。
ガルーンの画面に、全文検索用の検索ボックスが表示されるようになります。
Windows 環境の場合: 「2.3.5 ガルーンで全文検索機能を有効化する」 - 32 ページ
Linux 環境の場合: 「2.4.5 ガルーンで全文検索機能を有効化する」 - 47 ページ
DB 分割構成の場合: 「4.1.4 ガルーンで全文検索機能を有効化する」 - 71 ページ
全文検索サーバーでインデックスを作成する
Step 7
コマンドを実行し、インデックスの作成を開始します。
Windows 環境の場合: 「2.3.6 インデックスを作成する」 - 33 ページ
Linux 環境の場合: 「2.4.6 インデックスを作成する」 - 49 ページ
DB 分割構成の場合: 「4.1.5 インデックスを作成する」 - 72 ページ
作業後の確認
Step 8
2.2
作業が正常に完了したことを確認します。
ガルーンにアクセスして検索できることを確認したら、全文検索サーバーの導入は完了です。
Windows 環境の場合: 「2.3.7 作業後の確認」 - 35 ページ
Linux 環境の場合: 「2.4.7 作業後の確認」 - 51 ページ
DB 分割構成の場合: 「4.1.6 作業後の確認」 - 74 ページ
インストール前の準備
全文検索サーバーのインストールに必要な準備作業を説明します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
13
2 章 インストールする
2.2.1
ネットワークを構築する
全文検索サーバーの運用に必要なネットワークを構築します。
ガルーンとは別のサーバーで全文検索サーバーを運用する場合、全文検索サーバーを運用するサーバーには
iptables などのファイアウォールを設定し、ガルーンのサーバーとの通信だけを許可してください。全文検索サー
バーは、ガルーンのサーバー以外とは通信しません。
ガルーンと全文検索サーバーとの間の通信
ガルーンを運用しているサーバーとは別のサーバーで全文検索サーバーを運用する場合に、ガルーンと全文検索
サーバーとの間で行われる通信を説明します。ファイアウォールの設定の参考にしてください。
通信に必要なポートは、全文検索サーバーをインストールする前に開放する必要があります。
ガルーンと全文検索サーバーとの間の通信
:ポート番号
アプリケーション
(A)検索をリクエスト
8983
(B)データの追加を通知
8686
Solr
Worker
データベースエンジン
3770
445 / 2049
(C)データを取得
(D)添付ファイルにアクセス
全文検索サーバー
ガルーン
それぞれの通信経路の説明
経路
プロトコル
説明
(A)
TCP
ユーザーがガルーンで検索すると、ガルーンのアプリケーションは Solr に検索をリクエストし、検索
結果を受け取ります。
(B)
UDP / TCP
キューにデータが追加されると、ガルーンの MySQL は Worker に通知します。
この通知には、随時行われる UDP での通信と、5 分おきに行われる TCP での通信があります。
(C)
(D)
TCP
TCP
MySQL からの通知に応じて、Worker は MySQL に接続し、キューからデータを取得します。
全文検索サーバーに対して、ガルーンの添付ファイル保存ディレクトリーに共有を設定します。この
設定によって、Worker が添付ファイルの検索に必要なインデックスを作成できるようになります。
この設定には、Windows では CIFS を、Linux では NFS を使用します。
各サービスが使用するポート番号
サービス
ポート番号
MySQL
Solr
3770 *1
8983 *1
Worker
CIFS(Windows のみ)
8686 *1
445
NFS(Linux のみ)
2049 *2
*1
:初期設定でのポート番号です。設定によって異なります。
*2
:マウントに NFSv4 を使用する場合のポート番号です。
14
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.2 インストール前の準備
ガルーンがサーバー分離構成の場合
ガルーンをサーバー分離構成で運用している場合、ガルーンと全文検索サーバーは、次の経路で通信します。
:ポート番号
ガルーン
アプリケーションサーバー
検索をリクエスト
8983
全文検索サーバー
8686
データの追加を通知
データを取得
3770
添付ファイルにアクセス
445 / 2049
ガルーン
データベースサーバー
ガルーンが DB 分割構成の場合
ガルーンを DB 分割構成で運用している場合、ガルーンのインストール時に指定したデータベースサーバーで
キューを管理します。キューを管理するサーバーだけが、全文検索サーバーの Worker と通信します。
:ポート番号
ガルーン
アプリケーションサーバー
検索をリクエスト
データの追加を通知 8686
8983
全文検索サーバー
データを取得
キューを管理する
サーバー
3770
×
添付ファイルにアクセス
445 / 2049
ガルーン
データベースサーバー
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
添付ファイルを保存したサーバー
15
2 章 インストールする
補足
DB 分割構成でガルーンを運用する場合、設定ファイル「setting.ini」の「mysql_job_host」プロパティで指定し
ているデータベースサーバーで、キューが管理されます。
2.2.2
ガルーンの情報を確認する
ガルーンのバージョンが 4.0.0 以降であることを確認します。
また、ガルーンの次の情報をあらかじめ取得します。
必要な情報と説明
必要な情報
インストール識別子
説明
標準では cbgrn です。
MySQL が使用するポート番号
データベース接続ユーザーのパスワード
標準では 3770 です。
ガルーンのインストール時に指定したパスワードです。
データベース管理ユーザーのパスワード
IP アドレスまたはホスト名
ガルーンを運用する各サーバーの、IP アドレスまたはホスト名です。
補足
全文検索サーバーは、「cb_slash」というディレクトリーを使用します。ガルーンのインストール識別子が「slash」
の場合、全文検索サーバーを設定できません。
2.2.3
必要なアーカイブを用意する
全文検索サーバーのインストールに必要なアーカイブの入手方法は、サイボウズにお問い合わせください。
次のアーカイブが必要です。
全文検索サーバーのインストーラー
Windows 版:cbfts64-2.0.1.exe
Linux 版:cbfts64-2.0.1.bin
2.2.4
インストール済みの MySQL を使用する場合
ガルーンと同じサーバーに全文検索サーバーをインストールする場合、ガルーンが、インストーラーに同梱されてい
る MySQL かインストール済みの MySQL の、どちらの MySQL を使用しているか確認してください。
インストール済みの MySQL を使用している場合は、全文検索のインストール時に専用の設定が必要です。
詳細は、サイボウズまでお問い合わせください。
2.3
Windows 環境にインストールする
Windows 環境に全文検索サーバーをインストールする方法と、インストール後に必要な設定を説明します。
ここでは、各ディレクトリーのパスとインストール識別子について、次の設定を想定して説明します。
各ディレクトリーのパスとインストール識別子
種類
16
パス/識別子
ドキュメントルートディレクトリー
CGI 実行ディレクトリー
C:¥inetpub¥wwwroot
C:¥inetpub¥scripts
ガルーンと全文検索サーバーのインストールディレクトリー
C:¥Program Files¥Cybozu
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
種類
ガルーンのインストール識別子
パス/識別子
cbgrn
パスやインストール識別子の設定が上記と異なる場合、読み替えてください。
2.3.1
全文検索サーバーをインストールする
全文検索サーバーを運用するサーバーに、全文検索サーバーをインストールします。
操作手順:
1
2
3
4
全文検索サーバーを運用するサーバーに、Administrator ユーザーでログインします。
任意のディレクトリーに、全文検索サーバーのインストーラー「cbfts64-2.0.1.exe」を配置します。
インストーラーを実行します。
画面の指示に従って、インストールします。
インストール中、次の情報を指定します。
インストール中に指定する情報
入力する情報
全文検索サーバーをインストールする
ディレクトリー
アプリケーション識別子
説明
全文検索サーバーのインストール先を指定します。
指定したディレクトリーの配下に検索用のインデックスが保存されます。パー
ティションの空き容量に注意してください。
必要な空き容量については、次のページを参照してください。
「1.3 動作環境」 - 8 ページ
ガルーンのインストール識別子を指定します。
既定の設定でガルーンをインストールした場合、識別子は「cbgrn」です。
アプリケーションの DB ポート番号
ガルーンの MySQL のポート番号を指定します。
既定の設定でガルーンをインストールした場合、ポート番号は 3770 です。
アプリケーションの DB 接続パスワード
ガルーンの「データベース接続ユーザー」のパスワードを指定します。
補足
全文検索サーバーを運用するサーバーでウイルス対策ソフトウェアが動作している場合、検索用のインデックスが
作成されるディレクトリーをウイルススキャンの対象から外す必要があります。
次のディレクトリーをウイルススキャンの対象から外します。
(全文検索サーバーのインストールディレクトリー)¥cbfts
例:
C:¥Program Files¥Cybozu¥cbfts
2.3.2
ガルーンと全文検索サーバーの接続を設定する
ガルーンと全文検索サーバーとの通信に必要な設定を行います。
この操作は、ガルーンと異なるサーバーに全文検索サーバーをインストールしている場合に行います。
ガルーンと全文検索サーバーを同じサーバーにインストールしている場合は、この操作は必要ありません。次の手
順に進んでください。
「2.3.4 MySQL で通知を有効化する」 - 30 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
17
2 章 インストールする
全文検索サーバーの設定
全文検索サーバーをインストールしたサーバーで、ガルーンへの接続の設定と、ガルーンからの接続を許可する設
定を行います。
ガルーンへの接続を設定する
全文検索サーバーの設定ファイルを編集し、ガルーンへの接続を設定します。
操作手順:
1
全文検索サーバーの設定ファイル「cbgrn.json」と「slash.json」を編集します。
cbgrn.json と slash.json のファイルパス:
•
cbgrn.json: C:¥Program Files¥Cybozu¥cbfts¥conf¥cb¥cbgrn.json
•
slash.json: C:¥Program Files¥Cybozu¥cbfts¥conf¥cb¥slash.json
変更内容:
{
"map": {
"0": [
{
"username": "cb_cbgrn",
"host": "garoon-server",
"password": "cybozu",
"port": 3770
}
]
},
"algorithm": "range-int"
a)
b)
}
a):ガルーンのサーバー構成に合わせて、次の IP アドレス、またはホスト名を指定します。
単体構成:ガルーンのサーバーの IP アドレス、またはホスト名
サーバー分離構成:ガルーンのデータベースサーバーの IP アドレス、またはホスト名
b):ガルーンのデータベース接続ユーザーのパスワードを指定します。
ガルーンからの接続を許可する
初期設定では、全文検索サーバーにはほかのサーバーから接続できません。ガルーンのサーバーから接続できる
ように設定を変更する必要があります。
この設定を行うと、ガルーン以外のサーバーからも全文検索サーバーに接続できるようになります。セキュリティの保
護のため、全文検索サーバーをインストールしたサーバーにファイアウォールを設定し、ガルーンのサーバーからの
接続だけを許可してください。
ガルーンと全文検索サーバーとの間で行われる通信については、次のページを参照してください。
「ガルーンと全文検索サーバーとの間の通信」 - 14 ページ
注意
ファイアウォールは必ず設定してください。全文検索サーバーには、ガルーンのデータの一部が保存されます。
18
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
操作手順:
1
全文検索サーバーの設定ファイル「configure」を編集します。
configure のファイルパス:
C:¥Program Files¥cybozu¥cbfts¥bin¥configure
変更内容:
workerHost=0.0.0.0
solrHost=0.0.0.0
workerPort=8686
solrPort=8983
a)
a):「127.0.0.1」を「0.0.0.0」に変更します。
2
Worker と Solr を停止します。
次のコマンドを実行します。
net stop Cybozu_SearchServer_Worker
net stop Cybozu_SearchServer_Solr
3
全文検索サーバーをインストールしたサーバーでコマンドプロンプトを起動し、次のディレクトリーに移動しま
す。
C:¥Program Files¥Cybozu¥cbfts¥bin
次のコマンドを実行します。
cd C:¥Program Files¥Cybozu¥cbfts¥bin
4
Solr と Worker のサービスを削除します。
次のコマンドを実行します。
SolrService.bat remove
WorkerService.bat remove
5
Solr と Worker のサービスを再追加します。
次のコマンドを実行します。
SolrService.bat install 0.0.0.0 8983
WorkerService.bat install 0.0.0.0 8686
6
Solr と Worker を起動します。
次のコマンドを実行します。
net start Cybozu_SearchServer_Solr
net start Cybozu_SearchServer_Worker
ファイアウォールの設定
Windows Server 2012 で Windows ファイアウォールを使用する場合を例に、ファイアウォールの設定方法を説
明します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
19
2 章 インストールする
設定手順:
1
2
3
Windows のスタートメニューから、[コントロールパネル] > [システムとセキュリティ] > [Windows
ファイアウォール] の順に選択します。
[詳細設定]をクリックします。
「受信の規則」を選択し、[新しい規則]をクリックします。
4
「ポート」を選択し、[次へ]をクリックします。
5
プロトコルを選択し、「特定のローカルポート」にポート番号を入力して、[次へ]をクリックします。
設定するプロトコルとポート番号は、次のとおりです。
項目
Solr
Worker
プロトコル
ポート番号
TCP
TCP
8983
8686
UDP
8686
1 度に設定できる規則は 1 つです。
20
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
Solr の設定例:
6
「接続を許可する」を選択し、[次へ]をクリックします。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
21
2 章 インストールする
7
プロファイルのすべての項目のチェックボックスを選択し、[次へ]をクリックします。
8
規則の名前を入力し、[完了]をクリックします。
22
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
9
手順 3 から手順 8 を繰り返し、Solr と Worker のそれぞれの規則を追加します。
Worker は TCP と UDP の両方の規則を追加します。
ガルーンの設定
ガルーンを運用しているサーバーで、全文検索サーバーとの接続に必要な設定を行います。
設定ファイル「fts.json」を編集する
fts.json に、全文検索サーバーの情報を記述します。
ガルーンを複数のサーバーで運用している場合は、すべてのサーバーで設定を行います。
操作手順:
1
ガルーンを運用しているサーバーで、「fts.json」を編集します。
fts.json のファイルパス:
C:¥Program Files¥Cybozu¥cbfts¥conf¥cb¥fts.json
変更内容:
{
"map": {
"0": [
{
"username": null,
"host": "search-server",
"password": null,
"port": 8983
}
]
},
"algorithm": "range-int"
a)
}
a):全文検索サーバーの IP アドレス、またはホスト名を指定します。
2
ガルーンのすべてのサーバーに対して、手順 1 を実行します。
ファイアウォールの設定
全文検索サーバーからガルーンに接続できるように、ガルーンを運用しているサーバーのファイルウォールに受信
の規則を追加します。
「特定のローカルポート」に設定するプロトコルとポートは、次のとおりです。
項目
MySQL
プロトコル
TCP
ポート番号
3770
添付ファイル保存ディレクトリー
TCP
445
ファイアウォールに規則を追加する手順は、次のページを参照してください。
「ファイアウォールの設定」 - 19 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
23
2 章 インストールする
2.3.3
添付ファイル保存領域を共有する
ガルーンの添付ファイル保存ディレクトリーの共有設定をして、全文検索サーバーからアクセスできるようにします。
この設定は、全文検索サーバーが添付ファイルの検索に必要なインデックスを作成するために必要な設定です。ガ
ルーンの添付ファイルを保存しているサーバーと、全文検索サーバーをインストールしたサーバーの、両方で行いま
す。
この操作は、ガルーンと異なるサーバーに全文検索サーバーをインストールしている場合に行います。ガルーンと全
文検索サーバーを、同じサーバーにインストールしている場合は、この操作は必要ありません。次の手順に進んでく
ださい。
「2.3.4 MySQL で通知を有効化する」 - 30 ページ
ガルーンの添付ファイルを保存しているサーバーで行う設定
Windows Server 2012 での操作を例に、ガルーンの添付ファイルを保存しているサーバーで行う設定を説明しま
す。
ユーザーを作成する
Windows で、ガルーンの添付ファイルへアクセスするために、Worker が使用するユーザーを作成します。
操作手順:
1
2
3
4
24
ガルーンの添付ファイルを保存しているサーバーに Administrator ユーザーでログインします。
「スタート」メニューで、[管理ツール]をクリックします。
[コンピューターの管理]をダブルクリックします。
「コンピューターの管理」ウィンドウの左側のフレームで、[コンピューターの管理] > [システムツール] >
[ローカルユーザーとグループ] > [ユーザー] の順に選択します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
5
6
ウィンドウ上部のメニューで、[操作] > [新しいユーザー]の順にクリックします。
「新しいユーザー」ウィンドウで、次の情報を入力し[作成]をクリックします。
ユーザー名:Garoon
パスワード:任意
ユーザーは次回ログオン時にパスワードの変更が必要:オフ
ユーザーはパスワードを変更できない:オフ
パスワードを無期限にする:オン
アカウントを無効にする:オフ
7
[閉じる]をクリックします。
添付ファイル保存ディレクトリーの共有設定をする
ガルーンの添付ファイル保存ディレクトリーの共有設定をして、Windows に作成したユーザー「Garoon」に読み取
りを許可します。
操作手順:
1
ガルーンの添付ファイル保存ディレクトリーを右クリックし、[プロパティ]をクリックします。
ガルーンを既定の設定でインストールした場合、添付ファイルは次のディレクトリーに保存されています。
C:¥Program Files¥Cybozu¥mysql-5.0¥files
2
3
4
「共有」タブを選択します。
[詳細な共有]をクリックします。
「このフォルダーを共有する」のチェックボックスを選択し、[アクセス許可]をクリックします。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
25
2 章 インストールする
5
6
7
8
9
26
「グループ名またはユーザー名」で「Everyone」を選択し、[削除]をクリックします。
[追加...]をクリックします。
「選択するオブジェクト名を入力してください。」に「Garoon」と入力し、[名前の確認]をクリックします。
[OK]をクリックします。
「グループ名またはユーザー名」で「Garoon」を選択し、「読み取り」の「許可」のチェックボックスだけが選択さ
れていることを確認します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
10
11
12
[OK]をクリックします。
[OK]をクリックします。
[閉じる]をクリックします。
全文検索サーバーをインストールしたサーバーで行う設定
Windows Server 2012 での操作を例に、全文検索サーバーをインストールしたサーバーで行う設定を説明しま
す。
ユーザーを作成する
Windows で、ガルーンの添付ファイルへアクセスするために、Worker が使用するユーザーを作成します。
操作手順:
1
2
3
4
5
6
全文検索サーバーをインストールしたサーバーに Administrator ユーザーでログインします。
「スタート」メニューで、[管理ツール]をクリックします。
[コンピューターの管理]をダブルクリックします。
「コンピューターの管理」ウィンドウの左側のフレームで、[コンピューターの管理] > [システムツール] >
[ローカルユーザーとグループ] > [ユーザー] の順に選択します。
上部のメニューで、[操作] > [新しいユーザー]の順にクリックします。
「新しいユーザー」ウィンドウで、次の情報を入力し[作成]をクリックします。
ユーザー名:Garoon
パスワード:任意
ユーザーは次回ログオン時にパスワードの変更が必要:オフ
ユーザーはパスワードを変更できない:オフ
パスワードを無期限にする:オン
アカウントを無効にする:オフ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
27
2 章 インストールする
7
[閉じる]をクリックします。
Worker の実行ユーザーを設定する
Worker の実行ユーザーを、Windows に作成したユーザー「Garoon」に設定します。
操作手順:
1
2
3
4
5
6
「スタート」メニューで、[管理ツール]をクリックします。
[サービス]をダブルクリックします。
「サービス(ローカル)」で、「Cybozu_SearchServer_Worker」を右クリックし、[プロパティ]をクリックし
ます。
「ログオン」タブで、「アカウント」のラジオボタンを選択し、[参照]をクリックします。
「選択するオブジェクト名を入力してください。」に「Garoon」と入力し、[名前の確認]をクリックします。
[OK]をクリックします。
手順 5 で指定したユーザーが「アカウント」に表示されていることを確認します。
28
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
7
手順 5 で指定したアカウントにパスワードを設定します。
「パスワード」と「パスワードの確認入力」に、ユーザー「Garoon」の作成時に指定したパスワードを入力しま
す。
8
9
10
11
[適用]をクリックします。
「全般」タブをクリックし、[停止]をクリックします。
[開始]をクリックします。
[OK]をクリックします。
ガルーンの添付ファイルディレクトリーへのシンボリックリンクを作成する
操作手順:
1
次のディレクトリーを作成します。
C:¥Program Files¥Cybozu¥mysql-5.0
2
コマンドプロンプトを起動し、手順 1 で作成したディレクトリーに移動します。
次のコマンドを実行します。
cd C:¥Program Files¥Cybozu¥mysql-5.0
3
ガルーンの添付ファイル保存ディレクトリーへのシンボリックリンクを作成します。
次のコマンドを実行します。
mklink /d files ¥¥[ガルーンのサーバーの IP アドレス、またはホスト名]¥files
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
29
2 章 インストールする
2.3.4
MySQL で通知を有効化する
ガルーンの MySQL で、通知を有効化します。通知を有効化すると、MySQL は、キューへのジョブの追加を全文検
索サーバーに通知するようになります。
サーバー分離構成でガルーンを運用している場合、この作業はデータベースサーバーで行います。
環境変数「WORKER_HOST」と「WORKER_PORT」を設定する
ここでは、Windows Server 2012 での操作を例に手順を説明します。
操作手順:
1
2
3
4
5
6
「スタート」メニューで、「コンピューター」を右クリックします。
[プロパティ]をクリックします。
[システムの詳細設定]をクリックします。
[環境変数]をクリックします。
「システム環境変数」の[新規]をクリックします。
次の変数名と値を設定し、[OK]をクリックします。
変数名:WORKER_HOST
値:全文検索サーバーをインストールしたサーバーの IP アドレス
ガルーンと全文検索サーバーを同じサーバーで運用する場合は、127.0.0.1 を設定します。
7
30
次の変数名と値を設定し、[OK]をクリックします。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
変数名:WORKER_PORT
値:8686
8
9
10
[OK]をクリックします。
[OK]をクリックします。
データべースエンジンを再起動します。
コマンドプロンプトで、次のコマンドを実行します。
net stop Cybozu_Database_Engine_5_0
net start Cybozu_Database_Engine_5_0
通知を有効化するためのコマンドを実行する
ガルーンの MySQL で、通知を有効化するためのコマンドを実行します。
操作手順:
1
2
ガルーンのデータベースサーバーに Administrator ユーザーでログインします。
コマンドプロンプトを起動し、次のディレクトリーに移動します。
C:¥inetpub¥scripts¥cbgrn
次のコマンドを実行します。
cd C:¥inetpub¥scripts¥cbgrn
3
次のコマンドを実行します。
.¥grn.exe -C -q code¥command¥fts¥enable_udf_notifier.csp db_admin_password=(データベース管
理ユーザーのパスワード)
「UDF notifier is available.」と表示されることを確認します。
エラーメッセージが表示された場合の対処方法は、次のとおりです。
エラーメッセージ
Error: DB00000
A database error has occurred.
Database error number: DB00000
Cause:
DB サーバーへの接続に失敗しました
Error: DB99999
A database error has occurred.
Database error number: (エラーコード)
Cause:
Response from database: (エラーメッセージ)
4
5
対処方法
MySQL が起動していない場合は、起動します。
MySQL がすでに起動している場合は、データベース管理ユー
ザーのパスワードが間違っている可能性があります。正しいパ
スワードを指定してください。
MySQL を読み込めません。サイボウズにお問い合わせくださ
い。
全文検索サーバーをインストールしたサーバーに Administrator ユーザーでログインします。
Worker を再起動します。
次のコマンドを実行します。
net stop Cybozu_SearchServer_Worker
net start Cybozu_SearchServer_Worker
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
31
2 章 インストールする
2.3.5
ガルーンで全文検索機能を有効化する
ガルーンの設定ファイルを編集し、全文検索機能を有効化します。
複数のサーバーでガルーンを運用している場合、この作業はすべてのサーバーで行います。
操作手順:
1
2
ガルーンを運用しているサーバーに Administrator ユーザーでログインします。
設定ファイル「common.ini」を編集します。
common.ini のファイルパス:
C:¥inetpub¥scripts¥cbgrn¥common.ini
変更内容:
enable_fts の値を、0 から 1 に変更します。
[FTS]
;; 'enable_fts' sets whether full text search is available.
;; 0: unavailable full text search
;; 1: enable indexing and searchable
;; 2: enable indexing, but invalid full text search
enable_fts = 1
;; There are limitation of searching once for each application.
bulletin_max_category = 10000;
cabinet_max_folder = 10000;
message_max_message = 1000000;
space_max_space = 1000000;
enable_fts の値を変えると、全文検索機能の有効または無効の切り替えができます。
設定できる値と機能は次のとおりです。
3
4
値
0
機能
検索ボックスを非表示にし、インデックスの作成を中止します。
1
2
検索ボックスを表示し、全文検索機能を有効にします。
検索ボックスを非表示にし、インデックスの作成は継続します。
サーバー分離構成でガルーンを運用している場合は、すべてのサーバーで手順 1 から手順 2 を実行します。
ガルーンの Web サーバーを再起動します。
アプリケーションサーバーが複数ある場合は、すべてのアプリケーションサーバーで Web サーバーを起動しま
す。
5
32
ガルーンにログインし、画面上部のバーに検索ボックスが表示されていることを確認します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
検索ボックスが表示されない場合
検索ボックスが表示されない場合は、次のディレクトリー内のディレクトリーやファイルをすべて削除し、ガルーンの
画面を再読み込みしてください。
C:¥inetpub¥scripts¥cbgrn¥smarty¥compiled
「compiled」ディレクトリー自体は削除しないよう注意してください。
2.3.6
インデックスを作成する
全文検索に必要なインデックスを作成します。
注意
ガルーンのデータ量が多いと、インデックスの作成に時間がかかります。ガルーンのデータが 1TB の場合、イン
デックスの作成に 1 週間程度かかることを弊社で確認しています。
なお、新規に構築したガルーンの場合、インデックスの作成は数分で完了します。
インデックスの作成中は、ガルーンに高い負荷がかかります。業務時間を避けてインデックスを作成してください。
ガルーンの MySQL が停止している間は、インデックスを作成できません。
バックアップなどの目的で MySQL を停止する場合は、インデックスの作成を停止してください。
ガルーンを運用しているサーバーでウイルス対策ソフトウェアが動作している場合、インデックスを作成する前に、
ウイルススキャンの対象から次のディレクトリーを外す必要があります。
(ガルーンのインストールディレクトリー)¥mysql-5.0¥files¥(インストール識別子)¥mail¥tmp_solr_index
例:
C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥mail¥tmp_solr_index
操作手順:
1
ガルーンを運用しているデータベースサーバーに Administrator ユーザーでログインします。
サーバー分離構成の場合は、データベースサーバーに Administrator ユーザーでログインします。
2
コマンドプロンプトを起動し、次のディレクトリーに移動します。
C:¥inetpub¥scripts¥cbgrn
次のコマンドを実行します。
cd C:¥inetpub¥scripts¥cbgrn
3
インデックスの作成を開始します。
次のコマンドを実行します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
33
2 章 インストールする
.¥grn.exe -C -q code¥command¥fts¥full_index.csp (パラメーター)
パラメーター
パラメーター
必須
number
○
説明
プロセスが一度に作成するインデックスの件数を指定します。
特別な事情がない限り、50 を指定してください。
例:number=50
startTime
サーバーで、インデックスの作成を開始する時刻を、24 時間表記で指定します。
ガルーンのシステム管理で「ロケールの初期値」に設定されているタイムゾーンの時刻
を、0 から 23 の整数で指定します。
例:startTime=20
startTime は、stopTime とセットで指定します。ただし、startTime と stopTime
には、同じ値は指定できません。
stopTime
サーバーで、インデックスの作成を中止する時刻を、24 時間表記で指定します。
ガルーンのシステム管理で「ロケールの初期値」に設定されているタイムゾーンの時刻
を、0 から 23 の整数で指定します。
例:stopTime=8
stopTime は、startTime とセットで指定します。ただし、startTime と stopTime
には、同じ値は指定できません。
コマンドの実行例:
.¥grn.exe -C -q code¥command¥fts¥full_index.csp number=50 startTime=20 stopTime=8
補足
ロケールの初期値の詳細は、次のページを参照してください。
『管理者ガイド』の「ローカライズの機能を設定する」
https://help.cybozu.com/ja/g40/admin/system/localization/index.html#localization_index_0
1
インデックスの作成ログは、標準出力にのみ出力されます。必要に応じて、ログの出力をファイルにリダイレクトし
て保存してください。
コマンドの例:
.¥grn.exe -C -q code¥command¥fts¥full_index.csp number=50 > indexing.log 2>&1
インデックスの作成を中止した場合、コマンドを再実行すると、作成が再開されます。
インデックスの作成が完了したあとにコマンドを再実行すると、ガルーンのすべてのデータを対象に、インデックス
が再作成されます。
インデックスの作成を中止したあとに、ガルーンのすべてのデータを対象にインデックスを再作成するには、レ
ジューム管理ファイルを削除する必要があります。
レジューム管理ファイルについては、次のページを参照してください。
「インデックス作成のレジューム管理ファイルについて」 - 35 ページ
インデックスの作成が完了するまで、インデックスを作成するコマンドを繰り返し実行する場合は、コマンドを実行
する前に、インデックスの作成が未完了であることを確認してください。
レジューム管理ファイルが存在すれば、インデックスの作成は未完了です。
レジューム管理ファイルについては、次のページを参照してください。
「インデックス作成のレジューム管理ファイルについて」 - 35 ページ
各アプリケーションのデータのインデックスは、次の順番で作成されます。
1. 掲示板
2. メッセージ
3. ファイル管理
4. スペース
5. メール
34
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.3 Windows 環境にインストールする
インデックスの作成を停止する
何らかの理由により、インデックスの作成処理を即時停止する場合は、Ctrl キーと C キーを同時に押します。
インデックス作成のレジューム管理ファイルについて
全文検索サーバーは、インデックス作成の進捗を、次の 2 つのファイル(レジューム管理ファイル)で管理します。
C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥fts¥full_index_resume.json
C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥fts¥full_index_arguments.json
上記のファイルは、インデックスの作成が完了すると削除されます。
2.3.7
作業後の確認
作業後に確認する内容は、ガルーンを新規に構築した場合と、運用中のガルーンの場合とで異なります。
新規に構築したガルーンの場合
新規に構築したガルーンでは、インデックスの作成は数分で完了します。メールのインデックスの作成が終われば、
インデックスの作成は完了です。メールのインデックスの作成が完了すると、コマンドラインに次のメッセージが表示
されます。
[(出力日時)] Finish indexing of received files, tab_grn_mail_fileinfo___p49.
[(出力日時)] Finish indexing of received files.
[(出力日時)] Finish indexing of mail data.
上記のメッセージが表示されたら、次の点を確認します。
掲示板やメッセージに書き込んだ文字列で検索できるかどうか
ファイル管理に添付した文書ファイル内の文字列で検索できるかどうか
検索仕様については、次のページを参照してください。
「6.3 検索仕様」 - 93 ページ
インデックス作成後のトラブルと対処方法
インデックスの作成後にトラブルが発生した場合の対処方法は、次のとおりです。
トラブル
対処方法
「GRN_FTS_00002」のエラーメッ
セージが表示される
コマンドプロンプトで次のコマンドを実行し、全文検索サーバーの Solr を起動します。
net start Cybozu_SearchServer_Solr
上記のコマンドを実行しても解決しない場合、ガルーンから全文検索サーバーへの接
続が正しく設定されているかどうかを確認してください。
「ガルーンの設定」 - 23 ページ
次の操作を実施済みであることを確認します。
検索結果が表示されない
MySQL での通知の有効化
「2.3.4 MySQL で通知を有効化する」 - 30 ページ
ガルーンから全文検索サーバーへの接続設定
「ガルーンの設定」 - 23 ページ
全文検索サーバーからガルーンへの接続設定
「全文検索サーバーの設定」 - 18 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
35
2 章 インストールする
運用中のガルーンの場合
運用中のガルーンでは、インデックスの作成に時間がかかります。インデックスの作成が完了したら、正常に検索で
きることを確認します。
インデックスの作成が進んでいることを確認する
次の操作で、インデックスが作成中であることを確認できます。
操作手順:
1
2
ガルーンのシステム管理画面で、[基本システムの管理] > [キューの監視] > [全文検索サーバー]の順
にクリックします。
インデックスの作成が進んでいることを確認します。
「全文検索サーバー」画面で、次の 2 点を確認します。
•
「キューの残数」が変化すること
•
画面を再読み込みすると、表示されるデータが変わること
画面例:
「message」は表示されない場合があります。
画面の見かたの詳細は、次のページを参照してください。
「5.4 キューの状況を確認する」 - 85 ページ
確認中のトラブルと対処方法
インデックスの作成を確認中にトラブルが発生した場合の対処方法は、次のとおりです。
トラブル
キューの監視画面を開けない
対処方法
次の操作を実施済みであることを確認します。
ガルーンでの全文検索機能の有効化
「2.3.5 ガルーンで全文検索機能を有効化する」 - 32 ページ
36
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
トラブル
画面を再読み込みしても、表示され
るデータが変わらない
対処方法
次の操作を実施済みであることを確認します。
MySQL での通知の有効化
「2.3.4 MySQL で通知を有効化する」 - 30 ページ
ガルーンから全文検索サーバーへの接続設定
「ガルーンの設定」 - 23 ページ
全文検索サーバーからガルーンへの接続設定
「全文検索サーバーの設定」 - 18 ページ
検索できることを確認する
メールのインデックスの作成が終われば、インデックスの作成は完了です。メールのインデックスの作成が完了する
と、コマンドラインに次のメッセージが表示されます。
[(出力日時)] Finish indexing of received files, tab_grn_mail_fileinfo___p49.
[(出力日時)] Finish indexing of received files.
[(出力日時)] Finish indexing of mail data.
上記のメッセージが表示されたら、次の点を確認します。
掲示板やメッセージに書き込んだ文字列で検索できるかどうか
ファイル管理に添付した文書ファイル内の文字列で検索できるかどうか
検索仕様については、次のページを参照してください。
「6.3 検索仕様」 - 93 ページ
インデックス作成後のトラブルと対処方法
インデックスの作成後にトラブルが発生した場合の対処方法は、次のとおりです。
トラブル
「GRN_FTS_00002」のエラーメッ
セージが表示される
2.4
対処方法
コマンドプロンプトで次のコマンドを実行し、全文検索サーバーの Solr を起動しま
す。
net start Cybozu_SearchServer_Solr
上記のコマンドを実行しても解決しない場合、ガルーンから全文検索サーバーへの
接続が正しく設定されているかどうかを確認してください。
「ガルーンの設定」 - 23 ページ
Linux 環境にインストールする
Linux 環境に全文検索サーバーをインストールする方法と、インストール後に必要な設定を説明します。
DB 分割構成でガルーンを運用している場合は、次のページを参照してください。
「4.1 全文検索サーバーをインストールする」 - 61 ページ
ここでは、各ディレクトリーのパスとインストール識別子について、次の設定を想定して説明します。
各ディレクトリーのパスとインストール識別子
種類
ドキュメントルートディレクトリー
/var/www/html/
CGI 実行ディレクトリー
/var/www/cgi-bin/
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
パス/識別子
37
2 章 インストールする
種類
ガルーンと全文検索サーバーのインストールディレクトリー
パス/識別子
/usr/local/cybozu/
ガルーンのインストール識別子
cbgrn
パスやインストール識別子の設定が上記と異なる場合、読み替えてください。
2.4.1
全文検索サーバーをインストールする
全文検索サーバーを運用するサーバーに、全文検索サーバーをインストールします。
注意
全文検索サーバーをインストールするサーバーには、Apache(Web サーバー)の実行ユーザー「apache」が存
在する必要があります。サーバーに Apache がインストールされていない場合は、全文検索サーバーをインス
トールする前に Apache をインストールしてください。ただし、Web サーバーを起動する必要はありません。
操作手順:
1
2
3
全文検索サーバーを運用するサーバーに、root ユーザーでログインします。
任意のディレクトリーに、全文検索サーバーのインストーラー「cbfts64-2.0.1.bin」を配置します。
インストーラーを実行します。
インストーラーを配置したディレクトリーで、次のコマンドを実行します。
sh cbfts64-2.0.1.bin
4
画面の指示に従って、全文検索サーバーをインストールします。
インストール中、次の情報を指定します。
インストール中に指定する情報
入力する情報
説明
全文検索サーバーをインストールする
ディレクトリー
全文検索サーバーのインストール先を指定します。
指定したディレクトリーの配下に検索用のインデックスが保存されます。パー
ティションの空き容量に注意してください。
必要な空き容量については、次のページを参照してください。
「1.3 動作環境」 - 8 ページ
アプリケーション識別子
ガルーンのインストール識別子を指定します。
既定の設定でガルーンをインストールした場合、識別子は「cbgrn」です。
アプリケーションの DB ポート番号
ガルーンの MySQL のポート番号を指定します。
既定の設定でガルーンをインストールした場合、ポート番号は 3770 です。
ガルーンの「データベース接続ユーザー」のパスワードを指定します。
アプリケーションの DB 接続パスワード
アプリケーションの実行ユーザー
ガルーンのサーバーで動作している Web サーバーの実行ユーザーを指定
します。通常の設定では、実行ユーザーは「apache」です。
補足
全文検索サーバーを運用するサーバーでウイルス対策ソフトウェアが動作している場合、検索用のインデックスが
作成されるディレクトリーをウイルススキャンの対象から外す必要があります。
次のディレクトリーをウイルススキャンの対象から外します。
(全文検索サーバーのインストールディレクトリー)/cbfts/
例:/usr/local/cybozu/cbfts/
38
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
2.4.2
ガルーンと全文検索サーバーの接続を設定する
ガルーンと全文検索サーバーとの通信に必要な設定を行います。
この操作は、ガルーンと異なるサーバーに全文検索サーバーをインストールしている場合に行います。
ガルーンと全文検索サーバーを、同じサーバーにインストールしている場合は、この操作は必要ありません。次の手
順に進みます。
「2.4.4 MySQL で通知を有効化する」 - 46 ページ
全文検索サーバーの設定
全文検索サーバーをインストールしたサーバーで、ガルーンへの接続の設定と、ガルーンからの接続を許可する設
定を行います。
ガルーンへの接続を設定する
全文検索サーバーの設定ファイルを編集し、ガルーンへの接続を設定します。
操作手順:
1
全文検索サーバーの設定ファイル「cbgrn.json」と「slash.json」を編集します。
cbgrn.json と slash.json のファイルパス:
•
cbgrn.json: /usr/local/cybozu/cbfts/conf/cb/cbgrn.json
•
slash.json: /usr/local/cybozu/cbfts/conf/cb/slash.json
変更内容:
{
"map": {
"0": [
{
"username": "cb_cbgrn",
"host": "garoon-server",
"password": "cybozu",
"port": 3770
}
]
},
"algorithm": "range-int"
a)
b)
}
a):ガルーンのサーバー構成に合わせて、次の IP アドレス、またはホスト名を指定します。
・ 単体構成: ガルーンのサーバーの IP アドレス、またはホスト名
・ サーバー分離構成: ガルーンのデータベースサーバーの IP アドレス、またはホスト名
b):ガルーンのデータベース接続ユーザーのパスワードを指定します。
ガルーンからの接続を許可する
初期設定では、全文検索サーバーにはほかのサーバーから接続できません。ガルーンのサーバーから接続できる
ように設定を変更する必要があります。
この設定を行うと、ガルーン以外のサーバーからも全文検索サーバーに接続できるようになります。セキュリティの保
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
39
2 章 インストールする
護のため、全文検索サーバーをインストールしたサーバーにファイアウォールを設定し、ガルーンのサーバーからの
接続だけを許可してください。
ガルーンと全文検索サーバーとの間で行われる通信については、次のページを参照してください。
「ガルーンと全文検索サーバーとの間の通信」 - 14 ページ
注意
セキュリティのため、ファイアウォールは必ず設定してください。全文検索サーバーには、ガルーンのデータの一部
が保存されます。
操作手順:
1
全文検索サーバーの設定ファイル「configure」を編集します。
configure のファイルパス:
/usr/local/cybozu/cbfts/bin/configure
変更内容:
workerHost=0.0.0.0
solrHost=0.0.0.0
workerPort=8686
solrPort=8983
a)
a):「127.0.0.1」を「0.0.0.0」に変更します。
2
Worker と Solr を再起動します。
次のコマンドを実行します。
/etc/init.d/cbss_worker stop
/etc/init.d/cbss_solr stop
/etc/init.d/cbss_solr start
/etc/init.d/cbss_worker start
ファイアウォールの設定
iptables を使用する場合を例に、ファイアウォールの設定方法を説明します。
設定手順:
1
iptables の設定ファイル「iptables」を編集します。
iptables のファイルパス:
/etc/sysconfig/iptables
変更内容:
設定は、ガルーンを運用しているサーバーの IP アドレスが「192.168.1.10」の場合の例です。
ガルーンを運用しているサーバーごとに、次の設定を追記します。
•
アプリケーションサーバー:
-I RH-Firewall-1-INPUT -p tcp -s 192.168.1.10 --dport 8983 -j ACCEPT
•
データベースサーバー:
-I RH-Firewall-1-INPUT -p tcp -s 192.168.1.10 --dport 8686 -j ACCEPT
-I RH-Firewall-1-INPUT -p udp -s 192.168.1.10 --dport 8686 -j ACCEPT
40
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
2
iptables を再起動します。
次のコマンドを実行します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
/etc/init.d/iptables restart
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl restart iptables
設定の変更が iptables に反映されます。
3
ガルーンを運用しているサーバーからのみ、全文検索サーバーをインストールしたサーバーに接続できること
を確認します。
ガルーンを運用している各サーバーと、それ以外のサーバーで、次の 2 つのコマンドを実行します。
全文検索サーバーをインストールしたサーバーの IP アドレスが「192.168.2.10」の場合:
wget --spider http://192.168.2.10:8983/version
wget --spider http://192.168.2.10:8686/version
ガルーンを運用しているサーバーだけで「200 OK」が表示されることを確認します。
ガルーンの設定
ガルーンを運用しているサーバーで、全文検索サーバーとの接続に必要な設定を行います。
設定ファイル「fts.json」を編集する
fts.json に、全文検索サーバーの情報を記述します。
ガルーンを複数のサーバーで運用している場合は、すべてのサーバーで設定を行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
設定ファイル「fts.json」を編集します。
fts.json のファイルパス:
/usr/local/cybozu/cbfts/conf/cb/fts.json
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
41
2 章 インストールする
変更内容:
{
"map": {
"0": [
{
"username": null,
"host": "search-server",
"password": null,
"port": 8983
}
]
},
"algorithm": "range-int"
a)
}
a):全文検索サーバーの IP アドレス、またはホスト名を指定します。
3
ガルーンのすべてのサーバーに対して、手順 1 から手順 2 を実行します。
ファイアウォールの設定
全文検索サーバーからガルーンに接続できるように、ガルーンを運用しているサーバーの iptables に、全文検索
サーバーを運用しているサーバーの IP アドレス、および通信に使用するプロトコルとポート番号を設定します。
設定するプロトコルとポート番号は、次のとおりです。
項目
MySQL
添付ファイル保存ディレクトリー
プロトコル
TCP
TCP
ポート番号
3770
2049
iptables の設定方法は、次のページを参照してください。
「ファイアウォールの設定」 - 40 ページ
2.4.3
添付ファイル保存領域をマウントする
ガルーンと全文検索サーバーを、同じサーバーの同じディレクトリーにインストールしている場合は、この操作は必要
ありません。
全文検索サーバーをインストールしたサーバーから、ガルーンの添付ファイル保存ディレクトリーを NFS マウントしま
す。全文検索サーバーが添付ファイルの検索に必要なインデックスを作成するために必要な設定です。
この設定は、ガルーンの添付ファイルを保存しているサーバーと、全文検索サーバーをインストールしたサーバー
の、両方で行います。
この項では、マウントに NFSv4 を使用することを前提に、設定手順を説明します。
この操作は、ガルーンと異なるサーバーに全文検索サーバーをインストールしている場合に行います。
ガルーンと全文検索サーバーを同じサーバーにインストールしている場合は、この操作は必要ありません。次のペー
ジに進みます。
「2.4.4 MySQL で通知を有効化する」 - 46 ページ
42
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
ガルーンの添付ファイルを保存しているサーバーで行う設定
操作手順:
1
2
ガルーンの添付ファイルを保存しているサーバーに root ユーザーでログインします。
設定ファイル「exports」を編集します。
exports のファイルパス:
/etc/exports
変更内容:
次の行を追加します。
[「files」ディレクトリーのパス] [全文検索サーバーの IP アドレスまたはホスト名](rw)
入力例:
/usr/local/cybozu/mysql-5.0/files search-server(rw)
3
NFS マウントに必要なサービスを起動します。
起動するサービス:
•
rpcbind(OS が Red Hat Enterprise Linux Server 6 または 7 の場合)
•
portmapper(OS が Red Hat Enterprise Linux Server 5 の場合)
•
nfs
•
nfslock
各サービスの起動に必要なコマンド
サービス
rpcbind
4
起動に必要なコマンド
Red Hat Enterprise Linux Server 6
Red Hat Enterprise Linux Server 7
以前
/etc/init.d/rpcbind start
systemctl start rpcbind
portmapper
nfs
/etc/init.d/portmap start
/etc/init.d/nfs start
systemctl start portmap
systemctl start nfs
nfslock
/etc/init.d/nfslock start
systemctl start nfslock
手順 3 で起動したサービスの自動起動の設定を行います。
OS の起動時に、NFS マウントに必要なサービスが自動起動されるように設定します。
OS が Red Hat Enterprise Linux Server 6 または 7 の場合は rpcbind の、Red Hat Enterprise
Linux Server 5 の場合は portmapper の自動起動を設定します。
各サービスの自動起動の設定に必要なコマンド
サービス
設定に必要なコマンド
Red Hat Enterprise Linux Server
Red Hat Enterprise Linux Server 7
6 以前
rpcbind
portmapper
chkconfig rpcbind on
chkconfig portmap on
systemctl enable rpcbind
systemctl enable portmap
nfs
nfslock
chkconfig nfs on
chkconfig nfslock on
systemctl enable nfs
systemctl enable nfslock
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
43
2 章 インストールする
全文検索サーバーをインストールしたサーバーで行う設定
操作手順:
1
2
全文検索サーバーをインストールしたサーバーに root ユーザーでログインします。
NFS マウントに必要なサービスを起動します。
起動するサービス:
•
rpcbind(OS が Red Hat Enterprise Linux Server 6 または 7 の場合)
•
portmapper(OS が Red Hat Enterprise Linux Server 5 の場合)
•
nfslock
各サービスの起動に必要なコマンド
起動に必要なコマンド
サービス
3
Red Hat Enterprise Linux Server
6 以前
Red Hat Enterprise Linux Server 7
rpcbind
portmapper
/etc/init.d/rpcbind start
/etc/init.d/portmap start
systemctl start rpcbind
systemctl start portmap
nfslock
/etc/init.d/nfslock start
systemctl start nfslock
手順 2 で起動したサービスの自動起動の設定を行います。
OS の起動時に、NFS マウントに必要なサービスが自動起動されるように設定します。
OS が Red Hat Enterprise Linux Server 6 または 7 の場合は rpcbind の、Red Hat Enterprise
Linux Server 5 の場合は portmapper の自動起動を設定します。
各サービスの自動起動の設定に必要なコマンド
設定に必要なコマンド
サービス
4
Red Hat Enterprise Linux Server 6
Red Hat Enterprise Linux Server 7
以前
rpcbind
portmapper
chkconfig rpcbind on
chkconfig portmap on
systemctl enable rpcbind
systemctl enable portmap
nfslock
chkconfig nfslock on
systemctl enable nfslock
ガルーンの添付ファイル保存ディレクトリーとパスが同じディレクトリーを作成します。
次のコマンドを実行します。
mkdir -p [ガルーンの添付ファイル保存ディレクトリーのパス]
コマンドの例:
mkdir -p /usr/local/cybozu/mysql-5.0/files
5
手順 4 で作成したディレクトリーに、次のパーミッションを設定します。
•
所有者:apache
•
所有グループ:root
•
パーミッション:000
コマンドの例:
chown -R apache:root /usr/local/cybozu/mysql-5.0/files
chmod -R 000 /usr/local/cybozu/mysql-5.0/files
44
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
6
ガルーンの添付ファイル保存ディレクトリーを NFS マウントします。
次のコマンドを実行します。
mount -o intr [ガルーンの添付ファイルを保存しているサーバーの IP アドレスまたはホスト名]:[ガルーンの添付
ファイル保存ディレクトリーのパス] [手順 4 で作成したディレクトリーのパス]
コマンドの例:
mount -o intr garoon-server:/usr/local/cybozu/mysql-5.0/files /usr/local/cybozu/mysql-5.0/files
マウントに失敗する場合
マウントに失敗する場合、ガルーンの添付ファイルを保存しているサーバーで次のコマンドを実行してから、再
度 NFS マウントしてください。
exportfs -r
上記のコマンドを実行しても NFS マウントに失敗する場合、NFS マウントに必要なポートが閉じている可能性
があります。ガルーンの添付ファイルを保存しているサーバーで、2049 ポートを開放してください。
7
自動マウントを設定します。
OS の起動時に、自動的に NFS マウントされるように設定します。
次の操作を行います。
•
「netfs」サービスの自動起動を設定する
•
設定ファイル「fstab」を編集する
netfs の自動起動の設定
次のコマンドを実行します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
chkconfig netfs on
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl enable netfs
設定ファイル「fstab」の編集
fstab のファイルパスは、次のとおりです。
/etc/fstab
fstab に、1 行で次の内容を追記します。
[ガルーンの添付ファイルを保存したサーバーの IP アドレスまたはホスト名]:[ガルーンの添付ファイル保存ディレクト
リーのパス] [手順 4 で作成したディレクトリーのパス] nfs4 defaults 0 0
入力例:
garoon-server:/usr/local/cybozu/mysql-5.0/files /usr/local/cybozu/mysql-5.0/files nfs4
defaults 0 0
注意
HA クラスターソフトウェアを使用してガルーンを運用するサーバーを冗長化している場合、NFS マウントのフェイ
ルオーバーを設定してください。ガルーンの稼動系サーバーの障害時には、全文検索サーバーをインストールし
たサーバーからの NFS マウント先を、待機系サーバーに切り替える必要があります。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
45
2 章 インストールする
2.4.4
MySQL で通知を有効化する
ガルーンの MySQL で、通知を有効化します。通知を有効化すると、MySQL は、キューへのジョブの追加を全文検
索サーバーに通知するようになります。
サーバー分離構成でガルーンを運用している場合、データベースサーバーでこの作業を行います。
MySQL に Worker の情報を登録する
Worker の IP アドレスとポート番号を登録します。
操作手順:
1
2
ガルーンのデータベースサーバーに root ユーザーでログインします。
MySQL の Worker の設定ファイル「worker.ini」を編集します。
worker.ini のファイルパス:
/usr/local/cybozu/mysql-5.0/etc/worker.ini
変更内容:
WORKER_HOST の値を、全文検索サーバーの IP アドレスに変更します。
WORKER_HOST=(全文検索サーバーの IP アドレスまたはホスト名)
全文検索サーバーをインストールしたサーバーの IP アドレスが「192.168.2.10」の場合の例です。
変更前:
WORKER_HOST=127.0.0.1
WORKER_PORT=8686
変更後:
WORKER_HOST=192.168.2.10
WORKER_PORT=8686
3
MySQL を再起動します。
コマンドプロンプトで、次のコマンドを実行します。
/etc/init.d/cyde_5_0 restart
通知を有効化するためのコマンドを実行する
MySQL で通知を有効化するためのコマンドを実行します。
操作手順:
1
次のディレクトリーに移動します。
/var/www/cgi-bin/cbgrn/
コマンドの例:
cd /var/www/cgi-bin/cbgrn/
46
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
2
次のコマンドを実行します。
./grn.cgi -C -q code/command/fts/enable_udf_notifier.csp db_admin_password=(データベース管理
ユーザーのパスワード)
「UDF notifier is available.」と表示されることを確認します。
エラーメッセージが表示された場合の対処方法は、次のとおりです。
エラーメッセージ
3
4
対処方法
Error: DB00000
A database error has occurred.
Database error number: DB00000
Cause:
DB サーバーへの接続に失敗しました
MySQL が起動していない場合は、起動します。
MySQL がすでに起動している場合は、データベース管理ユーザー
のパスワードが間違っている可能性があります。正しいパスワードを
指定してください。
Error: DB99999
A database error has occurred.
Database error number: (エラーコード)
Cause:
Response from database: (エラーメッセー
ジ)
MySQL を読み込めません。サイボウズにお問い合わせください。
全文検索サーバーをインストールしたサーバーに root ユーザーでログインします。
Worker を再起動します。
コマンドプロンプトで、次のコマンドを実行します。
次のコマンドを実行します。
/etc/init.d/cbss_worker stop
/etc/init.d/cbss_worker start
2.4.5
ガルーンで全文検索機能を有効化する
ガルーンの設定ファイルを編集し、全文検索機能を有効化します。
サーバー分離構成でガルーンを運用している場合は、すべてのサーバーでこの作業を行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
設定ファイル「common.ini」を編集します。
common.ini のファイルパス:
/var/www/cgi-bin/cbgrn/common.ini
変更内容:
enable_fts の値を、0 から 1 に変更します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
47
2 章 インストールする
[FTS]
;; 'enable_fts' sets whether full text search is available.
;; 0: unavailable full text search
;; 1: enable indexing and searchable
;; 2: enable indexing, but invalid full text search
enable_fts = 1
;; There are limitation of searching once for each application.
bulletin_max_category = 10000;
cabinet_max_folder = 10000;
message_max_message = 1000000;
space_max_space = 1000000;
enable_fts の値を変えると、全文検索機能の有効または無効の切り替えができます。
設定できる値と機能は次のとおりです。
3
4
値
0
機能
検索ボックスを非表示にし、インデックスの作成を中止します。
1
2
検索ボックスを表示し、全文検索機能を有効にします。
検索ボックスを非表示にし、インデックスの作成は継続します。
サーバー分離構成でガルーンを運用している場合は、すべてのサーバーで手順 1 から手順 2 を実行します。
ガルーンの Web サーバーとスケジューリングサービスを再起動します。
ガルーンを運用するサーバーで次のコマンドを実行し、Web サーバーを再起動します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
/etc/init.d/httpd restart
/etc/init.d/cyss_cbgrn restart
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl restart httpd.service
/etc/init.d/cyss_cbgrn restart
アプリケーションサーバーが複数ある場合は、すべてのアプリケーションサーバーで Web サーバーを起動しま
す。
5
48
ガルーンにログインし、画面上部のバーに検索ボックスが表示されていることを確認します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
検索ボックスが表示されない場合
検索ボックスが表示されない場合は、次のディレクトリー内のディレクトリーやファイルをすべて削除し、ガルーンの
画面を再読み込みしてください。
/var/www/cgi-bin/cbgrn/smarty/compiled/
「compiled」ディレクトリー自体は削除しないよう注意してください。
2.4.6
インデックスを作成する
検索に必要なインデックスを作成します。
注意
ガルーンのデータ量が多いと、インデックスの作成に時間がかかります。ガルーンのデータが 1TB の場合、イン
デックスの作成に 1 週間程度かかることを弊社で確認しています。
なお、新規に構築したガルーンの場合、インデックスの作成は数分で完了します。
作成中は、ガルーンに高い負荷がかかります。業務時間を避けてインデックスを作成してください。
ガルーンの MySQL を停止している間は、インデックスを作成できません。
バックアップなどの目的で MySQL を停止する場合は、インデックスの作成を停止してください。
ガルーンを運用しているサーバーでウイルス対策ソフトウェアが動作している場合、インデックスを作成する前に、
ウイルススキャンの対象から次のディレクトリーを外す必要があります。
(ガルーンのインストールディレクトリー)/mysql-5.0/files/(インストール識別子)/mail/tmp_solr_index/
例:
/usr/local/cybozu/mysql-5.0/files/cbgrn/mail/tmp_solr_index/
操作手順:
1
ガルーンを運用しているサーバーに root ユーザーでログインします。
サーバー分離構成の場合は、データベースサーバーに Administrator ユーザーでログインします。
2
次のディレクトリーに移動します。
/var/www/cgi-bin/cbgrn/
次のコマンドを実行します。
cd /var/www/cgi-bin/cbgrn/
3
インデックスの作成を開始します。
次のコマンドを実行します。
./grn.cgi -C -q code/command/fts/full_index.csp (パラメーター)
パラメーター
パラメーター
number
必須
○
説明
プロセスが一度に作成するインデックスの件数を指定します。
特別な事情がない限り、50 を指定してください。
例:number=50
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
49
2 章 インストールする
パラメーター
startTime
必須
stopTime
説明
サーバーで、インデックスの作成を開始する時刻を、24 時間表記で指定します。
ガルーンのシステム管理で「ロケールの初期値」に設定されているタイムゾーンの時刻を、0
から 23 の整数で指定します。
例:startTime=20
startTime は、stopTime とセットで指定します。ただし、startTime と stopTime には、
同じ値は指定できません。
サーバーで、インデックスの作成を中止する時刻を、24 時間表記で指定します。
ガルーンのシステム管理で「ロケールの初期値」に設定されているタイムゾーンの時刻を、0
から 23 の整数で指定します。
例:stopTime=8
stopTime は、startTime とセットで指定します。ただし、startTime と stopTime には、
同じ値は指定できません。
コマンドの実行例:
./grn.cgi -C -q code/command/fts/full_index.csp number=50 startTime=20 stopTime=8
補足
ロケールの初期値の詳細は、次のページを参照してください。
『管理者ガイド』の「ローカライズの機能を設定する」
https://help.cybozu.com/ja/g40/admin/system/localization/index.html#localization_index_0
1
インデックスの作成のログは、標準出力にのみ出力されます。必要に応じて、tee コマンドなどを使用し、ログを
ファイルに保存してください。
コマンドの実行例:
./grn.cgi -C -q code/command/fts/full_index.csp number=50 | tee indexing.log
インデックスの作成を中止した場合、コマンドを再実行すると、作成が再開されます。
インデックスの作成が完了したあとにコマンドを再実行すると、ガルーンのすべてのデータを対象に、インデックス
が再作成されます。
インデックスの作成を中止したあとに、ガルーンのすべてのデータを対象にインデックスを再作成するには、レ
ジューム管理ファイルを削除する必要があります。
レジューム管理ファイルについては、次のページを参照してください。
「インデックス作成のレジューム管理ファイルについて」 - 51 ページ
インデックスの作成が完了するまで、インデックスを作成するコマンドを繰り返し実行する場合は、コマンドを実行
する前に、インデックスの作成が未完了であることを確認してください。レジューム管理ファイルが存在すれば、イ
ンデックスの作成は未完了です。
レジューム管理ファイルについては、次のページを参照してください。
「インデックス作成のレジューム管理ファイルについて」 - 51 ページ
各アプリケーションのデータのインデックスは、次の順番で作成されます。
1. 掲示板
2. メッセージ
3. ファイル管理
4. スペース
5. メール
インデックスの作成を停止する
何らかの理由により、インデックスの作成処理を即時停止する場合は、Ctrl キーと C キーを同時に押します。
50
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
インデックス作成のレジューム管理ファイルについて
全文検索サーバーは、インデックス作成の進捗を、次の 2 つのファイル(レジューム管理ファイル)で管理していま
す。
/usr/local/cybozu/mysql-5.0/files/cbgrn/fts/full_index_resume.json
/usr/local/cybozu/mysql-5.0/files/cbgrn/fts/full_index_arguments.json
上記のファイルは、インデックスの作成が完了すると削除されます。
2.4.7
作業後の確認
作業後に確認する内容は、ガルーンを新規に構築した場合と、運用中のガルーンの場合とで異なります。
新規に構築したガルーンの場合
新規に構築したガルーンでは、インデックスの作成は数分で完了します。メールのインデックスの作成が終われば、
インデックスの作成は完了です。メールのインデックスの作成が完了すると、コマンドラインに次のメッセージが表示
されます。
[(出力日時)] Finish indexing of received files, tab_grn_mail_fileinfo___p49.
[(出力日時)] Finish indexing of received files.
[(出力日時)] Finish indexing of mail data.
上記のメッセージが表示されたら、次の点を確認します。
掲示板やメッセージに書き込んだ文字列で検索できるかどうか
ファイル管理に添付した文書ファイル内の文字列で検索できるかどうか
検索仕様については、次のページを参照してください。
「6.3 検索仕様」 - 93 ページ
インデックス作成後のトラブルと対処方法
インデックスの作成後にトラブルが発生した場合の対処方法は、次のとおりです。
トラブル
「GRN_FTS_00002」のエラーメッ
セージが表示される
対処方法
次のコマンドを実行し、全文検索サーバーの Solr を起動します。
/etc/init.d/cbss_solr start
上記のコマンドを実行しても解決しない場合、ガルーンから全文検索サーバーへの
接続が正しく設定されているかどうかを確認してください。
「ガルーンの設定」 - 41 ページ
検索結果が表示されない
次の操作を実施済みであることを確認します。
MySQL での通知の有効化
「2.4.4 MySQL で通知を有効化する」 - 46 ページ
ガルーンから全文検索サーバーへの接続設定
「ガルーンの設定」 - 41 ページ
全文検索サーバーからガルーンへの接続設定
「全文検索サーバーの設定」 - 39 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
51
2 章 インストールする
運用中のガルーンの場合
運用中のガルーンでは、インデックスの作成に時間がかかります。インデックスの作成が完了したら、正常に検索で
きることを確認します。
インデックスの作成が進んでいることを確認する
次の操作で、インデックスが作成中であることを確認できます。
操作手順:
1
2
ガルーンのシステム管理画面で、[基本システムの管理] > [キューの監視] > [全文検索サーバー]の順
にクリックします。
インデックスの作成が進んでいることを確認します。
次の 2 点を確認します。
•
「キューの残数」が変化すること
•
画面を再読み込みすると、表示されるジョブが変わること
画面例:
「message」は表示されない場合があります。
画面の見かたの詳細は、次のページを参照してください。
「5.4 キューの状況を確認する」 - 85 ページ
確認中のトラブルと対処方法
インデックスの作成を確認中にトラブルが発生した場合の対処方法は、次のとおりです。
52
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
2.4 Linux 環境にインストールする
トラブル
キューの監視画面を開けない
対処方法
次の操作を実施済みであることを確認します。
ガルーンでの全文検索機能の有効化
「2.4.5 ガルーンで全文検索機能を有効化する」 - 47 ページ
画面を再読み込みしても、表示され
るジョブが変わらない
次の操作を実施済みであることを確認します。
MySQL での通知の有効化
「2.4.4 MySQL で通知を有効化する」 - 46 ページ
ガルーンから全文検索サーバーへの接続設定
「ガルーンの設定」 - 41 ページ
全文検索サーバーからガルーンへの接続設定
「全文検索サーバーの設定」 - 39 ページ
検索できることを確認する
メールのインデックスの作成が終われば、インデックスの作成は完了です。メールのインデックスの作成が完了する
と、コマンドラインに次のメッセージが表示されます。
[(出力日時)] Finish indexing of received files, tab_grn_mail_fileinfo___p49.
[(出力日時)] Finish indexing of received files.
[(出力日時)] Finish indexing of mail data.
上記のメッセージが表示されたら、次の点を確認します。
掲示板やメッセージに書き込んだ文字列で検索できるかどうか
ファイル管理に添付した文書ファイル内の文字列で検索できるかどうか
検索仕様については、次のページを参照してください。
「6.3 検索仕様」 - 93 ページ
インデックス作成後のトラブルと対処方法
インデックスの作成後にトラブルが発生した場合の対処方法は、次のとおりです。
トラブル
「GRN_FTS_00002」のエラーメッ
セージが表示される
対処方法
次のコマンドを実行し、全文検索サーバーの Solr を起動します。
/etc/init.d/cbss_solr start
上記のコマンドを実行しても解決しない場合、ガルーンから全文検索サーバーへの
接続が正しく設定されているかどうかを確認してください。
「ガルーンの設定」 - 41 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
53
3 章 アンインストールする
アンインストールする
3章
全文検索サーバーをアンインストールする方法と、アンインストール後に必要な設定を説明します。
3.1
Windows 環境からアンインストールする
Windows 環境で運用していた全文検索サーバーをアンインストールする手順を説明します。
3.1.1
全文検索サーバーをインストールしたサーバーで行う作業
必要に応じて fts.json をバックアップし、サーバーから全文検索サーバーをアンインストールします。
fts.json をバックアップする
fts.json をサイボウズ製品が使用しないディレクトリーにコピーします。
この操作は、ガルーンを運用しているサーバーに全文検索サーバーをインストールしている場合にのみ、必要です
例:
コピーするファイル
C:¥Program Files¥Cybozu¥cbfts¥conf¥cb¥fts.json
コピー先のディレクトリー
C:¥tmp
fts.json は、全文検索サーバーとガルーンの両方で使用しています。全文検索サーバーをアンインストールすると
fts.json が削除されます。アンインストールしたあと、ほかのサーバーに全文検索サーバーをインストールしても、ガ
ルーンでは全文検索を使用できません。
全文検索サーバーをアンインストールする前にコピーした fts.json を、ガルーンをインストールしているサーバーに
戻すと、再び全文検索を使えるようになります。
全文検索サーバーをアンインストールする
サーバーから全文検索サーバーをアンインストールします。
操作手順:
1
2
3
4
全文検索サーバーを運用しているサーバーに Administrator ユーザーでログインします。
Windows のコントロールパネルで、[プログラムのアンインストール]をクリックします。
「サイボウズ (R) 全文検索サーバー」を選択し、[アンインストールと変更]をクリックします。
画面の指示に従って、全文検索サーバーをアンインストールします。
注意
全文検索サーバーをアンインストールしたあと、必要に応じてファイアウォールの設定を変更してください。セキュ
リティを考慮し、どのシステムも使用しないポートがあれば閉じることを推奨します。
54
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
3.1 Windows 環境からアンインストールする
3.1.2
ガルーンを運用しているサーバーで行う作業
この項目で説明する作業は、全文検索サーバーをアンインストールしたあともガルーンの運用を継続する場合に必
要です。
MySQL の通知を無効化する
MySQL が全文検索サーバーに送信する通知を無効化します。
ガルーンをサーバー分離構成で運用している場合は、データベースサーバーでこの作業を行います。
操作手順:
1
2
ガルーンを運用しているサーバーに Administrator ユーザーでログインします。
次のディレクトリーに移動します。
C:¥inetpub¥scripts¥cbgrn
3
次のコマンドを実行します。
.¥grn.exe -C -q code¥command¥fts¥disable_udf_notifier.csp db_admin_password=(データベース管
理ユーザーのパスワード)
「UDF notifier is out of service.」と表示されることを確認します。
エラーメッセージが表示された場合の対処方法は、次のとおりです。
エラーメッセージ
Error: DB00000
A database error has occurred.
Database error number: DB00000
Cause:
DB サーバーへの接続に失敗しました
Error: DB99999
A database error has occurred.
Database error number: (エラーコード)
Cause:
Response from database: (エラーメッセー
ジ)
対処方法
MySQL が起動していない場合は、起動します。
MySQL がすでに起動している場合は、データベース管理ユーザー
のパスワードが間違っている可能性があります。正しいパスワードを
指定してください。
MySQL を読み込めません。サイボウズにお問い合わせください。
ガルーンの全文検索機能を無効化する
ガルーンの設定ファイルを編集し、全文検索機能を無効化します。
複数のサーバーでガルーンを運用している場合、この作業はすべてのサーバーで行います。
操作手順:
1
2
ガルーンを運用しているサーバーに Administrator ユーザーでログインします。
設定ファイル「common.ini」を編集します。
common.ini のファイルパス:
C:¥inetpub¥scripts¥cbgrn¥common.ini
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
55
3 章 アンインストールする
変更内容:
「enable_fts」プロパティの値を「1」から「0」に変更します。
;; 'enable_fts' sets whether full text search is available.
;; 0: unavailable full text search
;; 1: enable indexing and searchable
;; 2: enable indexing, but invalid full text search
enable_fts = 0
3
4
複数のサーバーでガルーンを運用している場合は、すべてのサーバーで手順 1 と手順 2 を実行します。
ガルーンの Web サーバーを再起動します。
アプリケーションサーバーが複数ある場合は、すべてのアプリケーションサーバーで Web サーバーを再起動し
ます。
5
ガルーンにログインし、画面上部のバーから検索ボックスが消えていることを確認します。
検索ボックスが表示されたままの場合
検索ボックスがヘッダーに表示されたままになっている場合は、次のディレクトリー内のディレクトリーやファイル
をすべて削除し、ガルーンの画面を再読み込みしてください。
C:¥inetpub¥scripts¥cbgrn¥smarty¥compiled
「compiled」ディレクトリー自体は削除しないよう注意してください。
これで、全文検索サーバーのアンインストールは終了です。
注意
全文検索サーバーをアンインストールしたあと、必要に応じてファイアウォールの設定を変更してください。セキュ
リティを考慮し、どのシステムも使用しないポートがあれば閉じることを推奨します。
3.2
Linux 環境からアンインストールする
Linux 環境で全文検索サーバーをアンインストールする手順を説明します。
56
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
3.2 Linux 環境からアンインストールする
3.2.1
全文検索サーバーをインストールしたサーバーで行う作業
必要に応じて fts.json をバックアップし、サーバーから全文検索サーバーをアンインストールします。
fts.json をバックアップする
ガルーンをインストールしているサーバーから全文検索サーバーをアンインストールする場合は、作業の前に、
fts.json をサイボウズ製品が使用しないディレクトリーにコピーします。
例:
コピーするファイル
/usr/local/cybozu/cbfts/conf/cb/fts.json
コピー先のディレクトリー
/tmp
fts.json は、全文検索サーバーとガルーンの両方で使用しています。全文検索サーバーをアンインストールすると
fts.json が削除されます。アンインストールしたあと、ほかのサーバーに全文検索サーバーをインストールしても、ガ
ルーンでは全文検索を使えません。
全文検索サーバーをアンインストールする前にコピーした fts.json を、ガルーンをインストールしているサーバーに
戻すと、再び全文検索を使えるようになります。
補足
fts.json をコピーしても全文検索サーバーが試用できない場合は、コピー先のディレクトリーとコピーしたファイル
に、次のアクセス権を設定します。
ディレクトリーの例:/usr/local/cybozu/cbfts/conf/cb
所有者:Apache
所有グループ:root
パーミッション:755
全文検索サーバーをアンインストールする
サーバーから全文検索サーバーをアンインストールします。
操作手順:
1
2
全文検索サーバーを運用しているサーバーに root ユーザーでログインします。
全文検索サーバーをアンインストールします。
次のコマンドを実行します。
sh /usr/local/cybozu/cbfts/uninstall
画面の説明に従って全文検索サーバーをアンインストールします。
3
ガルーンの添付ファイル保存ディレクトリーへのマウントを解除します。
次のコマンドを実行します。
umount [ガルーンの添付ファイル保存ディレクトリーのパス]
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
57
3 章 アンインストールする
コマンドの例:
umount /usr/local/cybozu/mysql-5.0/files
4
自動マウントを解除します。
設定ファイル「fstab」を編集し、自動マウントを解除します。
fstab のファイルパス:
/etc/fstab
変更内容:
次の記述を削除します。
[ガルーンの添付ファイルを保存したサーバーの IP アドレスまたはホスト名]:[「files」ディレクトリーのパス] [「files」
ディレクトリーのパス] nfs4 defaults 0 0
注意
全文検索サーバーをアンインストールしたあと、必要に応じてファイアウォールの設定を変更してください。セキュ
リティを考慮し、どのシステムも使用しないポートがあれば閉じることを推奨します。
3.2.2
ガルーンを運用しているサーバーで行う作業
この項目で説明する作業は、全文検索サーバーをアンインストールしたあともガルーンの運用を継続する場合に必
要です。
MySQL の通知を無効化する
MySQL が全文検索サーバーに送信する通知を無効化します。
サーバー分離構成でガルーンを運用している場合は、データベースサーバーでこの作業を行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
次のディレクトリーに移動します。
/var/www/cgi-bin/cbgrn/
コマンドの例:
cd /var/www/cgi-bin/cbgrn/
3
次のコマンドを実行します。
./grn.cgi -C -q code/command/fts/disable_udf_notifier.csp db_admin_password=(データベース管理
ユーザーのパスワード)
「UDF notifier is out of service.」と表示されることを確認します。
エラーメッセージが表示された場合の対処方法は、次のとおりです。
58
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
3.2 Linux 環境からアンインストールする
エラーメッセージ
Error: DB00000
A database error has occurred.
Database error number: DB00000
Cause:
DB サーバーへの接続に失敗しました
Error: DB99999
A database error has occurred.
Database error number: (エラーコード)
Cause:
Response from database: (エラーメッセージ)
対処方法
MySQL が起動していない場合は、起動します。
MySQL がすでに起動している場合は、データベース管理ユー
ザーのパスワードが間違っている可能性があります。正しいパス
ワードを指定してください。
MySQL を読み込めません。サイボウズにお問い合わせくださ
い。
ガルーンの全文検索機能を無効化する
ガルーンの設定ファイルを編集し、全文検索機能を無効化します。
ガルーンをサーバー分離構成で運用している場合は、すべてのサーバーでこの作業を行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
設定ファイル「common.ini」を編集します。
common.ini のファイルパス:
/var/www/cgi-bin/cbgrn/common.ini
変更内容:
「enable_fts」プロパティの値を「1」から「0」に変更します。
;; 'enable_fts' sets whether full text search is available.
;; 0: unavailable full text search
;; 1: enable indexing and searchable
;; 2: enable indexing, but invalid full text search
enable_fts = 0
3
4
ガルーンをサーバー分離構成で運用している場合は、すべてのサーバーで手順 1 と手順 2 を実行します。
ガルーンの Web サーバーを再起動します。
ガルーンを運用するサーバーで次のコマンドを実行し、Web サーバーを再起動します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
/etc/init.d/httpd restart
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl restart httpd.service
アプリケーションサーバーが複数ある場合は、すべてのアプリケーションサーバーで Web サーバーを再起動し
ます。
5
ガルーンにログインし、画面上部のバーから検索ボックスが消えていることを確認します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
59
3 章 アンインストールする
検索ボックスが消えない場合
検索ボックスが消えない場合は、次のディレクトリー内のディレクトリーやファイルをすべて削除し、ガルーンの
画面を再読み込みしてください。
/var/www/cgi-bin/cbgrn/smarty/compiled/
「compiled」ディレクトリー自体は削除しないよう注意してください。
マウントの設定を解除する
NFS サービスの設定ファイル「exports」を編集し、全文検索サーバーからの NFS マウントの許可を解除します。
複数のサーバーでガルーンを運用している場合、この作業は添付ファイルを保存しているサーバーで行います。
操作手順:
1
NFS サービスの設定ファイル「exports」を編集します。
ガルーンの添付ファイルを保存しているサーバーで、「exports」を編集します。
exports のファイルパス:
/etc/exports
変更内容:
次の記述を削除します。
[「files」ディレクトリーのパス] [全文検索サーバーの IP アドレスまたはホスト名](rw)
これで、全文検索サーバーのアンインストールは終了です。
注意
全文検索サーバーをアンインストールしたあと、必要に応じてファイアウォールの設定を変更してください。セキュ
リティを考慮し、どのシステムも使用しないポートがあれば閉じることを推奨します。
60
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
DB 分割構成のガルーンで運用する
4章
DB 分割構成のガルーンを運用している環境に全文検索サーバーをインストールする方法と、インストール後に必要
な設定を説明します。
インストールの作業を開始する前に、必要な準備を行ってください。
「2.2 インストール前の準備」 - 13 ページ
ここでは、各ディレクトリーのパスとインストール識別子について、次の設定を想定して説明します。
各ディレクトリーのパスとインストール識別子
種類
ガルーンと全文検索サーバーのインストールディレクトリー
ガルーンのインストール識別子
パス/識別子
/usr/local/cybozu/
cbgrn
パスやインストール識別子の設定が上記と異なる場合は、環境に合わせて読み替えてください。
補足
DB 分割構成の詳細は、サイボウズ オフィシャルパートナー、または販売元にお問い合わせください。
https://www.cybozu.com/jp/partner/list/sales/
4.1
全文検索サーバーをインストールする
全文検索サーバーを運用するサーバーに、全文検索サーバーをインストールします。
注意
全文検索サーバーをインストールするサーバーには、Apache(Web サーバー)の実行ユーザー「apache」が存
在する必要があります。サーバーに Apache がインストールされていない場合は、全文検索サーバーをインス
トールする前に Apache をインストールしてください。ただし、Web サーバーを起動する必要はありません。
操作手順:
1
2
3
全文検索サーバーを運用するサーバーに、root ユーザーでログインします。
任意のディレクトリーに、全文検索サーバーのインストーラー「cbfts64-2.0.1.bin」を配置します。
インストーラーを実行します。
インストーラーを配置したディレクトリーで、次のコマンドを実行します。
sh cbfts64-2.0.1.bin
4
画面の指示に従って、全文検索サーバーをインストールします。
インストール中、次の情報を指定します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
61
4 章 DB 分割構成のガルーンで運用する
インストール中に指定する情報
入力する情報
説明
全文検索サーバーをインストールする
ディレクトリー
全文検索サーバーのインストール先を指定します。
指定したディレクトリーの配下に検索用のインデックスが保存されます。パー
ティションの空き容量に注意してください。
必要な空き容量については、次のページを参照してください。
「1.3 動作環境」 - 8 ページ
ガルーンのインストール識別子を指定します。
既定の設定でガルーンをインストールした場合、識別子は「cbgrn」です。
ガルーンの MySQL のポート番号を指定します。
既定の設定でガルーンをインストールした場合、ポート番号は 3770 です。
ガルーンの「データベース接続ユーザー」のパスワードを指定します。
アプリケーション識別子
アプリケーションの DB ポート番号
アプリケーションの DB 接続パスワード
アプリケーションの実行ユーザー
ガルーンのサーバーで動作している Web サーバーの実行ユーザーを指定
します。通常の設定では、実行ユーザーは「apache」です。
補足
全文検索サーバーを運用するサーバーでウイルス対策ソフトウェアが動作している場合、検索用のインデックスが
作成されるディレクトリーをウイルススキャンの対象から外す必要があります。
次のディレクトリーをウイルススキャンの対象から外します。
(全文検索サーバーのインストールディレクトリー)/cbfts/
例:/usr/local/cybozu/cbfts/
4.1.1
ガルーンと全文検索サーバーの接続を設定する
ガルーンと全文検索サーバーとの通信に必要な設定を行います。
全文検索サーバーの設定
全文検索サーバーをインストールしたサーバーで、ガルーンへの接続の設定と、ガルーンからの接続を許可する設
定を行います。
ガルーンへの接続を設定する
全文検索サーバーの設定ファイルを編集し、ガルーンへの接続を設定します。
操作手順:
1
全文検索サーバーの設定ファイル「cbgrn.json」と「slash.json」を編集します。
cbgrn.json と slash.json のファイルパス:
62
•
cbgrn.json: /usr/local/cybozu/cbfts/conf/cb/cbgrn.json
•
slash.json: /usr/local/cybozu/cbfts/conf/cb/slash.json
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
変更内容:
{
"map": {
"0": [
{
"username": "cb_cbgrn",
"host": "garoon-server",
"password": "cybozu",
"port": 3770
}
]
},
"algorithm": "range-int"
a)
b)
}
a):キューを管理するデータベースサーバーの IP アドレス、またはホスト名を指定します。
キューを管理するサーバーについては、次のページを参照してください。
「ガルーンが DB 分割構成の場合」 - 15 ページ
b):ガルーンのデータベース接続ユーザーのパスワードを指定します。
ガルーンからの接続を許可する
初期設定では、全文検索サーバーにはほかのサーバーから接続できません。ガルーンのサーバーから接続できる
ように設定を変更する必要があります。
この設定を行うと、ガルーン以外のサーバーからも全文検索サーバーに接続できるようになります。セキュリティの保
護のため、全文検索サーバーをインストールしたサーバーにファイアウォールを設定し、ガルーンのサーバーからの
接続だけを許可してください。
ガルーンと全文検索サーバーとの間で行われる通信については、次のページを参照してください。
「ガルーンと全文検索サーバーとの間の通信」 - 14 ページ
注意
セキュリティのため、ファイアウォールは必ず設定してください。全文検索サーバーには、ガルーンのデータの一部
が保存されます。
操作手順:
1
全文検索サーバーの設定ファイル「configure」を編集します。
configure のファイルパス:
/usr/local/cybozu/cbfts/bin/configure
変更内容:
workerHost=0.0.0.0
solrHost=0.0.0.0
workerPort=8686
solrPort=8983
a)
a):「127.0.0.1」を「0.0.0.0」に変更します。
2
Worker と Solr を再起動します。
次のコマンドを実行します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
63
4 章 DB 分割構成のガルーンで運用する
/etc/init.d/cbss_worker stop
/etc/init.d/cbss_solr stop
/etc/init.d/cbss_solr start
/etc/init.d/cbss_worker start
ファイアウォールの設定
iptables を使用する場合を例に、ファイアウォールの設定方法を説明します。
操作手順:
1
iptables の設定ファイル「iptables」を編集します。
ガルーンを運用しているデータベースサーバーごとに、iptables を編集します。
iptables のファイルパス:
/etc/sysconfig/iptables
変更内容:
•
キューを管理するサーバーからのアクセスを許可する:
iptables に、キューを管理するサーバーが全文検索サーバーの 8686 ポートに TCP と UDP でアクセスで
きるようにするための設定を追記します。
キューを管理するサーバーの IP アドレスが「192.168.1.10」の場合の設定例です。
-I RH-Firewall-1-INPUT -p tcp -s 192.168.1.10 --dport 8686 -j ACCEPT
-I RH-Firewall-1-INPUT -p udp -s 192.168.1.10 --dport 8686 -j ACCEPT
キューを管理するサーバーについては、次のページを参照してください。
「ガルーンが DB 分割構成の場合」 - 15 ページ
•
アプリケーションサーバーからのアクセスを許可する:
iptables に、アプリケーションサーバーが全文検索サーバーの 8983 ポートに TCP でアクセスできるように
するための設定を追記します。
アプリケーションサーバーの IP アドレスが「192.168.1.20」の場合の設定例です。
-I RH-Firewall-1-INPUT -p tcp -s 192.168.1.20 --dport 8983 -j ACCEPT
2
iptables を再起動します。
次のコマンドを実行します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
/etc/init.d/iptables restart
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl restart iptables
設定の変更が iptables に反映されます。
3
ガルーンを運用しているサーバーからのみ、全文検索サーバーをインストールしたサーバーに接続できること
を確認します。
ガルーンを運用している各サーバーと、それ以外のサーバーで、次の 2 つのコマンドを実行します。
64
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
全文検索サーバーをインストールしたサーバーの IP アドレスが「192.168.2.10」の場合:
•
マスターデータベースサーバーで実行するコマンド:
wget --spider http://192.168.2.10:8686/version
•
アプリケーションサーバーで実行するコマンド:
wget --spider http://192.168.2.10:8983/version
ガルーンを運用しているサーバーで実行した場合にだけ「200 OK」が表示されることを確認します。
ガルーンの設定
ガルーンを運用しているサーバーで、全文検索サーバーとの接続に必要な設定を行います。
設定ファイル「fts.json」を編集する
fts.json に、全文検索サーバーの情報を記述します。
ガルーンを運用しているすべてのサーバーで設定を行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
設定ファイル「fts.json」を編集します。
fts.json のファイルパス:
/usr/local/cybozu/cbfts/conf/cb/fts.json
変更内容:
{
"map": {
"0": [
{
"username": null,
"host": "search-server",
"password": null,
"port": 8983
}
]
},
"algorithm": "range-int"
a)
}
a):全文検索サーバーの IP アドレス、またはホスト名を指定します。
3
ガルーンを運用しているすべてのサーバーに対して、手順 1 から手順 2 を実行します。
ファイアウォールの設定
全文検索サーバーからガルーンに接続できるように、ガルーンを運用しているサーバーの iptables に、全文検索
サーバーを運用しているサーバーの IP アドレス、および通信に使用するプロトコルとポート番号を設定します。
設定するプロトコルとポート番号は、次のとおりです。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
65
4 章 DB 分割構成のガルーンで運用する
MySQL
項目
プロトコル
TCP
3770
ポート番号
添付ファイル保存ディレクトリー
TCP
2049
iptables の設定方法は、次のページを参照してください。
「ファイアウォールの設定」 - 64 ページ
4.1.2
添付ファイル保存領域をマウントする
全文検索サーバーをインストールしたサーバーから、ガルーンの添付ファイル保存ディレクトリーを NFS マウントしま
す。全文検索サーバーが添付ファイルの検索に必要なインデックスを作成するために必要な設定です。
この設定は、ガルーンの添付ファイルを保存しているサーバーと、全文検索サーバーをインストールしたサーバー
の、両方で行います。
この項では、マウントに NFSv4 を使用することを前提に、設定手順を説明します。
ガルーンの添付ファイルを保存しているサーバーで行う設定
操作手順:
1
2
ガルーンの添付ファイルを保存しているサーバーに root ユーザーでログインします。
設定ファイル「exports」を編集します。
exports のファイルパス:
/etc/exports
変更内容:
次の行を追加します。
[「files」ディレクトリーのパス] [全文検索サーバーの IP アドレスまたはホスト名](rw)
入力例:
/usr/local/cybozu/files search-server(rw)
3
NFS マウントに必要なサービスが起動していることを確認し、手順 2 で編集した内容を反映します。
確認するサービスとコマンド:
rpcbind
-
確認に必要なコマンド
Red Hat Enterprise
Linux Server 6
/etc/init.d/rpcbind status
portmapper
nfs
/etc/init.d/portmap status
/etc/init.d/nfs status
-
/etc/init.d/nfs status
-
systemctl status nfs
nfslock
/etc/init.d/nfslock status
/etc/init.d/nfslock status
systemctl status nfslock
Red Hat Enterprise
Linux Server 5
サービス
Red Hat Enterprise
Linux Server 7
systemctl status rpcbind
-:該当なし
66
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
NFS マウントに必要なサービスが停止している場合は、次のコマンドで起動します。
起動に必要なコマンド
Red Hat Enterprise
Linux Server 5
rpcbind
-
Red Hat Enterprise
Linux Server 6
/etc/init.d/rpcbind start
portmapper
nfs
/etc/init.d/portmap start
/etc/init.d/nfs start
-
/etc/init.d/nfs start
-
systemctl start nfs
nfslock
/etc/init.d/nfslock start
/etc/init.d/nfslock start
systemctl start nfslock
サービス
Red Hat Enterprise
Linux Server 7
systemctl start rpcbind
-:該当なし
exports の内容を反映するコマンド:
exportfs -r
4
手順 3 で確認したサービスの自動起動の設定を行います。
OS の起動時に、NFS マウントに必要なサービスが自動起動されるように設定します。
OS が Red Hat Enterprise Linux Server 6 または 7 の場合は rpcbind の、Red Hat Enterprise
Linux Server 5 の場合は portmapper の自動起動を設定します。
各サービスの自動起動の設定に必要なコマンド
rpcbind
設定に必要なコマンド
Red Hat Enterprise Linux Server r 6
Red Hat Enterprise Linux Server 7
以前
chkconfig rpcbind on
systemctl enable rpcbind
portmapper
nfs
chkconfig portmap on
chkconfig nfs on
systemctl enable portmap
systemctl enable nfs
nfslock
chkconfig nfslock on
systemctl enable nfslock
サービス
全文検索サーバーをインストールしたサーバーで行う設定
操作手順:
1
2
全文検索サーバーをインストールしたサーバーに root ユーザーでログインします。
NFS マウントに必要なサービスを起動します。
起動するサービス:
•
rpcbind(OS が Red Hat Enterprise Linux Server 6 または 7 の場合)
•
portmapper(OS が Red Hat Enterprise Linux Server 5 の場合)
•
nfslock
各サービスの起動に必要なコマンド
サービス
Red Hat Enterprise
Linux Server 5
起動に必要なコマンド
Red Hat Enterprise
Linux Server 6
rpcbind
portmapper
-
/etc/init.d/portmap start
/etc/init.d/rpcbind start
-
systemctl start rpcbind
-
nfslock
/etc/init.d/nfslock start
/etc/init.d/nfslock start
systemctl start nfslock
Red Hat Enterprise
Linux Server 7
-:該当なし
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
67
4 章 DB 分割構成のガルーンで運用する
3
手順 2 で起動したサービスの自動起動の設定を行います。
OS の起動時に、NFS マウントに必要なサービスが自動起動されるように設定します。
OS が Red Hat Enterprise Linux Server 6 または 7 の場合は rpcbind の、Red Hat Enterprise
Linux Server 5 の場合は portmapper の自動起動を設定します。
各サービスの自動起動の設定に必要なコマンド
起動に必要なコマンド
サービス
Red Hat Enterprise
Linux Server 5
Red Hat Enterprise
Linux Server 6
Red Hat Enterprise
Linux Server 7
rpcbind
portmapper
-
/etc/init.d/portmap start
/etc/init.d/rpcbind start
-
systemctl start rpcbind
-
nfslock
/etc/init.d/nfslock start
/etc/init.d/nfslock start
systemctl start nfslock
-:該当なし
4
ガルーンの添付ファイル保存ディレクトリーとパスが同じディレクトリーを作成します。
次のコマンドを実行します。
mkdir -p [ガルーンの添付ファイル保存ディレクトリーのパス]
コマンドの例:
mkdir -p /usr/local/cybozu/files
5
手順 4 で作成したディレクトリーに、次のパーミッションを設定します。
•
所有者:apache
•
所有グループ:root
•
パーミッション:000
コマンドの例:
chown -R apache:root /usr/local/cybozu/files
chmod -R 000 /usr/local/cybozu/files
6
ガルーンの添付ファイル保存ディレクトリーを NFS マウントします。
次のコマンドを実行します。
mount -o intr [ガルーンの添付ファイルを保存しているサーバーの IP アドレスまたはホスト名]:[ガルーンの添付
ファイル保存ディレクトリーのパス] [手順 4 で作成したディレクトリーのパス]
コマンドの例:
mount -o intr garoon-server:/usr/local/cybozu/files /usr/local/cybozu/files
マウントに失敗する場合
マウントに失敗する場合、ガルーンの添付ファイルを保存しているサーバーで次のコマンドを実行してから、再
度 NFS マウントしてください。
exportfs -r
上記のコマンドを実行しても NFS マウントに失敗する場合、NFS マウントに必要なポートが閉じている可能性
があります。ガルーンの添付ファイルを保存しているサーバーで、2049 ポートを開放してください。
68
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
7
自動マウントを設定します。
OS の起動時に、自動的に NFS マウントされるように設定します。
次の操作を行います。
•
「netfs」サービスの自動起動を設定する
•
設定ファイル「fstab」を編集する
netfs の自動起動の設定
次のコマンドを実行します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
chkconfig netfs on
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl enable netfs
設定ファイル「fstab」の編集
fstab のファイルパスは、次のとおりです。
/etc/fstab
fstab に、1 行で次の内容を追記します。
[ガルーンの添付ファイルを保存したサーバーの IP アドレスまたはホスト名]:[ガルーンの添付ファイル保存ディレクト
リーのパス] [手順 4 で作成したディレクトリーのパス] nfs4 defaults 0 0
入力例:
garoon-server:/usr/local/cybozu/files /usr/local/cybozu/files nfs4 defaults 0 0
注意
HA クラスターソフトウェアを使用してガルーンを運用するサーバーを冗長化している場合、NFS マウントのフェイ
ルオーバーを設定してください。ガルーンの稼動系サーバーの障害時には、全文検索サーバーをインストールし
たサーバーからの NFS マウント先を、待機系サーバーに切り替える必要があります。
4.1.3
MySQL で通知を有効化する
ガルーンの MySQL で、通知を有効化します。通知を有効化すると、MySQL は、キューへのジョブの追加を全文検
索サーバーに通知するようになります。
MySQL に Worker の情報を登録する
MySQL の設定ファイルを編集し、Worker の IP アドレスとポート番号を登録します。
この作業は、すべてのデータベースサーバーで行います。
操作手順:
1
2
ガルーンのデータベースサーバーに root ユーザーでログインします。
MySQL の Worker の設定ファイル「worker.ini」を編集します。
worker.ini のファイルパス:
/usr/local/cybozu/mysql-5.0/etc/worker.ini
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
69
4 章 DB 分割構成のガルーンで運用する
変更内容:
WORKER_HOST の値を、全文検索サーバーの IP アドレスに変更します。
WORKER_HOST=(全文検索サーバーの IP アドレスまたはホスト名)
全文検索サーバーをインストールしたサーバーの IP アドレスが「192.168.2.10」の場合の例です。
変更前:
WORKER_HOST=127.0.0.1
WORKER_PORT=8686
変更後:
WORKER_HOST=192.168.2.10
WORKER_PORT=8686
3
MySQL を再起動します。
コマンドプロンプトで、次のコマンドを実行します。
/etc/init.d/cyde_5_0 restart
4
すべてのデータベースサーバーで、手順 1 から手順 3 を実行します。
通知を有効化するためのコマンドを実行する
MySQL で通知を有効化するためのコマンドを実行します。
操作手順:
1
キューを管理するデータベースサーバーで、次のディレクトリーに移動します。
/usr/local/cybozu/cbgrn/
コマンドの例:
cd /usr/local/cybozu/cbgrn/
2
次のコマンドを実行します。
./grn.cgi -C -q code/command/fts/enable_udf_notifier.csp db_admin_password=(データベース管理
ユーザーのパスワード)
「UDF notifier is available.」と表示されることを確認します。
エラーメッセージが表示された場合の対処方法は、次のとおりです。
エラーメッセージ
Error: DB00000
A database error has occurred.
Database error number: DB00000
Cause:
DB サーバーへの接続に失敗しました
70
対処方法
MySQL が起動していない場合は、起動します。
MySQL がすでに起動している場合は、データベース管理ユー
ザーのパスワードが間違っている可能性があります。正しいパス
ワードを指定してください。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
エラーメッセージ
Error: DB99999
A database error has occurred.
Database error number: (エラーコード)
Cause:
Response from database: (エラーメッセー
ジ)
3
4
対処方法
MySQL を読み込めません。サイボウズにお問い合わせください。
全文検索サーバーをインストールしたサーバーに root ユーザーでログインします。
Worker を再起動します。
次のコマンドを実行します。
/etc/init.d/cbss_worker stop
/etc/init.d/cbss_worker start
4.1.4
ガルーンで全文検索機能を有効化する
ガルーンの設定ファイルを編集し、全文検索機能を有効化します。
ガルーンを運用しているすべてのサーバーで、この作業を行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
設定ファイル「common.ini」を編集します。
common.ini のファイルパス:
/usr/local/cybozu/cbgrn/common.ini
変更内容:
enable_fts の値を、0 から 1 に変更します。
[FTS]
enable_fts = 1
bulletin_max_category = 10000;
cabinet_max_folder = 10000;
message_max_message = 1000000;
space_max_space = 1000000;
enable_fts の値を変えると、全文検索機能の有効または無効の切り替えができます。
設定できる値と機能は次のとおりです。
3
4
値
0
機能
検索ボックスを非表示にし、インデックスの作成を中止します。
1
2
検索ボックスを表示し、全文検索機能を有効にします。
検索ボックスを非表示にし、インデックスの作成は継続します。
ガルーンを運用しているすべてのサーバーで、手順 1 から手順 2 を実行します。
ガルーンの Web サーバーとスケジューリングサービスを再起動します。
ガルーンを運用するサーバーでコマンドを実行し、Web サーバーとスケジューリングサービスを再起動します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
71
4 章 DB 分割構成のガルーンで運用する
Web サーバーは、アプリケーションサーバーで起動します。
スケジューリングサービスは、マスターデータベースサーバーで起動します。
次のコマンドを実行します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
/etc/init.d/httpd restart
/etc/init.d/cyss_cbgrn restart
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl restart httpd.service
/etc/init.d/cyss_cbgrn restart
アプリケーションサーバーが複数ある場合は、すべてのアプリケーションサーバーで Web サーバーを起動しま
す。
5
ガルーンにログインし、画面上部のバーに検索ボックスが表示されていることを確認します。
検索ボックスが表示されない場合
検索ボックスが表示されない場合は、次のディレクトリー内のディレクトリーやファイルをすべて削除し、ガルーンの
画面を再読み込みしてください。
/usr/local/cybozu/cbgrn/smarty/compiled/
「compiled」ディレクトリー自体は削除しないよう注意してください。
4.1.5
インデックスを作成する
検索に必要なインデックスを作成します。
注意
ガルーンのデータ量が多いと、インデックスの作成に時間がかかります。ガルーンのデータが 1TB の場合、イン
デックスの作成に 1 週間程度かかることを弊社で確認しています。
なお、新規に構築したガルーンの場合、インデックスの作成は数分で完了します。
作成中は、ガルーンに高い負荷がかかります。業務時間を避けてインデックスを作成してください。
ガルーンの MySQL を停止している間は、インデックスを作成できません。
バックアップなどの目的で MySQL を停止する場合は、インデックスの作成を停止してください。
72
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
ガルーンを運用しているサーバーでウイルス対策ソフトウェアが動作している場合、インデックスを作成する前に、
ウイルススキャンの対象から次のディレクトリーを外す必要があります。
(ガルーンのインストールディレクトリー)/mysql-5.0/files/(インストール識別子)/mail/tmp_solr_index/
例:
/usr/local/cybozu/files/cbgrn/mail/tmp_solr_index/
操作手順:
1
2
ガルーンのキューを管理するデータベースサーバーに、root ユーザーでログインします。
次のディレクトリーに移動します。
/usr/local/cybozu/cbgrn/
次のコマンドを実行します。
3
cd /usr/local/cybozu/cbgrn/
インデックスの作成を開始します。
次のコマンドを実行します。
./grn.cgi -C -q code/command/fts/full_index.csp (パラメーター)
パラメーター
パラメーター
必須
number
○
startTime
stopTime
説明
プロセスが一度に作成するインデックスの件数を指定します。
特別な事情がない限り、50 を指定してください。
例:number=50
サーバーで、インデックスの作成を開始する時刻を、24 時間表記で指定します。
ガルーンのシステム管理で「ロケールの初期値」に設定されているタイムゾーンの時刻を、0
から 23 の整数で指定します。
例:startTime=20
startTime は、stopTime とセットで指定します。ただし、startTime と stopTime には、
同じ値は指定できません。
サーバーで、インデックスの作成を中止する時刻を、24 時間表記で指定します。
ガルーンのシステム管理で「ロケールの初期値」に設定されているタイムゾーンの時刻を、0
から 23 の整数で指定します。
例:stopTime=8
stopTime は、startTime とセットで指定します。ただし、startTime と stopTime には、
同じ値は指定できません。
コマンドの実行例:
./grn.cgi -C -q code/command/fts/full_index.csp number=50 startTime=20 stopTime=8
補足
ロケールの初期値の詳細は、次のページを参照してください。
『管理者ガイド』の「ローカライズの機能を設定する」
https://help.cybozu.com/ja/g40/admin/system/localization/index.html#localization_index_0
1
インデックスの作成のログは、標準出力にのみ出力されます。必要に応じて、tee コマンドなどを使用し、ログを
ファイルに保存してください。
コマンドの例:
./grn.cgi -C -q code/command/fts/full_index.csp number=50 | tee indexing.log
インデックスの作成を中止した場合、コマンドを再実行すると、作成が再開されます。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
73
4 章 DB 分割構成のガルーンで運用する
インデックスの作成が完了したあとにコマンドを再実行すると、ガルーンのすべてのデータを対象に、インデックス
が再作成されます。
インデックスの作成を中止したあとに、ガルーンのすべてのデータを対象にインデックスを再作成するには、レ
ジューム管理ファイルを削除する必要があります。
レジューム管理ファイルについては、次のページを参照してください。
「インデックス作成のレジューム管理ファイルについて」 - 51 ページ
インデックスの作成が完了するまで、インデックスを作成するコマンドを繰り返し実行する場合は、コマンドを実行
する前に、インデックスの作成が未完了であることを確認してください。レジューム管理ファイルが存在すれば、イ
ンデックスの作成は未完了です。
レジューム管理ファイルについては、次のページを参照してください。
「インデックス作成のレジューム管理ファイルについて」 - 51 ページ
各アプリケーションのデータのインデックスは、次の順番で作成されます。
1. 掲示板
2. メッセージ
3. ファイル管理
4. スペース
5. メール
インデックスの作成を停止する
何らかの理由により、インデックスの作成処理を即時停止する場合は、Ctrl キーと C キーを同時に押します。
4.1.6
作業後の確認
作業後に確認する内容は、ガルーンを新規に構築した場合と、運用中のガルーンの場合とで異なります。
新規に構築したガルーンの場合
新規に構築したガルーンでは、インデックスの作成は数分で完了します。メールのインデックスの作成が終われば、
インデックスの作成は完了です。メールのインデックスの作成が完了すると、コマンドラインに次のメッセージが表示
されます。
[(出力日時)] Finish indexing of received files, tab_grn_mail_fileinfo___p49.
[(出力日時)] Finish indexing of received files.
[(出力日時)] Finish indexing of mail data.
上記のメッセージが表示されたら、次の点を確認します。
掲示板やメッセージに書き込んだ文字列で検索できるかどうか
ファイル管理に添付した文書ファイル内の文字列で検索できるかどうか
検索仕様については、次のページを参照してください。
「6.3 検索仕様」 - 93 ページ
インデックス作成後のトラブルと対処方法
インデックスの作成後にトラブルが発生した場合の対処方法は、次のとおりです。
74
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.1 全文検索サーバーをインストールする
トラブル
「GRN_FTS_00002」のエラーメッ
セージが表示される
検索結果が表示されない
対処方法
次のコマンドを実行し、全文検索サーバーの Solr を起動します。
/etc/init.d/cbss_solr start
上記のコマンドを実行しても解決しない場合、ガルーンから全文検索サーバーへの
接続が正しく設定されているかどうかを確認してください。
「ガルーンの設定」 - 65 ページ
次の操作を実施済みであることを確認します。
MySQL での通知の有効化
「4.1.3 MySQL で通知を有効化する」 - 69 ページ
ガルーンから全文検索サーバーへの接続設定
「ガルーンの設定」 - 65 ページ
全文検索サーバーからガルーンへの接続設定
「全文検索サーバーの設定」 - 62 ページ
運用中のガルーンの場合
運用中のガルーンでは、インデックスの作成に時間がかかります。インデックスの作成が完了したら、正常に検索で
きることを確認します。
インデックスの作成が進んでいることを確認する
次の操作で、インデックスが作成中であることを確認できます。
操作手順:
1
2
ガルーンのシステム管理画面で、[基本システムの管理] > [キューの監視] > [全文検索サーバー]の順
にクリックします。
インデックスの作成が進んでいることを確認します。
次の 2 点を確認します。
•
「キューの残数」が変化すること
•
画面を再読み込みすると、表示されるジョブが変わること
画面の見かたの詳細は、次のページを参照してください。
「5.4 キューの状況を確認する」 - 85 ページ
確認中のトラブルと対処方法
インデックスの作成を確認中にトラブルが発生した場合の対処方法は、次のとおりです。
トラブル
キューの監視画面を開けない
対処方法
次の操作を実施済みであることを確認します。
ガルーンでの全文検索機能の有効化
「4.1.3 MySQL で通知を有効化する」 - 69 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
75
4 章 DB 分割構成のガルーンで運用する
トラブル
画面を再読み込みしても、表示され
るジョブが変わらない
対処方法
次の操作を実施済みであることを確認します。
MySQL での通知の有効化
「4.1.3 MySQL で通知を有効化する」 - 69 ページ
ガルーンから全文検索サーバーへの接続設定
「ガルーンの設定」 - 65 ページ
全文検索サーバーからガルーンへの接続設定
「全文検索サーバーの設定」 - 62 ページ
検索できることを確認する
メールのインデックスの作成が終われば、インデックスの作成は完了です。メールのインデックスの作成が完了する
と、コマンドラインに次のメッセージが表示されます。
[(出力日時)] Finish indexing of received files, tab_grn_mail_fileinfo___p49.
[(出力日時)] Finish indexing of received files.
[(出力日時)] Finish indexing of mail data.
上記のメッセージが表示されたら、次の点を確認します。
掲示板やメッセージに書き込んだ文字列で検索できるかどうか
ファイル管理に添付した文書ファイル内の文字列で検索できるかどうか
検索仕様については、次のページを参照してください。
「6.3 検索仕様」 - 93 ページ
インデックス作成後のトラブルと対処方法
インデックスの作成後にトラブルが発生した場合の対処方法は、次のとおりです。
トラブル
「GRN_FTS_00002」のエラーメッ
セージが表示される
4.2
対処方法
次のコマンドを実行し、全文検索サーバーの Solr を起動します。
/etc/init.d/cbss_solr start
上記のコマンドを実行しても解決しない場合、ガルーンから全文検索サーバーへ
の接続が正しく設定されているかどうかを確認してください。
「ガルーンの設定」 - 65 ページ
全文検索サーバーをアンインストールする
DB 分割構成のガルーンで使用していた全文検索サーバーを、Linux 環境からアンインストールする手順を説明し
ます。
4.2.1
全文検索サーバーをインストールしたサーバーで行う作業
操作手順:
1
2
全文検索サーバーを運用しているサーバーに root ユーザーでログインします。
全文検索サーバーをアンインストールします。
次のコマンドを実行します。
76
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.2 全文検索サーバーをアンインストールする
sh /usr/local/cybozu/cbfts/uninstall
3
ガルーンの添付ファイル保存ディレクトリーへのマウントを解除します。
次のコマンドを実行します。
umount [ガルーンの添付ファイル保存ディレクトリーのパス]
コマンドの例:
umount /usr/local/cybozu/files
4
自動マウントを解除します。
設定ファイル「fstab」を編集し、自動マウントを解除します。
fstab のファイルパス:
/etc/fstab
変更内容:
次の記述を削除します。
[ガルーンの添付ファイルを保存したサーバーの IP アドレスまたはホスト名]:[「files」ディレクトリーのパス]
[「files」ディレクトリーのパス] nfs4 defaults 0 0
注意
全文検索サーバーをアンインストールしたあと、必要に応じてファイアウォールの設定を変更してください。セキュ
リティを考慮し、どのシステムも使用しないポートがあれば閉じることを推奨します。
4.2.2
ガルーンを運用しているサーバーで行う作業
この項目で説明する作業は、全文検索サーバーをアンインストールしたあともガルーンの運用を継続する場合に必
要です。
MySQL の通知を無効化する
MySQL が全文検索サーバーに送信する通知を無効化します。
この作業はキューを管理しているデータベースサーバーで行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
次のディレクトリーに移動します。
/usr/local/cybozu/cbgrn/
コマンドの例:
cd /usr/local/cybozu/cbgrn/
3
次のコマンドを実行します。
./grn.cgi -C -q code/command/fts/disable_udf_notifier.csp db_admin_password=(データベース管理
ユーザーのパスワード)
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
77
4 章 DB 分割構成のガルーンで運用する
「UDF notifier is out of service.」と表示されることを確認します。
エラーメッセージが表示された場合の対処方法は、次のとおりです。
エラーメッセージ
対処方法
Error: DB00000
A database error has occurred.
Database error number: DB00000
Cause:
DB サーバーへの接続に失敗しました
Error: DB99999
A database error has occurred.
Database error number: (エラーコード)
Cause:
Response from database: (エラーメッセー
ジ)
MySQL が起動していない場合は、起動します。
MySQL がすでに起動している場合は、データベース管理ユー
ザーのパスワードが間違っている可能性があります。正しいパス
ワードを指定してください。
MySQL を読み込めません。サイボウズにお問い合わせください。
ガルーンの全文検索機能を無効化する
ガルーンの設定ファイルを編集し、全文検索機能を無効化します。
この作業は、ガルーンを運用しているすべてのサーバーで行います。
操作手順:
1
2
ガルーンを運用しているサーバーに root ユーザーでログインします。
設定ファイル「common.ini」を編集します。
common.ini のファイルパス:
/usr/local/cybozu/cbgrn/common.ini
変更内容:
「enable_fts」プロパティの値を「1」から「0」に変更します。
;; 'enable_fts' sets whether full text search is available.
;; 0: unavailable full text search
;; 1: enable indexing and searchable
;; 2: enable indexing, but invalid full text search
enable_fts = 0
3
4
すべてのサーバーで手順 1 と手順 2 を実行します。
ガルーンの Web サーバーを再起動します。
ガルーンを運用するサーバーで次のコマンドを実行し、Web サーバーを起動します。
•
Red Hat Enterprise Linux Server 6 以前の場合:
/etc/init.d/httpd start
/etc/init.d/cyss_cbgrn start
•
Red Hat Enterprise Linux Server 7 の場合:
systemctl start httpd.service
/etc/init.d/cyss_cbgrn start
アプリケーションサーバーが複数ある場合は、すべてのアプリケーションサーバーで Web サーバーを起動しま
78
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
4.2 全文検索サーバーをアンインストールする
す。
5
ガルーンにログインし、画面上部のバーから検索ボックスが消えていることを確認します。
検索ボックスが消えない場合
検索ボックスが消えない場合は、次のディレクトリー内のディレクトリーやファイルをすべて削除し、ガルーンの
画面を再読み込みしてください。
/usr/local/cybozu/cbgrn/smarty/compiled/
「compiled」ディレクトリー自体は削除しないよう注意してください。
マウントの設定を解除する
NFS サービスの設定ファイル「exports」を編集し、全文検索サーバーからの NFS マウントの許可を解除します。
この作業は、添付ファイルを保存しているサーバーで行います。
操作手順:
1
NFS サービスの設定ファイル「exports」を編集します。
ガルーンの添付ファイルを保存しているサーバーで、「exports」を編集します。
exports のファイルパス:
/etc/exports
変更内容:
次の記述を削除します。
[「files」ディレクトリーのパス] [全文検索サーバーの IP アドレスまたはホスト名](rw)
これで、全文検索サーバーのアンインストールは終了です。
注意
全文検索サーバーをアンインストールしたあと、必要に応じてファイアウォールの設定を変更してください。セキュ
リティを考慮し、どのシステムも使用しないポートがあれば閉じることを推奨します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
79
5 章 全文検索サーバーの保守
全文検索サーバーの保守
5章
データのバックアップ、サービスの起動や停止など、全文検索サーバーの保守に必要な作業を説明します。
ここでは、標準のインストールディレクトリーに全文検索サーバーをインストールした場合を例に説明します。
5.1
データをバックアップする
全文検索サーバーのデータ(インデックス)をバックアップします。
ストレージの故障などによってガルーンにバックアップデータをリストアした場合、全文検索サーバーでインデックスを
再作成するか、ガルーンにリストアしたデータが作成された時点のインデックスに戻します。インデックスの作成には
時間がかかるため、通常、復旧にかかる時間は後者のほうが短くなります。そのため、全文検索サーバーのインデッ
クスは、ガルーンの同時点のデータとセットでバックアップを取得することを推奨します。
Windows 環境でデータをバックアップする
Windows 環境で運用している全文検索サーバーのデータをバックアップします。
操作手順:
1
全文検索サーバーの Worker と Solr を停止します。
コマンドプロンプトで、次のコマンドを実行します。
net stop Cybozu_SearchServer_Worker
net stop Cybozu_SearchServer_Solr
2
バックアップデータを保存するディレクトリーを作成します。
コマンドの例:
mkdir C:¥backup¥YYYYMMDD
3
ガルーンと全文検索サーバーのデータをバックアップします。
全文検索サーバーのデータをバックアップするには、次のディレクトリーをコピーします。
C:¥Program Files¥cybozu¥cbfts¥solr¥v2¥data
全文検索サーバーのデータをコピーするコマンドの例:
xcopy "C:¥Program Files¥cybozu¥cbfts¥solr¥v2¥data" C:¥backup¥YYYYMMDD¥data /e /i
4
全文検索サーバーの Worker と Solr を起動します。
コマンドプロンプトで、次のコマンドを実行します。
net start Cybozu_SearchServer_Solr
net start Cybozu_SearchServer_Worker
補足
全文検索サーバーの Solr が起動する前に、ユーザーがガルーンで全文検索を実行すると、検索画面でエラー
(GRN_FTS_00002)が発生します。
80
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
5.1 データをバックアップする
Linux 環境でデータをバックアップする
Linux 環境で運用している全文検索サーバーのデータをバックアップします。
操作手順:
1
全文検索サーバーの Worker と Solr を停止します。
次のコマンドを実行します。
/etc/init.d/cbss_worker stop
/etc/init.d/cbss_solr stop
2
バックアップデータを保存するディレクトリーを作成します。
コマンドの例:
mkdir /backup/YYYYMMDD
3
ガルーンと全文検索サーバーのデータをバックアップします。
全文検索サーバーのデータをバックアップするには、次のディレクトリーをコピーします。
/usr/local/cybozu/cbfts/solr/v2/data
全文検索サーバーのデータをコピーするコマンドの例:
cp -rp /usr/local/cybozu/cbfts/solr/v2/data /backup/YYYYMMDD/
4
全文検索サーバーの Worker と Solr を起動します。
次のコマンドを実行します。
/etc/init.d/cbss_solr start
/etc/init.d/cbss_worker start
補足
全文検索サーバーの Solr が起動する前に、ユーザーがガルーンで全文検索を実行すると、検索画面でエラー
(GRN_FTS_00002)が発生します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
81
5 章 全文検索サーバーの保守
5.2
データをリストアする
バックアップした全文検索サーバーのデータ(インデックス)をリストアします。
ガルーンと全文検索サーバーのデータは、必ず同時点のデータに戻してください。戻したデータの取得時点が異なる
と、ガルーンの一部のデータが検索されない、または削除したデータが検索されるなどの現象が発生します。
Windows 環境でデータをリストアする
Windows 環境でバックアップしたデータをリストアします。
操作手順:
1
全文検索サーバーの Worker と Solr を停止します。
コマンドプロンプトで、次のコマンドを実行します。
net stop Cybozu_SearchServer_Worker
net stop Cybozu_SearchServer_Solr
2
既存のインデックスをバックアップデータに置き換えます。
data ディレクトリーを削除し、バックアップデータに置き換えます。
リストア中は、ユーザーがガルーンのデータを更新できないようにしてください。
•
削除するディレクトリー:
C:¥Program Files¥cybozu¥cbfts¥solr¥v2¥data
•
バックアップデータ(C:¥backup¥YYYYMMDD¥data)をコピーするコマンドの例:
xcopy C:¥backup¥YYYYMMDD¥data "C:¥Program Files¥cybozu¥cbfts¥solr¥v2¥data" /e /i
3
手順 2 で置き換えたデータのアクセス権を確認します。
data ディレクトリーと、data のサブディレクトリーに、次のアクセス権があることを確認します。
82
•
グループ:Everyone
•
フルコントロール:許可
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
5.2 データをリストアする
上記のアクセス権がない場合は、アクセス権を追加します。
4
全文検索サーバーの Solr と Worker を起動します。
コマンドプロンプトで、次のコマンドを実行します。
net start Cybozu_SearchServer_Solr
net start Cybozu_SearchServer_Worker
5
ガルーンのユーザー画面にアクセスし、全文検索が使用できることを確認します。
Linux 環境でデータをリストアする
Linux 環境でバックアップしたデータをリストアします。
操作手順:
1
全文検索サーバーの Worker と Solr を停止します。
次のコマンドを実行します。
/etc/init.d/cbss_worker stop
/etc/init.d/cbss_solr stop
2
既存のインデックスをバックアップデータに置き換えます。
data ディレクトリーを削除し、バックアップデータに置き換えます。
リストア中は、ユーザーがガルーンのデータを更新できないようにしてください。
•
削除するディレクトリー:
/usr/local/cybozu/cbfts/solr/v2/data
•
バックアップデータ(/backup/YYYYMMDD/data)をコピーするコマンドの例:
cp -rp /backup/YYYYMMDD/data /usr/local/cybozu/cbfts/solr/v2/
3
手順 2 で置き換えたデータのアクセス権を確認します。
次のアクセス権があることを確認します。
•
•
ディレクトリー:
data と、data のサブディレクトリー
•
所有者:httpd 起動ユーザー(例:apache)
•
所有グループ:root
•
パーミッション:755
ファイル:
data のサブディレクトリー内のファイル
•
所有者:httpd 起動ユーザー(例:apache)
•
所有グループ:root
•
パーミッション:644
上記のアクセス権がない場合は、アクセス権を設定します。
4
全文検索サーバーの Solr と Worker を起動します。
次のコマンドを実行します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
83
5 章 全文検索サーバーの保守
/etc/init.d/cbss_solr start
/etc/init.d/cbss_worker start
5
ガルーンのユーザー画面にアクセスし、全文検索が使用できることを確認します。
5.3
サーバーを移行する
全文検索サーバーを同じ OS のサーバーに移行します。
Windows 環境では、Windows の「Administrator」権限を持つユーザーで操作します。
Linux 環境では、root ユーザーで操作します。
補足
異なる OS のサーバーには、全文検索サーバーのデータを移行できません。異なる OS のサーバーに全文検索
サーバーをインストールし、インデックスを再作成してください。
データの移行中は、ガルーンの Web サーバーとスケジューリングサービスを停止し、ガルーンにアクセスできな
いようにしてください。
操作手順:
1
移行先のサーバーに全文検索サーバーをインストールし、初期設定を行います。
ただし、インデックスを作成する必要はありません。手順 3 でバックアップしたデータを使用します。
Windows 環境:
「2.3.1 全文検索サーバーをインストールする」 - 17 ページ
「2.3.2 ガルーンと全文検索サーバーの接続を設定する」 - 17 ページ
「2.3.3 添付ファイル保存領域を共有する」 - 24 ページ
Linux 環境:
「2.4.1 全文検索サーバーをインストールする」 - 38 ページ
「2.4.2 ガルーンと全文検索サーバーの接続を設定する」 - 39 ページ
「2.4.3 添付ファイル保存領域をマウントする」 - 42 ページ
DB 分割構成のガルーンで全文検索を運用する場合:
「4.1 全文検索サーバーをインストールする」 - 61 ページ
2
移行先のサーバーの Worker を停止します。
Windows 環境:
「Worker を停止する」 - 88 ページ
Linux 環境:
「Worker を停止する」 - 89 ページ
3
移行元のサーバーで全文検索サーバーのデータをバックアップします。
「5.1 データをバックアップする」 -80 ページ
4
84
移行元のサーバーで、ファイル「solr.xml」をバックアップします。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
5.4 キューの状況を確認する
全文検索サーバーを標準のディレクトリーにインストールした場合の solr.xml のファイルパスは、次のとおりで
す。
Windows 環境:
C:¥Program Files¥cybozu¥cbfts¥solr¥v2¥solr.xml
Linux 環境:
/usr/local/cybozu/cbfts/solr/v2/solr.xml
5
手順 1 で用意した移行先のサーバーに、手順 3 でバックアップしたデータをリストアします。
「5.2 データをリストアする」 -82 ページ
6
移行先のサーバーのファイル「solr.xml」に、手順 4 でバックアップした solr.xml を上書きします。
全文検索サーバーを標準のディレクトリーにインストールした場合の solr.xml のファイルパスは、次のとおりで
す。
Windows 環境:
C:¥Program Files¥cybozu¥cbfts¥solr¥v2¥solr.xml
Linux 環境:
/usr/local/cybozu/cbfts/solr/v2/solr.xml
7
移行先のサーバーで、Worker を起動します。
Windows 環境:
「Worker を起動する」 - 90 ページ
Linux 環境:
「Worker を起動する」 - 90 ページ
8
移行先の全文検索サーバーに正常にアクセスできることを確認します。
5.4
キューの状況を確認する
キューの次の情報を確認できます。
Worker が次に取得するデータ
キューに積まれているデータの件数
必要に応じて、キューからデータを削除できます。
ただし、削除したデータに含まれる字句は、検索できなくなります。何らかの理由で処理できないデータがあり、デー
タの処理が進まないなどのトラブルが発生している場合以外には、キューのデータは削除しないでください。
補足
キューの役割については、次のページを参照してください。
「1.1 全文検索サーバーのしくみ」 - 7 ページ
操作手順:
1
2
ガルーンのシステム管理画面で、[基本システムの管理] > [キューの監視] > [全文検索サーバー]の順
にクリックします。
必要な操作を行います。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
85
5 章 全文検索サーバーの保守
キューにデータがあれば、Worker が次に取得するデータが表示されます。
各項目の見かた
項目
説明
補足
id
データの ID です。
id は重複する場合があります。データは、id と
ctime で識別されます。
ctime
jobName
キューにデータが追加された日時です。
ジョブの種類です。
日付と時刻は UTC で表示されます。
次のいずれかが表示されます。
fts-bulk-indexer
ガルーンのすべてのデータを対象にイン
デックスを作成する場合に表示されます。
ただし、データがメールの添付ファイルの場
合は、jobName には常に「fts-indexer」
が表示されます。
fts-indexer
ガルーンのデータの更新分だけを対象にイ
ンデックスを作成する場合に表示されます。
message
データに含まれる字句と付加情報です。
キューの残数
このキューを削除
キューに残っているデータの件数です。
次に Worker が取得するデータを削除しま
す。
5.5
ガルーンのすべてのデータを対象にインデックスを
作成する場合は表示されません。
検索ログを出力する
全文検索を実行したときのログ(検索ログ)を出力できます。検索ログは、検索が遅い、検索結果が表示されないな
どの問題が発生した場合に、原因を調査するための情報を記載しています。
検索ログを出力するには、ガルーンの common.ini ファイルで設定している、ログの出力レベル(fts_log)を変更
します。
86
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
5.6 インデックスを再作成する
標準のディレクトリーにインストール識別子「cbgrn」を使用してガルーンをインストールした場合、common.ini は
次のディレクトリーに保存されます。
Windows:C:¥Inetpub¥scripts¥cbgrn¥common.ini
Linux:/var/www/cgi-bin/cbgrn/common.ini
変更前:
[FTS]
(省略)
;; The place of output logs is set 'log_file_path'. Default value is %CGI_ROOT%/fts.log.
fts_log = 0
log_file_path = "/var/www/cgi-bin/cbgrn/fts.log"
変更後:
[FTS]
(省略)
;; The place of output logs is set 'log_file_path'. Default value is %CGI_ROOT%/fts.log.
fts_log = 2
log_file_path = "/var/www/cgi-bin/cbgrn/fts.log"
a)
a):出力レベルを「0」から「2」に変更
ログの出力レベルは次のとおりです。
出力レベル
説明
0
1
ログを出力しません。
検索クエリーのログを出力します。
2
1、2 以外
検索クエリーのログと、検索実行時の solr の応答のログを出力します。
ログを出力しません。
補足
全文検索を利用するユーザーの数、検索する頻度、およびガルーンのデータ量によって、大量のログが出力され
る場合があります。
5.6
インデックスを再作成する
インデックスの作成中に処理を中止したり、エラーが発生して処理が未完了だったりする場合は、インデックスを再作
成する必要があります。
操作手順:
1
レジューム管理ファイルが残っているかどうかを確認します。
ガルーンは、2 つのレジューム管理ファイルでインデックス作成の進捗を管理しています。インデックスの作成
が完了すると、レジューム管理ファイルは削除されます。
前回インデックスを作成した際に作成されたレジューム管理ファイルがサーバーに残っている場合は、両方とも
削除します。
レジューム管理ファイルが保存されているディレクトリーと、ファイル名は、次のとおりです。
Windows 環境:
•
C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥fts¥full_index_resume.json
•
C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥fts¥full_index_arguments.json
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
87
5 章 全文検索サーバーの保守
Linux 環境:
2
•
/usr/local/cybozu/mysql-5.0/files/cbgrn/fts/full_index_resume.json
•
/usr/local/cybozu/mysql-5.0/files/cbgrn/fts/full_index_arguments.json
全文検索サーバーで、検索に必要なインデックスを作成します。
詳細は次のページを参照してください。
Windows 環境:「2.3.6 インデックスを作成する」 - 33 ページ
Linux 環境:「2.4.6 インデックスを作成する」 - 49 ページ
DB 分割構成ガルーンで全文検索を運用する場合:「4.1.5 インデックスを作成する」 - 72 ページ
5.7
サービスの停止方法と起動方法
全文検索サーバーのサービスを停止または起動する方法を説明します。
5.7.1
Windows 環境でサービスを停止する
Windows 環境で Solr と Worker を停止する方法を説明します。
Solr を停止する
Solr を停止するには、次のどちらかの操作を行います。
画面を操作して停止する
コマンドを使用して停止する
画面を操作して停止する
Windows の「サービス」画面で solr を停止します。
操作手順:
1
2
Windows のスタートメニューから、[管理ツール] > [サービス]の順に選択します。
「Cybozu_SearchServer_Solr」を選択し、[サービスの停止]をクリックします。
コマンドを使用して停止する
コマンドプロンプトで次のコマンドを実行します。
net stop Cybozu_SearchServer_Solr
Worker を停止する
Worker を停止するには、次のどちらかの操作を行います。
画面を操作して停止する
コマンドを使用して停止する
88
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
5.7 サービスの停止方法と起動方法
画面を操作して停止する
Windows の「サービス」画面で Worker を停止します。
操作手順:
1
2
Windows のスタートメニューから、[管理ツール] > [サービス]の順に選択します。
「Cybozu_SearchServer_Worker」を選択し、[サービスの停止]をクリックします。
コマンドを使用して停止する
コマンドプロンプトで次のコマンドを実行します。
net stop Cybozu_SearchServer_Worker
5.7.2
Linux 環境環境でサービスを停止する
Linux 環境で、Solr と Worker を停止する方法を説明します。
Solr を停止する
次のコマンドを実行します。
/etc/init.d/cbss_solr stop
Worker を停止する
次のコマンドを実行します。
/etc/init.d/cbss_worker stop
5.7.3
Windows 環境でサービスを起動する
Windows 環境で、Solr と Worker を起動する方法を説明します。
Solr を起動する
Solr を起動するには、次のどちらかの操作を行います。
画面を操作して起動する
コマンドを使用して起動する
画面を操作して起動する
Windows の「サービス」画面で Solr を起動します。
操作手順:
1
Windows のスタートメニューから、[管理ツール] > [サービス]の順に選択します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
89
5 章 全文検索サーバーの保守
2
「Cybozu_SearchServer_Solr」を選択し、[サービスの開始]をクリックします。
コマンドを使用して起動する
コマンドプロンプトで次のコマンドを実行します。
net start Cybozu_SearchServer_Solr
Worker を起動する
Worker を起動するには、次のどちらかの操作を行います。
画面を操作して起動する
コマンドを使用して起動する
画面を操作して起動する
Windows の「サービス」画面で Worker を起動します。
操作手順:
1
2
Windows のスタートメニューから、[管理ツール] > [サービス]の順に選択します。
「Cybozu_SearchServer_Worker」を選択し、[サービスの開始]をクリックします。
コマンドを使用して起動する
コマンドプロンプトで次のコマンドを実行します。
net start Cybozu_SearchServer_Worker
5.7.4
Linux 環境でサービスを起動する
Linux 環境で Solr と Worker を起動する方法を説明します。
Solr を起動する
次のコマンドを実行します。
/etc/init.d/cbss_solr start
Worker を起動する
次のコマンドを実行します。
/etc/init.d/cbss_worker start
90
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
6.1 検索できるアプリケーション
6章
全文検索を使用する
ガルーンのユーザー画面で、次の 2 つの検索機能を使用できます。
すべてのアプリケーションの一括検索機能
ヘッダーのキーワード入力欄にキーワードを入力し、ガルーン内のデータを検索します。全文検索を使用できるす
べてのアプリケーションのデータを、一括で検索できます。
アプリケーションごとの検索機能
各アプリケーションのキーワード欄にキーワードを入力し、アプリケーション内のデータを検索します。
b)
a):すべてのアプリケーションの一括検索機能
b):アプリケーションごとの検索機能
6.1
検索できるアプリケーション
全文検索では、次のアプリケーションのデータを検索できます。
スペース
メッセージ
掲示板
ファイル管理
メール
画面例:
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
91
6 章 全文検索を使用する
「検索結果」画面例:
検索結果画面で、差出人欄にユーザーの表示名を入力すると、差出人でデータを検索したり、検索結果を絞り込ん
だりできます。 検索や検索結果の絞り込みには、別言語での表示名も使用できます。
データが更新されている場合は、最終更新者の表示名で検索、または絞り込んだ結果が表示されます。
6.2
検索できるデータ
全文検索で検索できるデータは次のとおりです。
項目
スペース
1、2
検索対象
ディスカッション
検索項目
タイトル
本文
コメント
備考
「ファイルのみ表示」と「タイトルを検
索」は併用できません。
添付ファイルのファイル名
3
共有 ToDo
添付ファイルの内容 3
ToDo 名
内容
添付ファイルのファイル名
3
添付ファイルの内容 3
メッセージ 1、2
メッセージ
コメント
標題
本文
差出人
コメント
添付ファイルのファイル名
「ファイルのみ表示」と「タイトルを検
索」は併用できません。
次のメッセージは検索できません。
・ごみ箱内のメッセージ
・下書きのメッセージ
3
添付ファイルの内容 3
92
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
6.3 検索仕様
項目
掲示板 1、4
検索対象
掲示
検索項目
タイトル
本文
コメント
添付ファイルのファイル名
3
ファイル管理 4
ファイル
添付ファイルの内容 3
タイトル
3
ファイル名
ファイルの説明
ファイルの内容 3
更新者
メール
メール
標題
本文
差出人
添付ファイルのファイル名
備考
「ファイルのみ表示」と「タイトルを検
索」は併用できません。
次の掲示は検索できません。
・下書きの掲示
・掲示開始待ちの掲示
・期限切れの掲示
次のファイルは検索できません。
・ごみ箱内のファイル
・古い世代のファイル
次の項目は検索できません。
・更新情報
・更新コメント
次のメールは検索できません。
・未読のメール
・ごみ箱内のメール
・下書きのメール
添付ファイルの内容
To
Cc
Bcc
1
: 「ファイルのみ表示」のチェックボックスを選択すると、添付ファイルのみを検索します。
「タイトルを検索」または「標題を検索」のチェックボックスを選択すると、掲示やメッセージなどのタイトルまた
は標題のみを検索します。
2
: 最大 100 万個のスペースおよびメッセージを検索できます。
3
: 検索できるファイルの形式は、次のページを参照してください。
「6.3.3 検索できるファイル」 - 95 ページ
4
: サブフォルダーまたはサブカテゴリーを含め、最大 10000 個のフォルダーやカテゴリーを検索できます。
10001 個以上のフォルダーやカテゴリーを検索する場合は、フォルダーやカテゴリーを選択して検索します。
6.3
検索仕様
複数の検索キーワードを指定して、AND 条件で検索できます。
入力できるキーワードは、全角、半角問わず最大で 100 文字です。キーワード入力欄に全角または半角の文字を
101 文字以上入力した場合、101 文字目以降の文字は無効になります。
「検索結果」画面では、次のオプションを使用して検索結果を絞り込めます。
表示順:
「関連度」または「更新日時」の順に表示します。「関連度」を選択すると、キーワードの使用頻度や、データ内の
キーワードの間隔などをもとに、関連性の高いものから順に検索結果が表示されます。
「差出人」または「更新者」:
検索結果を、データの最終更新者で絞り込めます。メールデータは、差出人と宛先(To、Cc、Bcc)で更新結果を
絞り込めます。
期間:
データの最終更新日の期間を指定して、検索結果を絞り込めます。
開始日のみを指定した場合は、指定した日付から今日までの期間に更新されたデータを検索します。終了日のみ
を指定した場合は、更新日が最も古いデータから指定した日までの期間に更新されたデータを検索します。
言語:
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
93
6 章 全文検索を使用する
検索結果を言語で絞り込めます。
6.3.1
「差出人」を使用した検索と、検索結果の絞り込み
差出人欄にユーザーの表示名を入力すると、差出人でデータを検索したり、検索結果を絞り込んだりできます。 検
索や検索結果の絞り込みには、別言語での表示名も使用できます。
データが更新されている場合は、最終更新者の表示名で検索したり、または絞り込んだ結果を表示したりできます。
次のアプリケーションは、差出人の表示名でデータを検索したり、検索結果を絞り込んだりできます。
メッセージ
メール
次のアプリケーションは、差出人の表示名で検索結果を絞り込めます。
スペース
ファイル管理
掲示板
差出人の表示名で検索結果を絞り込む場合
キーワード欄にキーワード(検索する文字列)を入力します。
差出人欄に、ユーザーの表示名の一部またはすべての文字列を入力し、データを検索します。
差出人の表示名でデータを検索する場合
キーワード欄を空欄にします。
差出人欄に、ユーザーの表示名の一部またはすべての文字列を入力し、データを検索します。
6.3.2
キーワードやファイル形式に関する制限事項
使用する文字や検索するファイルのファイル形式などによっては、入力したキーワードで検索できない場合がありま
す。
日本語または中国語を使用した検索
値が 1 文字のデータは、1 文字のキーワードで検索できます。値が 2 文字以上のデータは、2 文字以上のキー
ワードで検索します。
例:
値が「日本語」のデータを検索する場合
検索可能なキーワード:「日本」、「本語」、および「日本語」
検索できないキーワード:「日」、「本」、および「語」
94
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
6.3 検索仕様
補足
キーワードに句読点以外の全角記号を使用すると、検索できない場合があります。
英数字を使用した検索
単語単位で検索します。スペース、記号、または全角文字で区切られた英数字が単語として認識されます。
アルファベットの大文字と小文字は区別されません。
例:
値が「Garoon」のデータを検索する場合
検索可能なキーワード:「garoon」
検索できないキーワード:「Gar」
6.3.3
検索できるファイル
次のファイルを検索できます。
製品またはファイル形式
Word
バージョンまたは種類
Windows 版:
Word 95、97、98、2000、2002 (XP)、2003、2007、2010、2013
Mac OS 版:
Word 98、2001、2004、2008、2011、2013
Excel
Windows 版:
Excel 95、97、2000、2002(XP)、2003、2007、2010、2013
Mac OS 版:
Excel 98、2001、2004、2008、2011、2013
PowerPoint
Windows 版:
PowerPoint 95、97、2000、2002(XP)、2003、2007、2010、2013
Mac OS 版:
PowerPoint 98、2001、2004、2008、2011、2013
Visio
OpenDocument Format
(ODF)
Acrobat
Visio 2002(XP)、2003、2007、2010、2013
バージョン:1.0、1.1、1.2
種類:
・文書ドキュメント
・表計算ドキュメント
・プレゼンテーションファイル
4.0、5.0、6.0、7.0、8.0、9.0、X、XI
PDF
JUSTSYSTEM 一太郎
1.2、1.3、1.4、1.5、1.6、1.7
XPS
リッチテキスト
XPS
RTF
Ver.5 から Ver.13
2006 から 2011
テキスト
テキスト
HTML
XML
SGML
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
95
6 章 全文検索を使用する
ファイルサイズの上限値
検索できるファイルのファイルサイズの上限値は、ファイルの拡張子や MIME タイプによって異なります。
ファイルサイズの上限値は、次のとおりです。
MIME タイプ
ファイル拡張子
96
.txt, .text
.html, .htm
text/plain
text/html
.xml
.doc
text/xml
application/msword
.docx
application/vnd.openxmlformatsofficedocument.wordprocessingml.document
.docm
application/vnd.msword.document.macroEnabled.12
.xls
.xlsx
application/vnd.ms-excel
application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet
.xlsm
.ppt
application/vnd.ms-excel.sheet.macroEnabled.12
application/vnd.ms-powerpoint
.pptx
application/vnd.openxmlformatsofficedocument.presentationml.presentation
.pptm
application/vnd.mspowerpoint.presentation.macroEnabled.12
.pdf
.doc, .xls, .ppt
application/pdf
application/x-tika-msoffice
.docx, .xlsx, .pptx
上記以外の拡張子
application/x-tika-ooxml
すべての MIME タイプ
ファイルサイズの上限値
40MB
1MB
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
付録 A ログ一覧
付録A ログ一覧
全文検索サーバーとガルーンに記録される、検索に関連するログについて説明します。
Worker のログ(worker.log.###)
Worker のログは、インデックスの作成で発生したエラーを調査する場合に使用します。
ガルーンのデータの一部を検索できない場合は、このログで、インデックスの作成が成功したかどうかを確認しま
す。
標準のインストールディレクトリーに全文検索サーバーをインストールした場合、次のディレクトリーに Worker のロ
グが保存されます。
Windows 環境の場合:C:¥Program Files¥Cybozu¥cbfts¥logs
Linux 環境の場合:/usr/local/cybozu/cbfts/logs
Worker のログは、10MB ごとにファイルを分けて、10 個まで保存されます。
最新のログのファイル名は、「worker.log」です。古いログのファイル名には、末尾に 1 から 9 までの連番が、古い
順に振られます。
例:worker.log.1
ファイル名の末尾の数が大きいほど、古いログです。保存されたファイルの数が 10 個を超えると、古いファイルが
削除されます。
出力例:
2014-11-17 10:10:40,343 [pool-269-thread-1] INFO OnpremiseExtractorImpl - extract C:/Program
Files/Cybozu/mysql-5.0/files/cbgrn/bulletin/grn_bulletin_filebody/0/0/10
2014-11-17 10:10:40,343 [pool-269-thread-1] INFO FileInputFieldBuilderImpl - extract fatal
exception occured.
com.cybozu.common.blob.extract.ExtractFatalException: File size exceeded 1048576 bytes.
id=C:¥Program Files¥Cybozu¥mysql-5.0¥files¥cbgrn¥bulletin¥grn_bulletin_filebody¥0¥0¥10,
type=UNKNOWN, size=1249725.
at com.cybozu.common.fts.job.IndexMethod$1.createRequest(IndexMethod.java:45)
at com.cybozu.common.fts.job.IndexMethod$1.buildUpdateRequest(IndexMethod.java:25)
at com.cybozu.common.fts.job.IndexJob.run(IndexJob.java:80)
at com.cybozu.common.async.JobRunner.run(JobRunner.java:176)
at com.cybozu.common.async.JobRunner.doCall(JobRunner.java:149)
at com.cybozu.common.async.JobRunner.call(JobRunner.java:111)
at com.cybozu.common.async.JobRunner.call(JobRunner.java:29)
出力されるエラーメッセージの例:
エラーメッセージ
java.io.FileNotFoundException: path=
(添付ファイルのパス) extract fatal
exception occured.
説明
ファイルが見つからないため、「(添付ファイルのパス)」の添付ファイルのイ
ンデックス作成をスキップしたことを表します。
File size exceeded MAX_VALUE bytes.
id=(添付ファイルのパス), type=(ファイルの
種類), size=(ファイルサイズ).
ファイルサイズが 50MB を超えているため、「(添付ファイルのパス)」の添
付ファイルのインデックス作成をスキップしたことを表します。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
97
付録 A ログ一覧
検索クエリーのログ(fts.log)
検索クエリーのログは、検索に時間がかかる、最新の情報が検索できないなどのトラブルの原因を調査する場合に
使用します。
fts.log は、ガルーンの common.ini の[FTS]セクションで設定しているディレクトリーに保存されます。
標準のインストールディレクトリーとインストール識別子「cbgrn」を使用してガルーンをインストールした場合、ガルー
ンを運用するサーバーの次のディレクトリーに、検索クエリーのログが保存されます。
Windows 環境の場合:C:¥inetpub¥scripts¥cbgrn
Linux 環境の場合:/var/www/cgi-bin/cbgrn
補足
検索クエリーのログを出力するには、ガルーンの設定ファイル(common.ini)で、出力レベルを指定します。
出力例:
[Thu, 25 Sep 2014 15:39:18 +0900] [userID: 1] Query: q=あいうえお
&rows=30&start=0&fq=((app.s:mail AND userId.i:1 AND accountId.i:1 AND folderId.i:(2)
AND !fileId.i:[* TO
*]))&fl=id,fileId.i,name.t&hl=true&hl.fl=name.t,text&hl.useFastVectorHighlighter=true&hl.tag
.pre=fe06d48b-bea8-4719-b01b-1afc959ba40a&hl.tag.post=ae1b5f0c-24ba-49d8-aa6294323ebb48ea&hl.phraseLimit=100&defType=normalizeQParser&hl.fragsize=200&timeAllowe
d=20000
[Thu, 25 Sep 2014 15:39:18 +0900] [userID: 1] [Processing time: 124ms] Response:
{"numFound":17,"start":0,"docs":[{"id":"G.Amail.U1.M3"},{"id":"G.Amail.U1.M100"},{"id":"
G.Amail.U1.M115"},{"id":"G.Amail.U1.M116"},{"id":"G.Amail.U1.M117"},{"id":"G.Amail.U1.
M118"},{"id":"G.Amail.U1.M119"},{"id":"G.Amail.U1.M120"},{"id":"G.Amail.U1.M121"},{"id"
:"G.Amail.U1.M122"},{"id":"G.Amail.U1.M123"},{"id":"G.Amail.U1.M124"},{"id":"G.Amail.U1
.M125"},{"id":"G.Amail.U1.M18"},{"id":"G.Amail.U1.M126"},{"id":"G.Amail.U1.M127"},{"id"
:"G.Amail.U1.M128"}]}
[Thu, 25 Sep 2014 15:41:04 +0900] [userID: 1] Query:
q=cybozu&rows=30&start=0&fq=((app.s:mail AND userId.i:1 AND accountId.i:1 AND
folderId.i:(2) AND !fileId.i:[* TO
*]))&fl=id,fileId.i,name.t&hl=true&hl.fl=name.t,text&hl.useFastVectorHighlighter=true&hl.tag
.pre=a1dc549b-33b6-4845-a353-3f331d34ef7d&hl.tag.post=a003fed2-4588-43ab-870376b6cad31f00&hl.phraseLimit=100&defType=normalizeQParser&hl.fragsize=200&timeAllowe
d=20000
[Thu, 25 Sep 2014 15:41:05 +0900] [userID: 1] [Processing time: 369ms] Response:
{"numFound":113,"start":0,"docs":[{"id":"G.Amail.U1.M2"},{"id":"G.Amail.U1.M8"},{"id":"G.
Amail.U1.M3"},{"id":"G.Amail.U1.M7"},{"id":"G.Amail.U1.M4"},{"id":"G.Amail.U1.M5"},{"id"
:"G.Amail.U1.M6"},{"id":"G.Amail.U1.M9"},{"id":"G.Amail.U1.M10"},{"id":"G.Amail.U1.M11"
},{"id":"G.Amail.U1.M15"},{"id":"G.Amail.U1.M16"},{"id":"G.Amail.U1.M18"},{"id":"G.Amail.
U1.M23"},{"id":"G.Amail.U1.M25"},{"id":"G.Amail.U1.M33"},{"id":"G.Amail.U1.M34"},{"id":"
G.Amail.U1.M30"},{"id":"G.Amail.U1.M20"},{"id":"G.Amail.U1.M21"},{"id":"G.Amail.U1.M22"
},{"id":"G.Amail.U1.M100"},{"id":"G.Amail.U1.M115"},{"id":"G.Amail.U1.M116"},{"id":"G.A
mail.U1.M117"},{"id":"G.Amail.U1.M118"},{"id":"G.Amail.U1.M119"},{"id":"G.Amail.U1.M12
0"},{"id":"G.Amail.U1.M121"},{"id":"G.Amail.U1.M122"}]}
a)
b)
a):検索クエリーの内容
b):solr からの応答
98
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
付録 A ログ一覧
エラーログ(fts.cb.YYYYMMDD.log)
エラーログは、検索中にガルーンで発生したエラーを調査する場合に使用します。
エラーログは、ログが出力された日付ごとに作成されます。
例:2014 年 9 月 26 日に出力されたログのファイル名
fts.cb.20140926.log
標準のインストールディレクトリーにガルーンをインストールした場合、ガルーンを運用するサーバーの次のディレクト
リーにエラーログが保存されます。
Windows 環境の場合:C:¥Program Files¥Cybozu¥cbfts¥logs
Linux 環境の場合:/usr/local/cybozu/cbfts/logs
補足
複数のアプリケーションサーバーでガルーンを運用している場合、エラーが発生した検索リクエストを実行したアプ
リケーションサーバーにエラーログが保存されます。
出力例:
[Fri, 19 Sep 2014 11:02:56 +0900]
file: /var/www/cgi-bin/cbgrn/code/include/fts/SearchLogic.csp, line:37, message:Failed to get
SolrClient, code:0
file:/var/www/cgi-bin/cbgrn/code/include/fts/SearchLogic.csp, line:142, message:Failed ping
request. Response code 0 , code:1004
a)
[Fri, 19 Sep 2014 11:40:37 +0900]
file:/var/www/cgi-bin/cbgrn/code/include/fts/AccessControlledSearchLogic.csp, line:45,
message:SearchLogic::search throws error, code:0
file:/var/www/cgi-bin/cbgrn/code/include/fts/SearchLogic.csp, line:58,
message:SolrClient::query failed, code:0
file:/var/www/cgi-bin/cbgrn/code/include/fts/SearchLogic.csp, line:56, message:Unsuccessful
query request : Response Code 400. <?xml version="1.0" encoding="UTF-8"?>
(省略)
a): solr に接続できなかったことを表します。
システム管理のログ
システム管理画面でキューからデータを削除すると、ログが表示されます。
ログは、次の構成で出力されます。
[操作][対象][ログの内容]
操作:
ユーザーが行った操作です。
対象:
アプリケーションが監視している対象です。
ログの内容
操作を行ったユーザーや、ログの対象となったデータなどが、「プロパティ:値」の形式で記述されます。値と値の
間は、「,」(カンマ)とスペースで区切られています。
プロパティ
id: データの ID
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
99
付録 A ログ一覧
message: データに含まれる字句と付加情報
ログ
対象
キュー
操作
インデックスの削除
深刻度
一般情報
出力仕様
[delete] queue (id:XX, message: {XXX,…})
フルインデックスの削除
一般情報
[delete] queue (id:XX)
補足
システム管理でログを出力するには、ロギングの設定が必要です。詳細は次のページを参照してください。
『サイボウズ ガルーン バージョン 4.0 管理者ガイド』の「ログの出力条件を設定する」
https://help.cybozu.com/ja/g40/admin/logging/config.html
フルインデックスの作成ログ
フルインデックスの作成ログは、どのアプリケーションのインデックスが作成されているのかを確認する場合に使用し
ます。
フルインデックスのログは、通常は画面に表示されます。ファイルにログを保存する場合は、実行時にオプションで保
存先を指定します。
エラーが発生した場合の原因を調査するために、フルインデックスを作成する際は、ログをファイルに出力することを
推奨します。
Windows 環境 :「2.3.6 インデックスを作成する」 - 33 ページ
Linux 環境:「2.4.6 インデックスを作成する」 - 49 ページ
DB 分割構成ガルーンで全文検索を運用する場合:「4.1.5 インデックスを作成する」 - 72 ページ
出力例:
[Mon, 18 Aug 2014 11:23:04 +0900] Start indexing of bulletin data.
[Mon, 18 Aug 2014 11:23:04 +0900] Start indexing of articles.
[Mon, 18 Aug 2014 11:23:04 +0900] execute: C:/inetpub/scripts/cbgrn/grn.exe
code/command/fts/child_process_runner.csp command=grn.fts.bulletin.BulkArticleIndexer
forward= startId=2 endId=2 2>&1
[Mon, 18 Aug 2014 11:23:04 +0900] 1 articles indexed.
[Mon, 18 Aug 2014 11:23:04 +0900] Finish indexing of articles.
a)
a): インデックスが作成されたことを表します。
出力例:
[Mon, 18 Aug 2014 11:01:36 +0900] Delete core: cb_cbgrn
[Mon, 18 Aug 2014 11:01:36 +0900] [ERROR] Failed to delete core: cb_cbgrn
[Mon, 18 Aug 2014 11:01:36 +0900] [ERROR] Can't connect to Solr server!
(省略)
Failed to create indexes
b)
c)
b): Solr に接続できなかったことを表します。
c): 5 回実行して、インデックスを作成できなかったことを表します。
補足
5 回実行してもインデックスを作成できなかったデータは、インデックスが作成されるまで、全文検索の検索対象に
なりません。
100
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
付録 B エラーメッセージ
付録B エラーメッセージ
付録B.1 システム管理画面に表示されるエラーメッセージ
全文検索サーバーのシステム管理画面に表示されるエラーメッセージは、次のとおりです。
エラー番号
GRN_FTS_00001
エラーメッセージ
検索に失敗しました。
原因
サーバーに不具合が発生してい
る恐れがあります。
GRN_FTS_00002
検索に失敗しました
サーバーとの通信時にエラーが
発生しました。
GRN_FTS_00003
検索に失敗しました。
検索サーバーのインデックスファ
イルが破損している可能性があり
ます。
対策
サイボウズオフィシャルパート
ナー、または販売元にお問い合
わせください。
サーバーが停止している可能性
があります。
サイボウズオフィシャルパート
ナー、または販売元にお問い合
わせください。
サイボウズオフィシャルパート
ナー、または販売元にお問い合
わせください。
付録B.2 インストール時のエラー
全文検索サーバーのインストール時に表示されるエラーメッセージと対処方法は、次のとおりです。
エラーメッセージ
Error: DB00000
A database error has
occurred.
Database error number:
DB00000
Cause:
DB サーバーへの接続に失敗しま
した
主な原因
次のどちらかの原因が考えら
れます。
・MySQL が起動していない。
・データベース管理ユーザーの
パスワードが間違っている。
対処方法
MySQL が起動していない場合は、起動します。
MySQL がすでに起動している場合は、データベース
管理ユーザーのパスワードが間違っている可能性が
あります。正しいパスワードを指定します。
Error: DB99999
A database error has
occurred.
Database error number: (エ
ラーコード)
Cause:
Response from database:
(エラーメッセージ)
MySQL を読み込めません。
サイボウズにお問い合わせください。
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
101
付録 C ファイル構成
付録C ファイル構成
標準のインストールディレクトリーに全文検索サーバーをインストールした場合を例に、全文検索サーバーのファイ
ル構成を説明します。
標準のインストールディレクトリー
Windows 環境:C:¥Program Files¥cybozu
Linux 環境:/usr/local/cybozu/
付録C.1 Windows 環境
太字はディレクトリーを、通常の文字はファイルを示しています。
C:¥Program Files¥cybozu
└¥cbfts
Ýbin
インストールディレクトリー
インストール識別子
全文検索サーバーの実行プログラム
│ ├¥configure
│ ├¥prunsrv.exe
│ ├¥SolrService.bat
│ └¥WorkerService.bat
│
Ýconf
設定ファイル
│ ├¥cb
│ │ ├¥cbgrn.json
│ │ ├¥fts.json
│ │ ├¥middleware.properties
│ │ └¥slash.json
│ │
│ ├¥solr
│ │ └¥log4j.properties
│ │
│ ├¥worker
│ │ └¥log4j.properties
│ │
│ └¥deploy.json
│
Ýjar
│ ├¥common-deploy.jar
│ └¥common-fts-server.jar
│
Ýjre
Ýlicenses
Ýlogs
Ýresource
Ýsolr
102
インデックスの保存先ディレクトリー
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
付録 C ファイル構成
Ýtemp
│
Ý.com.zerog.registry.xml
ÝInstallScript.iap_xml
Ýinstallvariables.properties
Ýuninstall.exe
Ýuninstall.lax
└¥uninstaller.jar
付録C.2 Linux 環境
Linux 環境にインストールされるファイルは、次の 2 つに分類されます。
アプリケーション
起動スクリプト
アプリケーション
太字はディレクトリーを、標準の文字はファイルを示しています。
/usr/local/cybozu/cbfts
└/cbfts
├/bin
インストールディレクトリー
インストール識別子
全文検索サーバーの実行プログラム
│ ├/bootSolr.sh
│ ├/bootWorker.sh
│ ├/configure
│ ├/SolrServer.sh
│ └/WorkerServer.sh
│
├/conf
設定ファイル
│ ├/cb
│ │ ├/cbgrn.json
│ │ ├/fts.json
│ │ ├/middleware.properties
│ │ └/slash.json
│ │
│ ├/deploy.json
│ ├/log4j.solr.properties
│ └/log4j.worker.properties
│
├/jar
│ ├/common-deploy.jar
│ └/common-fts-server.jar
│
├/jre
├/licenses
├/logs
├/solr
インデックスの保存先ディレクトリー
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
103
付録 C ファイル構成
├/temp
│
├/.com.zerog.registry.xml
├/cbss-recoverly-solr
├/cbss-recoverly-worker
├/InstallScript.iap_xml
├/installvariables.properties
├/productInfo
├/uninstall
├/uninstall.lax
└/uninstaller.jar
起動スクリプト
太字はディレクトリーを、標準の文字はファイルを示しています。
/etc/rc.d/init.d
├/cbss_solr
solr を起動するスクリプト(SolrServer.sh)
└/cbss_worker worker を起動するスクリプト(WorkerServer.sh)
104
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
付録 D 困ったときは
付録D 困ったときは
よくある質問と対処方法を記載しています。
本書に記載されていない問題が発生した場合は、サイボウズ オフィシャルパートナー、または販売元にお問い合わ
せください。
https://www.cybozu.com/jp/partner/list/sales/
現象
インデックスの作成中に
「[ERROR]」が表示された。
対処
ガルーンの状態を確認してください。
Windows 環境:「2.3.6 インデックスを作成する」 - 33 ページ
Linux 環境:「2.4.6 インデックスを作成する」 - 49 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「4.1.5 インデックスを作成する」 - 72 ページ
ガルーンの画面に検索ボックスが
表示されない。
ガルーンを運用しているサーバーに古いファイルが残っている可能性があります。
Windows 環境:「検索ボックスが表示されない場合」 - 33 ページ
Linux 環境:「検索ボックスが表示されない場合」 - 49 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「検索ボックスが表示されない場合」 - 72 ページ
エラー「GRN_FTS_00002」が発
生する
全文検索サーバーの Solr を起動します。
Solr を起動しても解決しない場合、ガルーンから全文検索サーバーへの接続を正しく設
定していることを確認してください。
Windows 環境の場合:「ガルーンの設定」 - 23 ページ
Linux 環境の場合:「ガルーンの設定」 - 41 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「ガルーンの設定」 - 65 ページ
次の操作を実施済みであることを確認します。
検索結果が表示されない
MySQL の通知の有効化
Windows 環境:「2.3.4 MySQL で通知を有効化する」 - 30 ページ
Linux 環境:「2.4.4 MySQL で通知を有効化する」 - 46 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「4.1.3 MySQL で通知を有効化する」 - 69 ページ
ガルーンから全文検索サーバーへの接続設定
Windows 環境:「ガルーンの設定」 - 23 ページ
Linux 環境:「ガルーンの設定」 - 41 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「ガルーンの設定」 - 65 ページ
全文検索サーバーからガルーンへの接続設定
Windows 環境:「全文検索サーバーの設定」 - 18 ページ
Linux 環境:「全文検索サーバーの設定」 - 39 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「全文検索サーバーの設定」 - 62 ページ
キューの監視画面を開けない
次の操作を実施済みであることを確認します。
ガルーンでの全文検索機能の有効化
Windows 環境:「2.3.5 ガルーンで全文検索機能を有効化する」 - 32
ページ
Linux 環境:「2.4.5 ガルーンで全文検索機能を有効化する」 - 47 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「4.1.4 ガルーンで全文検索機能を有効化する」 - 71 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
105
付録 D 困ったときは
現象
画面を再読み込みしても、表示さ
れるジョブが変わらない
対処
次の操作を実施済みであることを確認します。
MySQL の通知の有効化
Windows 環境:「2.3.4 MySQL で通知を有効化する」 - 30 ページ
Linux 環境:「2.4.4 MySQL で通知を有効化する」 - 46 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「4.1.3 MySQL で通知を有効化する」 - 69 ページ
ガルーンから全文検索サーバーへの接続の設定
Windows 環境:「ガルーンの設定」 - 23 ページ
Linux 環境:「ガルーンの設定」 - 41 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「ガルーンの設定」 - 65 ページ
全文検索サーバーからガルーンへの接続設定
Windows 環境:「全文検索サーバーの設定」 - 18 ページ
Linux 環境:「全文検索サーバーの設定」 - 39 ページ
DB 分割構成ガルーンで全文検索を運用する場合:
「全文検索サーバーの設定」 - 62 ページ
Windows 環境で、インデックスの
作成に時間がかかる
106
ガルーンを運用しているサーバーで、ウイルス対策ソフトウェアが動作しているかどうか
を確認します。動作している場合は、ウイルス対策ソフトウェアの監視対象から、イン
デックスの作成に使用するディレクトリーを外します。
「1.3.2 ウイルススキャンの回避」 - 10 ページ
サイボウズ 全文検索サーバー バージョン 2.0 ガイド
発行日
2015 年 5 月 25 日 第 2.2 版発行
発行者
サイボウズ株式会社
Copyright (C) 2013 - 2015 Cybozu
サイボウズ 全文検索サーバー バージョン 2.0 ガイド