From d5833aa7af121a75735ba7bf87d5136a27680662 Mon Sep 17 00:00:00 2001 From: Xuan Sang LE Date: Sat, 22 Sep 2018 19:06:51 +0200 Subject: [PATCH] Update README.md --- README.md | 42 +++++++++++++++++++++++++++++++++++++----- 1 file changed, 37 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4e27d56..12e50b0 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,49 @@ # antd-wvnc-plugin -An [Antd HTTP/HTTPS server's](https://github.com/lxsang/ant-http) plugin that acts as a bridge between a VNC server and web applications. It allows web application to communicate with VNC server using web socket via a predefined protocol and message format. +An [Antd HTTP/HTTPS server's](https://github.com/lxsang/ant-http) plugin that acts as a bridge between a VNC server and web applications. It allows web application to communicate with VNC server using web socket via a predefined protocol and message format. Web application can use my dedicate javascript library called [**wvnc.js**](https://github.com/lxsang/wvnc.js) to communicate with the VNC server using the plugin. To speed up the data transmission, **WVNC** uses **libjpeg** and **zlib** for data compression. ## Demo A demo will soon be available -## Dependencies -* ANTD: As **WVNC** is an **Antd** plugin, it need to be built using the server build system +## Build from source +ANTD: As **WVNC** is an **Antd** plugin, it need to be built along with the server. This require the following application/libraries to be pre installed: + +### build dep +* git +* make +* build-essential + +### server dependencies +* libssl-dev +* libsqlite3-dev + +### Plugin Dependencies * Zlib * libjpeg-turbo +* libvncserver-dev -## Build +### build +When all dependencies are isntalled, the build can be done with a few single command lines: -A build script will soon be available +```bash +mkdir antd +cd antd +wget -O - https://apps.lxsang.me/script/antd | bash -s "wvnc" +``` +The script will ask you where you want to put the binaries (should be an absolute path, otherwise the build will fail) and the default HTTP port for the server config. + +## Run +To run the Antd server with the **wvnc** plugin: +```sh +/path/to/your/build/antd +``` + +Web applications can be put on **/path/to/your/build/htdocs**, the web socket to **wvnc** is available at: +``` +ws://your_host:your_port/wvnc +``` +This websocket address can be used with my client side javascript library [**wvnc.js**](https://github.com/lxsang/wvnc.js) to develop web based VNC client + +``