dany/antd-tunnel-plugin
1
0
Fork 0
mirror of https://github.com/lxsang/antd-tunnel-plugin synced 2024-11-16 01:38:22 +01:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Xuan Sang LE 2021-01-31 18:14:43 +01:00 committed by GitHub
parent 84f2b586ce
commit 61f4dec7f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,45 +1,33 @@
# antd-wterm-plugin
**wterm** is an [antd plugin](https://github.com/lxsang/ant-http) providing the Terminal gateway to the web using websocket.
# antd-tunnel-plugin
**tunnel** is an [antd plugin](https://github.com/lxsang/ant-http) providing a generic purpose publish/subscribe message protocol using a single websocket connection.
## Build from source
As **wterm** is an **Antd's** plugin, the server must be pre-installed
As **tunnel** is an **Antd's** plugin, the server must be pre-installed
### build dep
* git
* make
* build-essential
* ant-http (libantd.so)
### build
When all dependencies are installed, the build can be done with a few single command lines:
```bash
mkdir antd
cd antd
mkdir tunnel
cd tunnel
# replace x.x.x by a version number
wget -O- https://get.bitdojo.dev/antd_plugin | bash -s "wterm-x.x.x"
wget -O- https://get.iohub.dev/antd_plugin | bash -s "tunnel-x.x.x"
# or install from a tarball distribution in dist/
tar xvzf wterm-x.x.x.tar.gz
cd wterm-x.x.x
tar xvzf tunnel-x.x.x.tar.gz
cd tunnel-x.x.x
./configure --prefix=/opt/www --enable-debug=yes
make
sudo make install
```
## Run
To run the Antd server with the **wterm** plugin:
```sh
/path/to/your/build/antd
```
Web applications can be put on **/path/to/your/build/htdocs**, the web socket to **wterm** is available at:
```
ws://your_host:your_port/wterm
```
This websocket address can be used with [xterm.js](https://xtermjs.org) to provide web based termnial access
### Generate distribution
```sh
libtoolize
@ -47,4 +35,4 @@ aclocal
autoconf
automake --add-missing
make distcheck
```
```