YUKI Hiroshi
null+****@clear*****
Wed Sep 24 19:34:35 JST 2014
YUKI Hiroshi 2014-09-24 19:34:35 +0900 (Wed, 24 Sep 2014) New Revision: d9f24d24a835d842ecb7c24747d47cb2043d7c30 https://github.com/droonga/droonga.org/commit/d9f24d24a835d842ecb7c24747d47cb2043d7c30 Message: Update basic tutorial based on installation scripts Modified files: _po/ja/tutorial/1.0.6/basic/index.po ja/tutorial/1.0.6/basic/index.md tutorial/1.0.6/basic/index.md Modified: _po/ja/tutorial/1.0.6/basic/index.po (+75 -142) =================================================================== --- _po/ja/tutorial/1.0.6/basic/index.po 2014-09-24 18:44:29 +0900 (b34b0b1) +++ _po/ja/tutorial/1.0.6/basic/index.po 2014-09-24 19:34:35 +0900 (1ded751) @@ -188,41 +188,8 @@ msgstr "" msgid "Assume that the host is `192.168.100.50`." msgstr "ホストが `192.168.100.50` だと仮定します。" -msgid "## Install packages required for the setup process" -msgstr "## セットアップに必要なパッケージをインストールする" - -msgid "Install packages required to setup a Droonga engine." -msgstr "Droonga をセットアップするために必要になるパッケージをインストールします。" - -msgid "Ubuntu:" -msgstr "" - -msgid "" -" # apt-get update\n" -" # apt-get -y upgrade\n" -" # apt-get install -y ruby ruby-dev build-essential nodejs nodejs-legacy np" -"m" -msgstr "" - -msgid "CentOS 7:" -msgstr "" - -msgid "CentOS 6.5:" -msgstr "" - -msgid "" -" # yum -y groupinstall development\n" -" # yum -y install epel-release ruby-devel\n" -" # yum -y install npm" -msgstr "" - -msgid "" -"Yes, in short, you have to activate `gem` and `npm` commands, and install some" -" packages to build native extensions." -msgstr "要するに、`gem`と`npm`を使えるようにした上で、ネイティブ拡張をビルドするためのいくつかのパッケージをインストールする必要があるということです。" - -msgid "## Build a Droonga engine" -msgstr "## Droonga Engine を構築する" +msgid "## Install Droonga engine" +msgstr "### Droonga Engineをインストールする" msgid "" "The part \"Droonga engine\" stores the database and provides the search feature " @@ -236,52 +203,47 @@ msgstr "" msgid "### Install `droonga-engine`" msgstr "### `droonga-engine`をインストールする" -msgid " # gem install droonga-engine" -msgstr "" +msgid "Download the installation script and run it by `bash` as the root user:" +msgstr "インストールスクリプトをダウンロードし、root権限で`bash`で実行して下さい:" msgid "" -"Required packages are prepared by the command above. Let's continue to the con" -"figuration step." -msgstr "Droonga Engine を構築するのに必要なパッケージがセットアップできました。引き続き設定に移ります。" - -msgid "### Prepare configuration files to start `droonga-engine`" -msgstr "### `droonga-engine`を起動するための設定ファイルを用意する" - -msgid "" -"Create a user for the `droonga-engine` service and the configuration directory" -".\n" -"All configuration files and physical databases are placed under the directory:" +"~~~\n" +"# curl https://raw.githubusercontent.com/droonga/droonga-engine/master/install" +".sh | \\\n" +" bash\n" +"...\n" +"Installing droonga-engine from RubyGems...\n" +"...\n" +"Preparing the user...\n" +"...\n" +"Setting up the configuration directory...\n" +"This node is configured with a hostname XXXXXXXX." msgstr "" -"`droonga-engine`サービス用のユーザを作成し、設定ディレクトリを作成します。\n" -"すべての設定ファイルと物理的なデータベースはこのディレクトリの下に置かれます:" msgid "" -" # useradd -m droonga-engine\n" -" $ sudo -u droonga-engine -H mkdir ~droonga-engine/droonga\n" -" $ cd ~droonga-engine/droonga" +"Registering droonga-engine as a service...\n" +"...\n" +"Successfully installed droonga-engine.\n" +"~~~" msgstr "" -msgid "" -"Then put a configuration file `droonga-engine.yaml` like following, into the d" -"irectory:" -msgstr "以下の内容で設定ファイル `droonga-engine.yaml` をディレクトリ内に作成します。" - -msgid "droonga-engine.yaml:" -msgstr "" +msgid "### Prepare configuration files to start `droonga-engine`" +msgstr "### `droonga-engine`を起動するための設定ファイルを用意する" msgid "" -" host: 192.168.100.50\n" -" port: 10031\n" -" tag: droonga" +"All configuration files and physical databases are placed under a `droonga` di" +"rectory in the home directory of the service user `droonga-engine`:" msgstr "" +"すべての設定ファイルと物理的なデータベースは、`droonga-engine`サービス用のユーザのホームディレクトリ内にある`droonga`ディレクトリの" +"下に置かれます:" -msgid "You must put correct host name or IP address of the computer itself." -msgstr "そのコンピュータ自身の正しいホスト名またはIPアドレスを書く必要があります。" +msgid " $ cd ~droonga-engine/droonga" +msgstr "" msgid "" -"Next, put another configuration file `catalog.json` like following, into the d" -"irectory:" -msgstr "次に、以下の内容で別の設定ファイル `catalog.json` をディレクトリ内に作成します。" +"Then, put (overwrite) a configuration file `catalog.json` like following, into" +" the directory:" +msgstr "では、以下の内容で設定ファイル `catalog.json` を上書きしましょう:" msgid "catalog.json:" msgstr "" @@ -414,42 +376,29 @@ msgid "" "manual of catalog.json](/reference/catalog)." msgstr "`catalog.json` の詳細については [catalog.json](/ja/reference/catalog) を参照してください。" -msgid "### Start the `droonga-engine` server process" -msgstr "### `droonga-engine`をサーバプロセスを起動する" - -msgid "" -"Start the `droonga-engine` server process. You can do it with the command `dro" -"onga-engine`, like:" -msgstr "`droonga-engine`のサーバプロセスを起動します。これは`droonga-engine`コマンドを使って以下のように行います:" - -msgid " $ sudo -u droonga-engine -H droonga-engine" -msgstr "" - -msgid "### Stop the `droonga-engine` server process" -msgstr "### `droonga-engine` のサーバプロセスを停止する" +msgid "### Start and stop the `droonga-engine` service" +msgstr "### `droonga-engine`サービスの起動と終了" -msgid "You need to know how to stop `droonga-engine` server process." -msgstr "最初に`droonga-engine`のサーバプロセスを終了する方法を知っておきましょう。" +msgid "The `droonga-engine` service can be started via the `service` command:" +msgstr "`droonga-engine`サービスは`service`コマンドを使って起動できます:" -msgid "Run `droonga-engine-stop`, a utility command to stop droonga-engine service:" -msgstr "droonga-engineのサービスを停止するためのユーティリティコマンド `droonga-engine-stop` を実行します。" - -msgid " $ sudo -u droonga-engine -H droonga-engine-stop" +msgid "" +"~~~\n" +"# service droonga-engine start\n" +"~~~" msgstr "" -msgid "or, send SIGTERM to droonga-engine directly:" -msgstr "または、droonga-engineに直接SIGTERMを送ります。" +msgid "To stop it, you also have to use the `service` command:" +msgstr "終了する場合も、`service`コマンドを使います:" msgid "" -" $ sudo -u droonga-engine -H kill $(cat ~droonga-engine/droonga/droonga-en" -"gine.pid)" +"~~~\n" +"# service droonga-engine stop\n" +"~~~" msgstr "" -msgid "This is the way to stop droonga-engine." -msgstr "これがdroonga-engineを終了する方法です。" - -msgid "Start droonga-engine again:" -msgstr "再度droonga-engineを起動します。" +msgid "After confirmation, start the `droonga-engine` again." +msgstr "確認できたら、再び`droonga-engine`を起動します。" msgid "### Create a database" msgstr "### データベースを作成する" @@ -1146,65 +1095,49 @@ msgid "### Install the droonga-http-server" msgstr "### droonga-http-serverをインストールする" msgid "" -"It is an npm package for the Node.js so you can install it by `npm` command ea" -"sily:" -msgstr "`droonga-http-server`は、Node.js のパッケージなので、`npm`コマンドで簡単にインストールすることができます：" - -msgid " # npm install -g droonga-http-server" +"~~~\n" +"# curl https://raw.githubusercontent.com/droonga/droonga-http-server/master/in" +"stall.sh | \\\n" +" bash\n" +"...\n" +"Installing droonga-http-server from npmjs.org...\n" +"...\n" +"Preparing the user...\n" +"...\n" +"Setting up the configuration directory...\n" +"The droonga-engine service is detected on this node.\n" +"The droonga-http-server is configured to be connected\n" +"to this node (XXXXXXXX).\n" +"This node is configured with a hostname XXXXXXXX." msgstr "" -msgid "Next, prepare a user for the service." -msgstr "次に、サービス用のユーザを用意します。" - msgid "" -" # useradd -m droonga-http-server\n" -" $ sudo -u droonga-http-server -H mkdir ~droonga-http-server/droonga\n" -" $ cd ~droonga-http-server/droonga" +"Registering droonga-http-server as a service...\n" +"...\n" +"Successfully installed droonga-http-server.\n" +"~~~" msgstr "" -msgid "" -"Then put a configuration file `droonga-http-server.yaml` into the configuratio" -"n directory." -msgstr "以下の内容で設定ファイル `droonga-http-server.yaml` を設定ディレクトリ内に作成します。" - -msgid "droonga-http-server.yaml:" -msgstr "" +msgid "### Start and stop the `droonga-http-server` service" +msgstr "### `droonga-engine`サービスの起動と終了" -msgid "" -" port: 10041\n" -" environment: production" -msgstr "" +msgid "The `droonga-http-server` service can be started via the `service` command:" +msgstr "`droonga-http-server`サービスは`service`コマンドを使って起動できます:" msgid "" -"Because there is `droogna-engine.yaml` and droonga-http-server automatically l" -"oads some information from `droogna-engine.yaml`, you only have to put very fe" -"w information to the `droonga-http-server.yaml`.\n" -"If no droonga-engine is working on the computer, you have to specify required " -"information completely, to communicate with a droonga-engine server.\n" -"For example, if the computer is `192.168.100.51` and there is a droonga-engine" -" server `192.168.100.50`, then `droonga-http-server.yaml` on `192.168.100.51` " -"should be:" +"~~~\n" +"# service droonga-http-server start\n" +"~~~" msgstr "" -"`droogna-engine.yaml`が存在する場合、droonga-http-serverは自動的にそのファイルの内容を参照するため、`droonga" -"-http-server.yaml`にはごく一部の情報だけを置けば十分です。\n" -"そのコンピュータ上でdroonga-engineが動作していない場合には、droonga-engineサーバと通信するために、必要な情報尾すべて書く必要があ" -"ります。\n" -"例えば、そのコンピュータが `192.168.100.51` で、droogna-engineサーバである別のコンピュータ `192.168.100.50`" -" が存在している場合では、`droonga-http-server.yaml`の内容は以下の要領となります：" msgid "" -" port: 10041\n" -" environment: production\n" -" engine:\n" -" host: 192.168.100.50\n" -" receive_host: 192.168.100.51" +"~~~\n" +"# service droonga-http-server stop\n" +"~~~" msgstr "" -msgid "OK, let's run it." -msgstr "では、サーバを起動しましょう。" - -msgid " $ sudo -u droonga-http-server -H droonga-http-server" -msgstr "" +msgid "After confirmation, start the `droonga-http-server` again." +msgstr "確認できたら、再び`droonga-http-server`を起動します。" msgid "### Search request via HTTP" msgstr "### HTTPでの検索リクエスト" Modified: ja/tutorial/1.0.6/basic/index.md (+63 -83) =================================================================== --- ja/tutorial/1.0.6/basic/index.md 2014-09-24 18:44:29 +0900 (ce03870) +++ ja/tutorial/1.0.6/basic/index.md 2014-09-24 19:34:35 +0900 (55e5f40) @@ -81,61 +81,38 @@ Droonga Engine自体は通信プロトコルとしてfluentdプロトコルに ホストが `192.168.100.50` だと仮定します。 -## セットアップに必要なパッケージをインストールする - -Droonga をセットアップするために必要になるパッケージをインストールします。 - -Ubuntu: - - # apt-get update - # apt-get -y upgrade - # apt-get install -y ruby ruby-dev build-essential nodejs nodejs-legacy npm - -CentOS 7: - - # apt-get update - # apt-get -y upgrade - # apt-get install -y ruby ruby-dev build-essential nodejs nodejs-legacy npm - -CentOS 6.5: - - # yum -y groupinstall development - # yum -y install epel-release ruby-devel - # yum -y install npm - -要するに、`gem`と`npm`を使えるようにした上で、ネイティブ拡張をビルドするためのいくつかのパッケージをインストールする必要があるということです。 - -## Droonga Engine を構築する +### Droonga Engineをインストールする Droonga Engine は、データベースを保持し、実際の検索を担当する部分です。 このセクションでは、 droonga-engine をインストールし、検索対象となるデータを準備します。 ### `droonga-engine`をインストールする - # gem install droonga-engine +インストールスクリプトをダウンロードし、root権限で`bash`で実行して下さい: -Droonga Engine を構築するのに必要なパッケージがセットアップできました。引き続き設定に移ります。 +~~~ +# curl https://raw.githubusercontent.com/droonga/droonga-engine/master/install.sh | \ + bash +... +Installing droonga-engine from RubyGems... +... +Preparing the user... +... +Setting up the configuration directory... +This node is configured with a hostname XXXXXXXX. + +Registering droonga-engine as a service... +... +Successfully installed droonga-engine. +~~~ ### `droonga-engine`を起動するための設定ファイルを用意する -`droonga-engine`サービス用のユーザを作成し、設定ディレクトリを作成します。 -すべての設定ファイルと物理的なデータベースはこのディレクトリの下に置かれます: +すべての設定ファイルと物理的なデータベースは、`droonga-engine`サービス用のユーザのホームディレクトリ内にある`droonga`ディレクトリの下に置かれます: - # useradd -m droonga-engine - $ sudo -u droonga-engine -H mkdir ~droonga-engine/droonga $ cd ~droonga-engine/droonga -以下の内容で設定ファイル `droonga-engine.yaml` をディレクトリ内に作成します。 - -droonga-engine.yaml: - - host: 192.168.100.50 - port: 10031 - tag: droonga - -そのコンピュータ自身の正しいホスト名またはIPアドレスを書く必要があります。 - -次に、以下の内容で別の設定ファイル `catalog.json` をディレクトリ内に作成します。 +では、以下の内容で設定ファイル `catalog.json` を上書きしましょう: catalog.json: @@ -246,29 +223,25 @@ catalog.json: `catalog.json` の詳細については [catalog.json](/ja/reference/catalog) を参照してください。 -### `droonga-engine`をサーバプロセスを起動する - -`droonga-engine`のサーバプロセスを起動します。これは`droonga-engine`コマンドを使って以下のように行います: - - $ sudo -u droonga-engine -H droonga-engine - -### `droonga-engine` のサーバプロセスを停止する +### `droonga-engine`サービスの起動と終了 -最初に`droonga-engine`のサーバプロセスを終了する方法を知っておきましょう。 +`droonga-engine`サービスは`service`コマンドを使って起動できます: -droonga-engineのサービスを停止するためのユーティリティコマンド `droonga-engine-stop` を実行します。 - - $ sudo -u droonga-engine -H droonga-engine-stop - -または、droonga-engineに直接SIGTERMを送ります。 +~~~ +# service droonga-engine start +~~~ - $ sudo -u droonga-engine -H kill $(cat ~droonga-engine/droonga/droonga-engine.pid) +終了する場合も、`service`コマンドを使います: -これがdroonga-engineを終了する方法です。 +~~~ +# service droonga-engine stop +~~~ -再度droonga-engineを起動します。 +確認できたら、再び`droonga-engine`を起動します。 - $ sudo -u droonga-engine -H droonga-engine +~~~ +# service droonga-engine start +~~~ ### データベースを作成する @@ -935,39 +908,46 @@ HTTP Protocol Adapterとして`droonga-http-server`を使用しましょう。 ### droonga-http-serverをインストールする -`droonga-http-server`は、Node.js のパッケージなので、`npm`コマンドで簡単にインストールすることができます： - - # npm install -g droonga-http-server +インストールスクリプトをダウンロードし、root権限で`bash`で実行して下さい: -次に、サービス用のユーザを用意します。 - - # useradd -m droonga-http-server - $ sudo -u droonga-http-server -H mkdir ~droonga-http-server/droonga - $ cd ~droonga-http-server/droonga - -以下の内容で設定ファイル `droonga-http-server.yaml` を設定ディレクトリ内に作成します。 +~~~ +# curl https://raw.githubusercontent.com/droonga/droonga-http-server/master/install.sh | \ + bash +... +Installing droonga-http-server from npmjs.org... +... +Preparing the user... +... +Setting up the configuration directory... +The droonga-engine service is detected on this node. +The droonga-http-server is configured to be connected +to this node (XXXXXXXX). +This node is configured with a hostname XXXXXXXX. -droonga-http-server.yaml: +Registering droonga-http-server as a service... +... +Successfully installed droonga-http-server. +~~~ - port: 10041 - environment: production +### `droonga-engine`サービスの起動と終了 -`droogna-engine.yaml`が存在する場合、droonga-http-serverは自動的にそのファイルの内容を参照するため、`droonga-http-server.yaml`にはごく一部の情報だけを置けば十分です。 -そのコンピュータ上でdroonga-engineが動作していない場合には、droonga-engineサーバと通信するために、必要な情報尾すべて書く必要があります。 -例えば、そのコンピュータが `192.168.100.51` で、droogna-engineサーバである別のコンピュータ `192.168.100.50` が存在している場合では、`droonga-http-server.yaml`の内容は以下の要領となります： +`droonga-http-server`サービスは`service`コマンドを使って起動できます: -droonga-http-server.yaml: +~~~ +# service droonga-http-server start +~~~ - port: 10041 - environment: production - engine: - host: 192.168.100.50 - receive_host: 192.168.100.51 +終了する場合も、`service`コマンドを使います: -では、サーバを起動しましょう。 +~~~ +# service droonga-http-server stop +~~~ - $ sudo -u droonga-http-server -H droonga-http-server +確認できたら、再び`droonga-http-server`を起動します。 +~~~ +# service droonga-engine start +~~~ ### HTTPでの検索リクエスト Modified: tutorial/1.0.6/basic/index.md (+63 -83) =================================================================== --- tutorial/1.0.6/basic/index.md 2014-09-24 18:44:29 +0900 (d3412c2) +++ tutorial/1.0.6/basic/index.md 2014-09-24 19:34:35 +0900 (7605289) @@ -73,61 +73,38 @@ NOTE: Make sure to use instances with >= 2GB memory equipped, at least during in Assume that the host is `192.168.100.50`. -## Install packages required for the setup process - -Install packages required to setup a Droonga engine. - -Ubuntu: - - # apt-get update - # apt-get -y upgrade - # apt-get install -y ruby ruby-dev build-essential nodejs nodejs-legacy npm - -CentOS 7: - - # apt-get update - # apt-get -y upgrade - # apt-get install -y ruby ruby-dev build-essential nodejs nodejs-legacy npm - -CentOS 6.5: - - # yum -y groupinstall development - # yum -y install epel-release ruby-devel - # yum -y install npm - -Yes, in short, you have to activate `gem` and `npm` commands, and install some packages to build native extensions. - -## Build a Droonga engine +## Install Droonga engine The part "Droonga engine" stores the database and provides the search feature actually. In this section we install a droonga-engine and load searchable data to the database. ### Install `droonga-engine` - # gem install droonga-engine +Download the installation script and run it by `bash` as the root user: -Required packages are prepared by the command above. Let's continue to the configuration step. +~~~ +# curl https://raw.githubusercontent.com/droonga/droonga-engine/master/install.sh | \ + bash +... +Installing droonga-engine from RubyGems... +... +Preparing the user... +... +Setting up the configuration directory... +This node is configured with a hostname XXXXXXXX. + +Registering droonga-engine as a service... +... +Successfully installed droonga-engine. +~~~ ### Prepare configuration files to start `droonga-engine` -Create a user for the `droonga-engine` service and the configuration directory. -All configuration files and physical databases are placed under the directory: +All configuration files and physical databases are placed under a `droonga` directory in the home directory of the service user `droonga-engine`: - # useradd -m droonga-engine - $ sudo -u droonga-engine -H mkdir ~droonga-engine/droonga $ cd ~droonga-engine/droonga -Then put a configuration file `droonga-engine.yaml` like following, into the directory: - -droonga-engine.yaml: - - host: 192.168.100.50 - port: 10031 - tag: droonga - -You must put correct host name or IP address of the computer itself. - -Next, put another configuration file `catalog.json` like following, into the directory: +Then, put (overwrite) a configuration file `catalog.json` like following, into the directory: catalog.json: @@ -238,29 +215,25 @@ The `"address"` indicates the location of the corresponding physical storage whi For more details of the configuration file `catalog.json`, see [the reference manual of catalog.json](/reference/catalog). -### Start the `droonga-engine` server process - -Start the `droonga-engine` server process. You can do it with the command `droonga-engine`, like: - - $ sudo -u droonga-engine -H droonga-engine - -### Stop the `droonga-engine` server process +### Start and stop the `droonga-engine` service -You need to know how to stop `droonga-engine` server process. +The `droonga-engine` service can be started via the `service` command: -Run `droonga-engine-stop`, a utility command to stop droonga-engine service: - - $ sudo -u droonga-engine -H droonga-engine-stop - -or, send SIGTERM to droonga-engine directly: +~~~ +# service droonga-engine start +~~~ - $ sudo -u droonga-engine -H kill $(cat ~droonga-engine/droonga/droonga-engine.pid) +To stop it, you also have to use the `service` command: -This is the way to stop droonga-engine. +~~~ +# service droonga-engine stop +~~~ -Start droonga-engine again: +After confirmation, start the `droonga-engine` again. - $ sudo -u droonga-engine -H droonga-engine +~~~ +# service droonga-engine start +~~~ ### Create a database @@ -928,39 +901,46 @@ Let's use the `droonga-http-server` as an HTTP protocol adapter. ### Install the droonga-http-server -It is an npm package for the Node.js so you can install it by `npm` command easily: - - # npm install -g droonga-http-server +Download the installation script and run it by `bash` as the root user: -Next, prepare a user for the service. - - # useradd -m droonga-http-server - $ sudo -u droonga-http-server -H mkdir ~droonga-http-server/droonga - $ cd ~droonga-http-server/droonga - -Then put a configuration file `droonga-http-server.yaml` into the configuration directory. +~~~ +# curl https://raw.githubusercontent.com/droonga/droonga-http-server/master/install.sh | \ + bash +... +Installing droonga-http-server from npmjs.org... +... +Preparing the user... +... +Setting up the configuration directory... +The droonga-engine service is detected on this node. +The droonga-http-server is configured to be connected +to this node (XXXXXXXX). +This node is configured with a hostname XXXXXXXX. -droonga-http-server.yaml: +Registering droonga-http-server as a service... +... +Successfully installed droonga-http-server. +~~~ - port: 10041 - environment: production +### Start and stop the `droonga-http-server` service -Because there is `droogna-engine.yaml` and droonga-http-server automatically loads some information from `droogna-engine.yaml`, you only have to put very few information to the `droonga-http-server.yaml`. -If no droonga-engine is working on the computer, you have to specify required information completely, to communicate with a droonga-engine server. -For example, if the computer is `192.168.100.51` and there is a droonga-engine server `192.168.100.50`, then `droonga-http-server.yaml` on `192.168.100.51` should be: +The `droonga-http-server` service can be started via the `service` command: -droonga-http-server.yaml: +~~~ +# service droonga-http-server start +~~~ - port: 10041 - environment: production - engine: - host: 192.168.100.50 - receive_host: 192.168.100.51 +To stop it, you also have to use the `service` command: -OK, let's run it. +~~~ +# service droonga-http-server stop +~~~ - $ sudo -u droonga-http-server -H droonga-http-server +After confirmation, start the `droonga-http-server` again. +~~~ +# service droonga-engine start +~~~ ### Search request via HTTP -------------- next part -------------- HTML����������������������������...Download