[Groonga-commit] droonga/droonga-http-server at 591bea1 [master] Add README

Back to archive index

YUKI Hiroshi null+****@clear*****
Fri Mar 28 16:30:08 JST 2014


YUKI Hiroshi	2014-03-28 16:30:08 +0900 (Fri, 28 Mar 2014)

  New Revision: 591bea1ac94bd1b0bef007caa65ef98214ea8d49
  https://github.com/droonga/droonga-http-server/commit/591bea1ac94bd1b0bef007caa65ef98214ea8d49

  Message:
    Add README

  Added files:
    README.md

  Added: README.md (+36 -0) 100644
===================================================================
--- /dev/null
+++ README.md    2014-03-28 16:30:08 +0900 (7cfca91)
@@ -0,0 +1,36 @@
+# README
+
+This is an HTTP Protocol Adapter for the Droonga Engine.
+
+## Usage
+
+### Server
+
+If both this and fluentd are running on the same machine,
+you can run this easily.
+
+    $ npm install -g droonga-http-server
+    $ droonga-http-server
+
+Otherwise, you have to specify pairs of host and port to send messages
+to the fluentd and to receive messages from the fluentd.
+
+    $ droonga-http-server \
+        --droonga-engine-host-name "backend.droonga.example.org" \
+        --droonga-engine-port 24224 \
+        --receive-host-name "frontend.droonga.example.org"
+
+### Client
+
+Frontend applications can call HTTP APIs to access resources stored in
+the droonga. For example:
+
+    GET /droonga/tables/entries?query=foobar HTTP/1.1
+
+It works as a search request, and a JSON string will be returned as the result.
+
+## License
+
+The MIT License. See LICENSE for details.
+
+Copyright (c) 2014 Droonga project
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index