Merge pull request #17 from deflinhec/develop

Develop

Author: deflinhec

.gitignore

@@ -1,5 +1,6 @@
 /.vscode/*
 /build/*
+/cmake/httplib/*
 /include/*
 /lib/*
-/bin/*
+/bin/*

CMakeLists.txt

@@ -39,9 +39,13 @@ option(${PROJECT_NAME}_BUILD_BENCHMARK_TESTS "Build benchmark" ON)
 
 set(SERVER_SOURCES
 	${CMAKE_CURRENT_SOURCE_DIR}/src/gsx2json.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/cache.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/utils.cpp
 )
 set(SERVER_HEADERS
 	${CMAKE_CURRENT_SOURCE_DIR}/src/gsx2json.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/cache.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/utils.h
 )
 set(RESOURCE_FILES
     cpp-httplib/example/ca-bundle.crt

Dockerfile

@@ -9,12 +9,14 @@ RUN apk --no-cache add bash \
 	zlib-dev \
     supervisor
 
-ENV CC=gcc CXX=g++ TZ=Asia/Taipei
-EXPOSE 8080
-
 COPY . /project
 WORKDIR /project
-RUN /bin/bash scripts/build.sh Release
+RUN export CC=gcc CXX=g++ && \
+    /bin/bash scripts/build.sh Release
+
+EXPOSE 8080
+ENV TZ=Asia/Taipei \
+    ARGUMENTS="--host 0.0.0.0"
 
 COPY supervisor.conf /etc/supervisor.conf
 CMD ["supervisord", "-c", "/etc/supervisor.conf"]

README.md

@@ -28,7 +28,10 @@ In this example below I'm going to use `5000` as port, and output log file under
     ```
     
     ```
-    docker run -it -d -p 5000:8080 -v bin/volume:/workspace --name gsx2jsonpp-latest deflinhec/gsx2jsonpp
+    docker run -it -d --expose 5000 \
+    -v ${PWD}/bin/volume:/workspace \
+    -e ARGUMENTS="--host 0.0.0.0 --port 5000" \
+    --name gsx2jsonpp-latest deflinhec/gsx2jsonpp
     ```
 
 - Launch with a local image
@@ -40,9 +43,28 @@ In this example below I'm going to use `5000` as port, and output log file under
     ```
     
     ```
-    docker run -it -d -p 5000:8080 -v bin/volume:/workspace --name gsx2jsonpp gsx2jsonpp
+    docker run -it -d --expose 5000 \ 
+    -v ${PWD}/bin/volume:/workspace \
+    -e ARGUMENTS="--host 0.0.0.0 --port 5000" \
+    --name gsx2jsonpp gsx2jsonpp
     ```
 
+    Avaliable arguments: 
+    - -p, --port
+    - --host 
+
+    - --cache (file|memory)
+
+      Cache mode is disabled by default, this feature allows client
+      to query on specific data version. When cache is configure with
+      file mode, cache file will be preserve under 'cache/' folder. 
+
+    - --ssl (true|false)
+
+      SSL mode is disabled by default, if you prefer using SSL mode
+      with your certification and private key. Copy your files into
+      `${PWD}/bin/volume` and rename as `cert.pem, key.pem`.
+
 After launched, Gsx2Jsonpp should be accessable in your browser [localhost:5000](http://localhost:5000/hi).
 
 Supervisor have been setup within the container to guarantee an auto restart after accidentially crashed(hopefully not).
@@ -222,3 +244,5 @@ There are four sections to the returned data.
 
 - :white_check_mark: md5 checksum
 
+- :white_check_mark: cache
+