null+****@clear*****
null+****@clear*****
2012年 6月 26日 (火) 17:12:16 JST
Ryo Onodera 2012-06-26 17:12:16 +0900 (Tue, 26 Jun 2012) New Revision: 86a69f9cf9df0a06d0fe1fc41bf841fc908e8ee7 https://github.com/groonga/groonga/commit/86a69f9cf9df0a06d0fe1fc41bf841fc908e8ee7 Log: httpd: update document for groonga-httpd Modified files: doc/source/executables/groonga-httpd.txt Modified: doc/source/executables/groonga-httpd.txt (+41 -17) =================================================================== --- doc/source/executables/groonga-httpd.txt 2012-06-26 15:43:30 +0900 (47f4fb3) +++ doc/source/executables/groonga-httpd.txt 2012-06-26 17:12:16 +0900 (3783d32) @@ -8,13 +8,15 @@ groonga-httpd Summary ------- -groonga-httpd is an HTTP groonga server. It functions as same as :ref:`groonga-http-service`. -The difference is that groonga-httpd processes HTTP requests by embedded nginx. -On the other hand, groonga-http does by a minimal built-in HTTP server. All -standards-compilicance and features provided by nginx is also available in +groonga-httpd is a program to communicate with a groonga server using the HTTP +protocol. It functions as same as :ref:`groonga-http-service`. Although +:ref:`groonga-http-service` has limited support for HTTP with a minimal built-in +HTTP server, :ref:`groonga-httpd` has full support for HTTP with an embedded +nginx. All standards-compliance and features provided by nginx is also available in groonga-httpd. For details about nginx, see http://www.nginx.org/ -groonga-httpd has an Web-based adiministration tool implemented with HTML and JavaScript. You can access to it via http://hostname:port/. +groonga-httpd has an Web-based administration tool implemented with HTML and +JavaScript. You can access to it from http://hostname:port/. Synopsis -------- @@ -26,14 +28,17 @@ Synopsis Usage ----- -First, you'll need to edit the configuration file for groonga-httpd to specify -database. Edit /etc/groonga/httpd/groonga-httpd.conf to enable +Set up +^^^^^ + +First, you'll need to edit the groonga-httpd configuration file to specify a +database. Edit /etc/groonga/httpd/groonga-httpd.conf to enable the groonga_database directive like this:: - location /d/ { - groonga; - groonga_database /var/lib/groonga/db/db; # <= Specify actual database and - # enable this directive + location /d/ { # <= Don't change the location; currently only /d/ is supported. + groonga; # <= This means to turn on groonga-httpd. + groonga_database /var/lib/groonga/db/db; # <= Specify an actual database and + # enable this directive. } Then, run groonga-httpd. Note that the control immediately returns back to the @@ -41,6 +46,9 @@ console because groonga-httpd runs as a daemon process by default.:: % groonga-httpd +Request queries +^^^^^^^^^^^^^^^ + To check, request a simple query.:: % curl -s http://localhost:10041/d/status | python -m json.tool @@ -63,8 +71,13 @@ To check, request a simple query.:: } ] +Browse the administration tool +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Also, you can browse Web-based administration tool at http://localhost:10041/. -Also, you can browse Web-based adiministration tool at http://localhost:10041/. +Shut down +^^^^^^^^^ Finally, to terminate the running groonga-httpd daemon, run this:: @@ -73,14 +86,17 @@ Finally, to terminate the running groonga-httpd daemon, run this:: Configuration directives ------------------------ -The following directives can be used in the configuration file of groonga-httpd. +There are two kinds of configuration directives. One is provided by nginx, the +other is by groonga-httpd. + +The following directives can be used in the groonga-httpd configuration file. By default, it's located at /etc/groonga/httpd/groonga-httpd.conf. Groonga-specific directives ^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following directives aren't provided by nginx. They are provided by -groonga-httpd to configure groonga-httpd-specific directives. +groonga-httpd to configure groonga-httpd-specific configurations. ``groonga_database`` """""""""""""""""""" @@ -90,10 +106,10 @@ Specifies the path to a groonga database. Performance-related directives ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The following directives are related to performance. +The following directives are related to the performance of groonga-httpd. -``worker_processess`` -""""""""""""""""""""" +``worker_processes`` +"""""""""""""""""""" For optimum performance, set this to be equal to the number of CPUs or cores. In many cases, groonga queries may be CPU-intensive work, so to fully utilize @@ -103,3 +119,11 @@ This isn't a groonga-httpd specific directive, but an nginx's one. For details, see http://wiki.nginx.org/CoreModule#worker_processes. By default, this is set to 1. It is nginx's default. + +Available nginx modules +----------------------- + +All standard HTTP modules except HttpRewriteModule is available. +HttpRewriteModule is disabled to avoid to depend on PCRE (Perl Compatible +Regular Expressions). For the list of other standard HTTP modules, see +http://wiki.nginx.org/Modules. -------------- next part -------------- HTML$B$NE:IU%U%!%$%k$rJ]4I$7$^$7$?(B...下載
