extract quickstart doc

docker198 · Jan 17, 2017 · acd0fe8 · acd0fe8
1 parent 112584a
commit acd0fe8
Show file tree

Hide file tree

Showing 8 changed files with 232 additions and 224 deletions.
diff --git a/hustdb/doc/doc/en/index.md b/hustdb/doc/doc/en/index.md
@@ -5,7 +5,6 @@ Index
 ==
 
 * [Intro](intro/index.md)
-* [Guide](guide/index.md)
 * [API manual](api/index.md)
     * [`hustdb`](api/hustdb.md)
     * [`hustdb ha`](api/ha.md)

diff --git a/hustdb/doc/doc/zh/index.md b/hustdb/doc/doc/zh/index.md
@@ -5,7 +5,6 @@ hustdb
 ==
 
 * [简介](intro/index.md)
-* [快速入门](guide/index.md)
 * [API 手册](api/index.md)
     * [`hustdb`](api/hustdb.md)
     * [`hustdb ha`](api/ha.md)

diff --git a/hustmq/doc/doc/en/guide/index.md b/hustmq/doc/doc/en/guide/index.md
diff --git a/hustmq/doc/doc/en/index.md b/hustmq/doc/doc/en/index.md
@@ -7,7 +7,6 @@ Index
 * [Intro](intro/index.md)
     * [`hustmq`](intro/hustmq.md)
     * [`hustmq ha`](intro/ha.md)
-* [Guide](guide/index.md)
 * [API manual](api/index.md)
     * [`hustmq`](api/hustmq.md)
     * [`hustmq ha`](api/ha.md)

diff --git a/hustmq/doc/doc/zh/guide/index.md b/hustmq/doc/doc/zh/guide/index.md
diff --git a/hustmq/doc/doc/zh/index.md b/hustmq/doc/doc/zh/index.md
@@ -7,7 +7,6 @@ hustmq
 * [简介](intro/index.md)
     * [`hustmq`](intro/hustmq.md)
     * [`hustmq ha`](intro/ha.md)
-* [快速入门](guide/index.md)
 * [API 手册](api/index.md)
     * [`hustmq`](api/hustmq.md)
     * [`hustmq ha`](api/ha.md)

diff --git a/hustdb/doc/doc/en/guide/index.md → quickstart.md b/hustdb/doc/doc/en/guide/index.md → quickstart.md
@@ -1,7 +1,11 @@
-Quick Introduction
---
+<h1 id="id_top">Quick Start</h1>
 
-### hustdb ###
+* [HustDB](#id_hustdb)  
+* [HustDB HA](#id_hustdbha)  
+* [HustMQ](#id_hustmq)  
+* [HustMQ HA](#id_hustmqha)  
+
+<h2 id="id_hustdb">HustDB</h2>
 
 Install `hustdb`(need sudo, used for libsnappy, libevhtp, libevent2.0): 
 
@@ -35,9 +39,11 @@ The result shows that the servers work as expected.
 
 For detailed deployment and configuration, please check:
 
-* [hustdb configuration](../advanced/hustdb.md)
+* [hustdb configuration](hustdb/doc/doc/en/advanced/hustdb.md)
+
+[Back to top](#id_top)
 
-### hustdb ha ###
+<h2 id="id_hustdbha">HustDB HA</h2>
 
 First, install all the dependent common modules for `hustdb ha`:  
 
@@ -129,9 +135,109 @@ The result shows that the servers work as expected.
 
 For detailed deployment and configuration, please check:
 
-* [hustdb ha deployment](../advanced/ha/deploy.md)
-* [hustdb ha configuration](../advanced/ha/nginx.md)
-* [hustdb ha load balance table configuration](../advanced/ha/table.md)
-* [hustdb ha log configuration](../advanced/ha/zlog.md)
+* [hustdb ha deployment](hustdb/doc/doc/en/advanced/ha/deploy.md)
+* [hustdb ha configuration](hustdb/doc/doc/en/advanced/ha/nginx.md)
+* [hustdb ha load balance table configuration](hustdb/doc/doc/en/advanced/ha/table.md)
+* [hustdb ha log configuration](hustdb/doc/doc/en/advanced/ha/zlog.md)
+
+[Back to top](#id_top)
+
+<h2 id="id_hustmq">HustMQ</h2>
+
+Install `hustdb`(need sudo, used for libsnappy, libevhtp, libevent2.0): 
+
+    $ cd hustdb/db/server/make/linux/
+    $ sh build.sh
+
+Target path
+
+* `hustdb/db/server/make/linux/hustdb`
+* `hustdb/db/server/make/linux/hustdb.conf`
+
+Start service
+
+    $ cd hustdb/db/server/make/linux/
+    $ ./hustdb
+
+Type in the below command to test:
+
+    curl -i -X GET 'localhost:8085/status.html'
+
+Infomation returned:
+
+    HTTP/1.1 200 OK
+	Content-Length: 3
+	Content-Type: text/plain
+
+	ok
+
+The result shows that the servers work as expected.
+
+For detailed deployment and configuration, please check:
+
+* [hustmq configuration](hustmq/doc/doc/en/advanced/hustmq/index.md)
+
+[Back to top](#id_top)
+
+<h2 id="id_hustmqha">HustMQ HA</h2>
+
+Install `pcre`：
+
+    sudo yum install -y pcre-devel
+
+Open the configuration:  
+
+    $ cd hustmq/ha/nginx/conf/
+    $ vi nginx.json
+
+**Replace `backends` to your real `hustdb` machine list, at least one is required:**
+
+    {
+        ......
+        "proxy":
+        {
+            ......
+            "backends": ["192.168.1.101:9999"],
+            ......
+        }
+    }
+
+Run `genconf.py` to generate `nginx.conf`:
+
+    $ python genconf.py
+
+After configuration, install `hustmq ha`:
+
+    $ cd hustmq/ha/nginx
+    $ sh Config.sh
+    $ make -j
+    $ make install
+
+Start nginx:
+
+    $ export LD_LIBRARY_PATH=/opt/huststore/3rd/lib
+    $ /opt/huststore/hustmqha/sbin/nginx
+
+Input the following test command:
+
+    curl -i -X GET 'localhost:8080/version'
+
+Then server will output the following information:
+
+    HTTP/1.1 200 OK
+    Server: nginx/1.10.0
+    Date: Fri, 16 Dec 2016 10:54:47 GMT
+    Content-Type: text/plain
+    Content-Length: 13
+    Connection: keep-alive
+
+    hustmqha 1.6
+
+Server works just fine if the above result is returned.
+
+For detailed deployment and configuration, please check:
+
+* [hustmq ha configuration](hustmq/doc/doc/en/advanced/ha/nginx.md)
+* [hustmq ha deployment](hustmq/doc/doc/en/advanced/ha/deploy.md)
 
-[Home](../index.md)
+[Back to top](#id_top)