From 48578a07d4e5ec57066b043720fbcfeb865dc3c8 Mon Sep 17 00:00:00 2001 From: Jianhui Zhao Date: Wed, 13 Jun 2018 21:08:50 +0800 Subject: [PATCH] Update README Signed-off-by: Jianhui Zhao --- BUILDOPENWRT.md | 13 ------------ BUILDOPENWRT_ZH.md | 13 ------------ OPENWRT.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++ OPENWRT_ZH.md | 51 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 34 +----------------------------- README_ZH.md | 29 +------------------------- 6 files changed, 105 insertions(+), 87 deletions(-) delete mode 100644 BUILDOPENWRT.md delete mode 100644 BUILDOPENWRT_ZH.md create mode 100644 OPENWRT.md create mode 100644 OPENWRT_ZH.md diff --git a/BUILDOPENWRT.md b/BUILDOPENWRT.md deleted file mode 100644 index 5d7f67c..0000000 --- a/BUILDOPENWRT.md +++ /dev/null @@ -1,13 +0,0 @@ -Update feeds - - ./scripts/feeds update -a - ./scripts/feeds install -a - -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-openssl............................ A reverse proxy WebTTY (openssl) - < > rtty-wolfssl............................ A reverse proxy WebTTY (wolfssl) diff --git a/BUILDOPENWRT_ZH.md b/BUILDOPENWRT_ZH.md deleted file mode 100644 index b5202a9..0000000 --- a/BUILDOPENWRT_ZH.md +++ /dev/null @@ -1,13 +0,0 @@ -更新feeds: - - ./scripts/feeds update -a - ./scripts/feeds install -a - -在menuconfig中选择rtty，然后重新编译固件。 - - Utilities ---> - Terminal ---> - <*> 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) diff --git a/OPENWRT.md b/OPENWRT.md new file mode 100644 index 0000000..e098535 --- /dev/null +++ b/OPENWRT.md @@ -0,0 +1,52 @@ +# Install directly inside the device + + opkg update + opkg list | grep rtty + opkg install rtty-nossl + +# Compile it yourself +## For Openwrt master +Update feeds + + ./scripts/feeds update -a + ./scripts/feeds install -a + +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-openssl............................ A reverse proxy WebTTY (openssl) + < > rtty-wolfssl............................ A reverse proxy WebTTY (wolfssl) + +## [For Openwrt 14.04](https://github.com/zhaojh329/rtty/blob/openwrt-14.04/README.md) + +## [For Openwrt 15.05](https://github.com/zhaojh329/rtty/blob/openwrt-15.05/README.md) + +## [For Lede](https://github.com/zhaojh329/rtty/blob/openwrt-lede/README.md) + +# Configure +Configuring the server parameter + + uci add rtty rtty # If it is configured for the first time + uci set rtty.@rtty[0].host='your server host' + uci set rtty.@rtty[0].port='your server port' + +You can customize an ID for your device. If the ID is not configured, RTTY will use +the MAC address of the specified network interface as the ID. + + uci set rtty.@rtty[0].id='your-device-id' + +You can add a description to your device + + uci set rtty.@rtty[0].description='My device' + +Use SSL + + uci set rtty.@rtty[0].ssl='1' + +Save configuration and apply + + uci commit + /etc/init.d/rtty restart \ No newline at end of file diff --git a/OPENWRT_ZH.md b/OPENWRT_ZH.md new file mode 100644 index 0000000..3452678 --- /dev/null +++ b/OPENWRT_ZH.md @@ -0,0 +1,51 @@ +# 直接在设备里面安装 + + opkg update + opkg list | grep rtty + opkg install rtty-nossl + +# 自己编译 +## Openwrt master +更新feeds: + + ./scripts/feeds update -a + ./scripts/feeds install -a + +在menuconfig中选择rtty，然后重新编译固件。 + + Utilities ---> + Terminal ---> + <*> 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) + +## [Openwrt 14.04](https://github.com/zhaojh329/rtty/blob/openwrt-14.04/README.md) + +## [Openwrt 15.05](https://github.com/zhaojh329/rtty/blob/openwrt-15.05/README.md) + +## [Lede](https://github.com/zhaojh329/rtty/blob/openwrt-lede/README.md) + +# 配置 +配置服务器参数 + + uci add rtty rtty # 如果是第一次配置 + uci set rtty.@rtty[0].host='your server host' + uci set rtty.@rtty[0].port='your server port' + +你可以给你的设备自定义一个ID。如果未指定，RTTY将使用指定的网络接口的MAC地址作为其ID + + uci set rtty.@rtty[0].id='your-device-id' + +给你的设备添加一个描述 + + uci set rtty.@rtty[0].description='My device' + +使用SSL + + uci set rtty.@rtty[0].ssl='1' + +保存配置并应用 + + uci commit + /etc/init.d/rtty restart \ No newline at end of file diff --git a/README.md b/README.md index 3d5eaed..37efa3f 100644 --- a/README.md +++ b/README.md @@ -80,39 +80,7 @@ Run RTTY(Replace the following parameters with your own parameters) ## For Embedded Linux Platform You need to cross compiling by yourself -## For OpenWRT -Install - - opkg update - opkg list | grep rtty - opkg install rtty-nossl - -If the install command fails, you can [compile it yourself](/BUILDOPENWRT.md). - -Configuring the server parameter - - uci add rtty rtty # If it's the first configuration - uci set rtty.@rtty[0].host='your server host' - uci set rtty.@rtty[0].port='your server port' - -You can customize an ID for your device. If the ID is not configured, RTTY will use -the MAC address of the specified network interface as the ID. -The format of the MAC address as the ID is: 1A2A3A4A5A6A - - uci set rtty.@rtty[0].id='your-device-id' - -You can add a description to your device - - uci set rtty.@rtty[0].description='My device' - -Use SSL - - uci set rtty.@rtty[0].ssl='1' - -Save configuration and apply - - uci commit - /etc/init.d/rtty restart +## [For OpenWRT](/OPENWRT.md) # Usage Use your web browser to access your server: `https://your-server-host:5912`, then click the connection button diff --git a/README_ZH.md b/README_ZH.md index 359d2ce..01321b3 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -77,34 +77,7 @@ rtty非常适合远程维护你的或者你公司的部署在全球各地的成 ## 嵌入式Linux平台 你需要自行交叉编译 -## 如何在OpenWRT中使用 -安装 - - opkg update - opkg list | grep rtty - opkg install rtty-nossl - -如果安装失败，你可以[自己编译](/BUILDOPENWRT_ZH.md)。 - -配置服务器参数 - - uci add rtty rtty # If it's the first configuration - uci set rtty.@rtty[0].host='your server host' - uci set rtty.@rtty[0].port='your server port' - -你可以给你的设备自定义一个ID。如果未指定，RTTY将使用指定的网络接口的MAC地址作为其ID， -以MAC地址作为ID的格式为：1A2A3A4A5A6A - - uci set rtty.@rtty[0].id='your-device-id' - -使用SSL - - uci set rtty.@rtty[0].ssl='1' - -保存配置并应用 - - uci commit - /etc/init.d/rtty restart +## [如何在OpenWRT中使用](/OPENWRT_ZH.md) # 如何使用 使用你的Web浏览器访问你的服务器: `https://your-server-host:5912`，然后点击连接按钮。