Kouhei Sutou
null+****@clear*****
Thu Dec 6 13:45:14 JST 2012
Kouhei Sutou 2012-12-06 13:45:14 +0900 (Thu, 06 Dec 2012) New Revision: 07ac9a21b554f07d404d5961c3adb04faa0201cf https://github.com/groonga/fluent-plugin-groonga/commit/07ac9a21b554f07d404d5961c3adb04faa0201cf Log: doc: split configuration document Added files: doc/text/configuration.md Modified files: README.md Modified: README.md (+3 -0) =================================================================== --- README.md 2012-12-06 13:45:04 +0900 (0b12987) +++ README.md 2012-12-06 13:45:14 +0900 (84a97af) @@ -30,6 +30,9 @@ You can replicate your data by using `copy` output plugin. ## Usage +* About configuration: See doc/text/configuration.md or + [Web](http://www.rubydoc.info/gems/fluent-plugin-groonga/file/configuration.md). + ### The `groonga` input plugin Here are available parameters: Added: doc/text/configuration.md (+61 -0) 100644 =================================================================== --- /dev/null +++ doc/text/configuration.md 2012-12-06 13:45:14 +0900 (d6ed3a0) @@ -0,0 +1,61 @@ +# @title Configuration + +# Configuration + +Fluent-plugin-groonga includes two fluentd plugins. They are the +`groonga` input plugin and the `groonga` output plugin. This documents +describes configuration parameters of them. + +## The `groonga` input plugin + +Here are available parameters: + +* `protocol`: It specifies protocol for receiving groonga commands. + * available values: `http` and `gqtp` + * default: `http` +* `bind`: It specifies bind address. + * default: `0.0.0.0` +* `port`: It specifies port number. + * default: `10041` +* `real_host`: It specifies real groonga server's address. It is required. + * default: no default. +* `real_port`: It specifies real groonga server's port number. + * default: `10041` +* `emit_commands`: TODO + +Here is an example: + + <source> + type groonga + protocol http + bind 127.0.0.1 + port 10041 + real_host 192.168.0.1 + real_port 10041 + </source> + +## The `groonga` output plugin + +* `protocol`: It specifies protocol for sending groonga commands to groonga. + * available values: `http`, `gqtp` and `command` + * default: `http` +* For `http` and `gqtp` use: + * `host`: It specifies groonga server's address. + * default: `localhost` + * `port`: It specifies groonga server's port number. + * default: `10041` +* For `command` use: + * `groonga`: It specifies path of groonga command. + * default: `groonga` + * `database`: It specifies path of groonga database. It is required. + * default: no default. + * `arguments`: It specifies additional arguments for groonga command. + * default: no additional arguments. + +Here is an example: + + <match groonga.command.*> + type groonga + protocol command + database /tmp/groonga/db + </match> -------------- next part -------------- HTML����������������������������...Download