rtty(中文)
A reverse proxy WebTTY. It is composed of the client and the server. The server is written in go language and uses the vue+iview. You can access any of your terminals through a web browser based on the device ID you set(If the ID is not set, the MAC address of the device is used).
rtty is very suitable for remote maintenance your or your company's thousands of Linux devices deployed around the world.
Keep Watching for More Actions on This Space
- Simple to deployment and easy to use
- Reverse Proxy
- Connect your device according to the ID you set up
- Fully-featured terminal based on Xterm.js
- SSL support: openssl, mbedtls, CyaSSl(wolfssl)
- Support upload file to device
- Support download file from devices
- Cross platform: macOS, Linux, FreeBSD/OpenBSD, OpenWrt/LEDE
- libubox - C utility functions for OpenWrt, but can also be used for the same purposes in other Linux systems. Reference
- libuwsc - A Lightweight and fully asynchronous WebSocket client C library based on libubox for Embedded Linux.
- ustream-ssl - If you need to support SSL
- mbedtls - If you choose mbedtls as your SSL backend
- CyaSSl(wolfssl) - If you choose wolfssl as your SSL backend
- openssl - If you choose openssl as your SSL backend
Install the GO language environment (if you haven't installed it)
sudo apt-get install golang # For Ubuntu
sudo yum install golang # For Centos
Set GOPATH environment variable(if you haven't set it)(since Go 1.8, default is $HOME/go)
export GOPATH=$HOME/go
Install rtty server
go get -u github.com/zhaojh329/rttys
Manual run
$GOPATH/bin/rttys -port 5912
Install the automatic boot script(debian/ubuntu)
cd $GOPATH/src/github.com/zhaojh329/rttys
sudo ./install.sh
sudo /etc/init.d/rttys start
Install build tools
sudo apt install gcc cmake git # For Ubuntu
yum install gcc cmake git # For Centos
Install dependent packages
sudo apt install libjson-c-dev # For Ubuntu
sudo apt install json-c-devel # For Centos
git clone https://git.openwrt.org/project/libubox.git
cd libubox && cmake -DBUILD_LUA=OFF . && sudo make install
git clone https://github.com/zhaojh329/libuwsc.git
cd libuwsc && cmake -DUWSC_SSL_SUPPORT=OFF . && sudo make install
Install RTTY
git clone https://github.com/zhaojh329/rtty.git
cd rtty && cmake . && sudo make install
Run RTTY Replace the following parameters with your own parameters
sudo rtty -I 'My-device-ID' -h 'your-server' -p 5912 -a -v -d 'My Device Description'
Query online devices
curl http://your-server:5912/devs
[{"id":"My-device-ID","description":"My device"}]
You need to cross compiling by yourself
Install
opkg update
opkg list | grep rtty
opkg install rtty-nossl
If the install command fails, you can compile it yourself.
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'
Save configuration and apply
uci commit
/etc/init.d/rtty restart
Query online devices: http://your-server-host:5912/devs
Use your web browser to access your server: http://your-server-host:5912, then enter the id of the terminal you want to access, and then click the connection button
You can easily embed RTTY into your existing platform: http://your-server-host:5912?id=your-id
Automatic login: http://your-server:5912/?id=device-id&username=device-username&password=device-password
If you would like to help making rtty better, see the CONTRIBUTING.md file.