diff --git a/doc/manuals/admin/build_source.md b/doc/manuals/admin/build_source.md index 639496f220..543ab6a3ef 100644 --- a/doc/manuals/admin/build_source.md +++ b/doc/manuals/admin/build_source.md @@ -11,6 +11,7 @@ The Orion Context Broker uses the following libraries as build dependencies: * libcurl: 7.19.7 * Mongo Driver: legacy-1.0.7 (from source) * rapidjson: 1.0.2 (from source) +* libwebsockets: 1.6.3 (from source) * gtest (only for `make unit_test` building target): 1.5 (from sources) * gmock (only for `make unit_test` building target): 1.5 (from sources) @@ -42,6 +43,17 @@ commands that require root privilege): tar xfvz v1.0.2.tar.gz sudo mv rapidjson-1.0.2/include/rapidjson/ /usr/local/include +* Install libwebsocket from sources: + + wget https://github.com/warmcat/libwebsockets/archive/v1.6.3.tar.gz + tar xfvz v1.6.3.tar.gz + cd libwebsockets-1.6.3/ + mkdir build + cd build + cmake .. # default cmake sets /usr/local as installation path + make + sudo make install + * Install libmicrohttpd from sources (the `./configure` command below shows the recommended build configuration to get minimum library footprint, but if you are an advanced user, you can configure as you prefer) wget http://ftp.gnu.org/gnu/libmicrohttpd/libmicrohttpd-0.9.48.tar.gz diff --git a/doc/manuals/user/README.md b/doc/manuals/user/README.md index d0eb1af03f..0bf0a8ca02 100644 --- a/doc/manuals/user/README.md +++ b/doc/manuals/user/README.md @@ -26,3 +26,4 @@ * [Security considerations](security.md) * [Known Limitations](known_limitations.md) * [Considerations on NGSIv1 and NGSIv2 coexistence](v1_v2_coexistence.md) + * [Websockets interface](websockets.md) (experimental) diff --git a/doc/websockets.md b/doc/manuals/user/websockets.md similarity index 96% rename from doc/websockets.md rename to doc/manuals/user/websockets.md index 78c02920cf..f2efe6d03f 100644 --- a/doc/websockets.md +++ b/doc/manuals/user/websockets.md @@ -1,5 +1,7 @@ # Websockets interface +**This is yet experimental functionality. Usage feedback is highly welcomed, but don't rely on it for production, as changes are expected.** + ## What is this? The websockets interface is a new way to communicate with Orion using websockets, this is point to improve the comunication with a faster and more efficient protocol, because now we have a persistent connection with an open socket. Also websockets are a way of easing the interaction between Orion and client applications running in browsers and smartphone. diff --git a/mkdocs.yml b/mkdocs.yml index 96d48fb765..4540f2c104 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,6 +35,7 @@ pages: - 'Forbidden characters': 'user/forbidden_characters.md' - 'Docker': 'user/docker.md' - 'Considerations on NGSIv1 and NGSIv2 coexistence': 'user/v1_v2_coexistence.md' + - 'Websockets interface (experimental)': 'user/websockets.md' - 'Installation & Administration Manual': - 'Introduction': 'admin/index.md' - 'Installing Orion': 'admin/install.md'