Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Jianhui Zhao <[email protected]>
  • Loading branch information
Jianhui Zhao committed Mar 21, 2018
1 parent eb9519e commit 70be542
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 9 deletions.
4 changes: 2 additions & 2 deletions BUILDOPENWRT.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Select rtty in menuconfig and compile new image.

Utilities --->
Terminal --->
< > rtty-mbedtls............................ A reverse proxy WebTTY (mbedtls)
<*> rtty-nossl............................... A reverse proxy WebTTY (NO SSL)
<*> rtty-mbedtls............................ A reverse proxy WebTTY (mbedtls)
< > rtty-nossl............................... A reverse proxy WebTTY (NO SSL)
< > rtty-openssl............................ A reverse proxy WebTTY (openssl)
< > rtty-wolfssl............................ A reverse proxy WebTTY (wolfssl)
4 changes: 2 additions & 2 deletions BUILDOPENWRT_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Utilities --->
Terminal --->
< > rtty-mbedtls............................ A reverse proxy WebTTY (mbedtls)
<*> rtty-nossl............................... A reverse proxy WebTTY (NO SSL)
<*> rtty-mbedtls............................ A reverse proxy WebTTY (mbedtls)
< > rtty-nossl............................... A reverse proxy WebTTY (NO SSL)
< > rtty-openssl............................ A reverse proxy WebTTY (openssl)
< > rtty-wolfssl............................ A reverse proxy WebTTY (wolfssl)
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ rtty is very suitable for remote maintenance your or your company's thousands of
* Support upload file to device
* Support download file from devices
* Support Execute a command remote
* Cross platform: macOS, Linux, FreeBSD/OpenBSD, OpenWrt/LEDE
* Cross platform: Linux, OpenWrt/LEDE

![](/rtty.svg)
![](/rtty.gif)
Expand Down Expand Up @@ -160,7 +160,26 @@ Automatic login: `https://your-server:5912/?id=device-id&username=device-usernam
Open the context menu with the shortcut key: Ctrl+Shift+f

## Execute a command remote
`curl -k https://your-server:5912/cmd -d '{"devid":"test","username":"test","password":"123456","cmd":"ls","params":["/"],"env":[]}'`
### Shell

curl -k https://your-server:5912/cmd -d '{"devid":"test","username":"test","password":"123456","cmd":"ls","params":["/"],"env":[]}'

{"Err":0,"msg":"","code":0,"stdout":"bin\ndev\netc\nlib\nmnt\noverlay\nproc\nrom\nroot\nsbin\nsys\ntmp\nusr\nvar\nwww\n","stderr":""}

### Jquery

var data = {devid: 'test', username: 'test', password: '123456', cmd: 'ls', params: ['/'], env: []};
$.post('https://your-server:5912/cmd', JSON.stringify(data), function(r) {console.log(r)});


### Axios

var data = {devid: 'test', username: 'test', password: '123456', cmd: 'ls', params: ['/'], env: []};
axios.post('https://your-server:5912/cmd', JSON.stringify(data)).then(function (response) {
console.log(response.data);
}).catch(function (error) {
console.log(error);
});

# Contributing
If you would like to help making [rtty](https://github.com/zhaojh329/rtty) better,
Expand Down
23 changes: 21 additions & 2 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ rtty非常适合远程维护你的或者你公司的部署在全球各地的成
* 支持上传文件到设备
* 支持从设备下载文件
* 支持远程执行命令
* 跨平台: macOS, Linux, FreeBSD/OpenBSD, OpenWrt/LEDE
* 跨平台: macOS, Linux, OpenWrt/LEDE

![](/rtty.svg)
![](/rtty.gif)
Expand Down Expand Up @@ -152,7 +152,26 @@ rtty非常适合远程维护你的或者你公司的部署在全球各地的成
使用快捷键打开菜单: Ctrl+Shift+f

## 远程执行命令
`curl -k https://your-server:5912/cmd -d '{"devid":"test","username":"test","password":"123456","cmd":"ls","params":["/"],"env":[]}'`
### Shell

curl -k https://your-server:5912/cmd -d '{"devid":"test","username":"test","password":"123456","cmd":"ls","params":["/"],"env":[]}'

{"Err":0,"msg":"","code":0,"stdout":"bin\ndev\netc\nlib\nmnt\noverlay\nproc\nrom\nroot\nsbin\nsys\ntmp\nusr\nvar\nwww\n","stderr":""}

### Jquery

var data = {devid: 'test', username: 'test', password: '123456', cmd: 'ls', params: ['/'], env: []};
$.post('https://your-server:5912/cmd', JSON.stringify(data), function(r) {console.log(r)});


### Axios

var data = {devid: 'test', username: 'test', password: '123456', cmd: 'ls', params: ['/'], env: []};
axios.post('https://your-server:5912/cmd', JSON.stringify(data)).then(function (response) {
console.log(response.data);
}).catch(function (error) {
console.log(error);
});

# 贡献代码
如果你想帮助[rtty](https://github.com/zhaojh329/rtty)变得更好,请参考
Expand Down
Loading

0 comments on commit 70be542

Please sign in to comment.