yan/archived-rtty
1
0
Fork 0
mirror of https://github.com/zhaojh329/rtty.git synced 2026-02-27 09:53:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source 
Signed-off-by: Jianhui Zhao <zhaojh329@gmail.com>
This commit is contained in:
Jianhui Zhao
2025-07-11 11:43:45 +08:00
parent ed517b97bb
commit 502fc1c064
2 changed files with 152 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
README.md
View File

@@ -1,6 +1,8 @@
# rtty([中文](/README_ZH.md)) # rtty ([中文](/README_ZH.md)) - Access your device's terminal from anywhere via the web
**This project is officially supported by [GL.iNet](https://github.com/gl-inet).** **Official Website:** https://rttys.net/
**This project is officially supported by [GL.iNet](https://www.gl-inet.com).**
[1]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=plastic [1]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=plastic
[2]: /LICENSE [2]: /LICENSE
@@ -33,57 +35,88 @@
[vue]: https://github.com/vuejs/vue [vue]: https://github.com/vuejs/vue
[server]: https://github.com/zhaojh329/rttys [server]: https://github.com/zhaojh329/rttys
## Architecture
```mermaid ```mermaid
flowchart TB flowchart TB
s[rttys with public IP address] s[rttys with public IP address]
u1["User(Web Browser)"] --> s u1["User (Web Browser)"] --> s
u2["User(Web Browser)"] --> s u2["User (Web Browser)"] --> s
u3["User(Web Browser)"] --> s u3["User (Web Browser)"] --> s
s --> c1["rtty(Linux Device)"] s --> c1["rtty (Linux Device)"]
s --> c2["rtty(Linux Device)"] s --> c2["rtty (Linux Device)"]
s --> c3["rtty(Linux Device)"] s --> c3["rtty (Linux Device)"]
``` ```
![](/img/terminal.gif) ![](/img/terminal.gif)
![](/img/file.gif) ![](/img/file.gif)
![](/img/web.gif) ![](/img/web.gif)
It is composed of a client and a [server]. The client is written in pure C. The [server] is written in go language ## Overview
and the front-end is written in [Vue].
You can access your device's terminal from anywhere via the web. Distinguish your different device by device ID. rtty is a powerful remote terminal solution composed of a client and a [server]. The client is written in pure C for optimal performance and minimal footprint. The [server] is implemented in Go with a modern frontend built using [Vue].
rtty is very suitable for remote maintenance your or your company's thousands of Linux devices deployed around Access your device's terminal from anywhere via a web browser. Distinguish between different devices using unique device IDs.
the world.
## Features rtty is exceptionally well-suited for remote maintenance of thousands of Linux devices deployed worldwide, making it an ideal choice for organizations managing distributed infrastructure.
* The client is writen in C language, very small, suitable for embedded Linux
- No SSL: rtty(32K) + libev(56K)
- Support SSL: + libmbedtls(88K) + libmbedcrypto(241K) + libmbedx509(48k)
* Execute command remotely in a batch of devices
* SSL support: openssl, mbedtls, CyaSSl(wolfssl)
* mTLS
* Very convenient to upload and download files
* Access different devices based on device ID
* Support HTTP Proxy - Access your device's Web
* Fully-featured terminal based on [Xterm.js]
* Simple to deployment and easy to use
## Who's using rtty ## Key Features
- [GL.iNet](https://www.gl-inet.com/)
- [Yunlianxin Technology](http://www.iyunlink.com/)
- [One IOT World](https://www.oneiotworld.com/)
- [bitswrt Communication Technology](http://bitswrt.com/)
- [Guangzhou Lingpai Technology](https://linkpi.cn/)
- ...
## Dependencies of the Client side ### 🚀 **Lightweight & Efficient**
* [libev] - A full-featured and high-performance event loop - **Minimal footprint**: Client written in pure C, perfect for embedded Linux
* [mbedtls(polarssl)] or [CyaSSl(wolfssl)] or [openssl] - If you want to support SSL - **Without SSL**: rtty (32KB) + libev (56KB)
- **With SSL**: + libmbedtls (88KB) + libmbedcrypto (241KB) + libmbedx509 (48KB)
### 🔐 **Security**
- **Multiple SSL backends**: [OpenSSL], [mbedtls(polarssl)], [CyaSSl(wolfssl)]
- **mTLS support** for mutual authentication
### 🌐 **Advanced Remote Management**
- **Batch command execution** across multiple devices remotely
- **Device identification** based on unique device IDs
- **HTTP Proxy support** for accessing device web interfaces
### 📁 **File Management**
- **Seamless file transfer**: Convenient upload and download capabilities
- **Web-based interface** for intuitive file operations
### 💻 **Modern Terminal Experience**
- **Full-featured terminal** powered by [Xterm.js]
- **Browser-based access** from anywhere
### ⚡ **Deployment & Usability**
- **Simple deployment** process
- **Easy to use** interface
- **Cross-platform compatibility**
## Production Users
Trusted by leading technology companies:
- **[GL.iNet](https://www.gl-inet.com/)**
- **[Yunlianxin Technology](http://www.iyunlink.com/)**
- **[One IOT World](https://www.oneiotworld.com/)**
- **[bitswrt Communication Technology](http://bitswrt.com/)**
- **[Guangzhou Lingpai Technology](https://linkpi.cn/)**
- *...and many more*
## Client Dependencies
### Required
- **[libev]** - High-performance event loop library
### Optional (for SSL support)
Choose one of the following SSL libraries:
- **[mbedtls(polarssl)]** - Lightweight SSL/TLS library
- **[CyaSSl(wolfssl)]** - Embedded SSL/TLS library
- **[openssl]** - Full-featured SSL/TLS toolkit
## ⭐ Star History
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=zhaojh329/rtty&type=Date)](https://www.star-history.com/#zhaojh329/rtty&Date) [![Star History Chart](https://api.star-history.com/svg?repos=zhaojh329/rtty&type=Date)](https://www.star-history.com/#zhaojh329/rtty&Date)
## Contributing ## 🤝 Contributing
If you would like to help making [rtty](https://github.com/zhaojh329/rtty) better,
see the [CONTRIBUTING.md](https://github.com/zhaojh329/rtty/blob/master/CONTRIBUTING.md) file. Help us make [rtty](https://github.com/zhaojh329/rtty) even better!
See the [CONTRIBUTING.md](https://github.com/zhaojh329/rtty/blob/master/CONTRIBUTING.md) file for detailed guidelines on how to contribute to this project.

117
README_ZH.md
View File

@@ -1,4 +1,8 @@
# rtty - 在任何地方通过Web访问您的设备的终端 # rtty - 在任何地方通过Web访问您的设备终端
**官方网站：** https://rttys.net/
**本项目由 [GL.iNet](https://www.gl-inet.com) 官方支持。**
[1]: https://img.shields.io/badge/开源协议-MIT-brightgreen.svg?style=plastic [1]: https://img.shields.io/badge/开源协议-MIT-brightgreen.svg?style=plastic
[2]: /LICENSE [2]: /LICENSE
@@ -34,57 +38,96 @@
[vue]: https://github.com/vuejs/vue [vue]: https://github.com/vuejs/vue
[服务端]: https://github.com/zhaojh329/rttys [服务端]: https://github.com/zhaojh329/rttys
## 系统架构
```mermaid ```mermaid
flowchart TB flowchart TB
s[rttys with public IP address] s[rttys 服务器（公网IP）]
u1["User(Web Browser)"] --> s u1["用户（Web浏览器）"] --> s
u2["User(Web Browser)"] --> s u2["用户（Web浏览器）"] --> s
u3["User(Web Browser)"] --> s u3["用户（Web浏览器）"] --> s
s --> c1["rtty(Linux Device)"] s --> c1["rtty（Linux设备）"]
s --> c2["rtty(Linux Device)"] s --> c2["rtty（Linux设备）"]
s --> c3["rtty(Linux Device)"] s --> c3["rtty（Linux设备）"]
``` ```
![](/img/terminal.gif) ![](/img/terminal.gif)
![](/img/file.gif) ![](/img/file.gif)
![](/img/web.gif) ![](/img/web.gif)
它由客户端和[服务端]组成。客户端采用纯C实现。[服务端]采用GO语言实现，前端界面采用[vue]实现。 ## 产品概述
您可以在任何地方通过Web访问您的设备的终端。通过设备ID来区分您的不同的设备。 rtty 是一套强大的远程终端解决方案，由客户端和[服务端]组成。客户端采用纯C语言实现，具有极佳的性能和最小的资源占用。[服务端]采用Go语言实现，前端界面基于[Vue]框架构建。
rtty非常适合远程维护您的或者您的公司的部署在全球各地的成千上万的Linux设备。 您可以在任何地方通过Web浏览器访问设备终端，通过独特的设备ID来区分和管理不同的设备。
## 特性 rtty 特别适合远程维护部署在全球各地的成千上万台Linux设备，是企业级分布式设备管理的理想选择。
* 客户端 C 语言实现，非常小，适合嵌入式 Linux
- 不支持 SSL: rtty(32K) + libev(56K)
- 支持 SSL: + libmbedtls(88K) + libmbedcrypto(241K) + libmbedx509(48k)
* 远程批量执行命令
* 支持SSL: openssl, mbedtls, CyaSSl(wolfssl)
* SSL 双向认证(mTLS)
* 非常方便的上传和下载文件
* 根据设备ID访问不同的设备
* 支持 HTTP 代理 - 访问您的设备的 Web
* 基于[Xterm.js]的全功能终端
* 部署简单，使用方便
## 谁在使用 rtty ## 核心特性
- [深圳市广联智通科技有限公司](https://www.gl-inet.com/)
- [深圳市云联芯科技有限公司](http://www.iyunlink.com/) ### 🚀 **轻量高效**
- [成都四海万联科技有限公司](https://www.oneiotworld.com/) - **极小占用**：客户端采用纯C语言实现，专为嵌入式Linux优化
- [bitswrt Communication Technology](http://bitswrt.com/) - **无SSL版本**：rtty(32KB) + libev(56KB)
- [广州灵派科技有限公司](https://linkpi.cn/) - **SSL版本**：+ libmbedtls(88KB) + libmbedcrypto(241KB) + libmbedx509(48KB)
- ...
### 🔐 **安全**
- **多SSL后端支持**：[OpenSSL]、[mbedtls(polarssl)]、[CyaSSl(wolfssl)]
- **双向SSL认证(mTLS)**：提供相互身份验证
### 🌐 **高级远程管理**
- **批量命令执行**：跨多设备远程批量操作
- **设备ID识别**：基于唯一设备ID进行设备区分
- **HTTP代理支持**：访问设备的Web管理界面
### 📁 **文件管理**
- **无缝文件传输**：便捷的上传和下载功能
- **Web界面操作**：直观的文件管理体验
### 💻 **现代终端体验**
- **全功能终端**：基于[Xterm.js]的完整终端体验
- **浏览器访问**：随时随地的设备访问能力
### ⚡ **部署使用**
- **简单部署**：快速搭建过程
- **易于使用**：直观的操作界面
- **跨平台兼容**：广泛的平台支持
## 生产用户
已获得知名技术企业信赖：
- **[深圳市广联智通科技有限公司](https://www.gl-inet.com/)**
- **[深圳市云联芯科技有限公司](http://www.iyunlink.com/)**
- **[成都四海万联科技有限公司](https://www.oneiotworld.com/)**
- **[bitswrt Communication Technology](http://bitswrt.com/)**
- **[广州灵派科技有限公司](https://linkpi.cn/)**
- *...以及更多企业*
## 客户端依赖 ## 客户端依赖
* [libev] - 高性能的事件循环库
* [mbedtls(polarssl)]、[CyaSSl(wolfssl)]或者[openssl] - 如果您需要支持SSL
## Star History ### 必需组件
- **[libev]** - 高性能事件循环库
### 可选组件（SSL支持）
选择以下SSL库之一：
- **[mbedtls(polarssl)]** - 轻量级SSL/TLS库
- **[CyaSSl(wolfssl)]** - 嵌入式SSL/TLS库
- **[openssl]** - 全功能SSL/TLS工具包
## ⭐ Star历史
[![Star History Chart](https://api.star-history.com/svg?repos=zhaojh329/rtty&type=Date)](https://www.star-history.com/#zhaojh329/rtty&Date) [![Star History Chart](https://api.star-history.com/svg?repos=zhaojh329/rtty&type=Date)](https://www.star-history.com/#zhaojh329/rtty&Date)
## 贡献代码 ## 🤝 贡献代码
如果您想帮助 rtty 变得更好，请参考 [CONTRIBUTING_ZH.md](/CONTRIBUTING_ZH.md)。
## 强烈推荐佐大的 OpenWrt 培训班 欢迎帮助[rtty](https://github.com/zhaojh329/rtty)变得更加完善！
想学习 OpenWrt 开发，但是摸不着门道？自学没毅力？基础太差？怕太难学不会？快来参加<跟着佐大学 OpenWrt 开发入门培训班> 佐大助你能学有所成，培训班报名地址：http://forgotfun.org/2018/04/openwrt-training-2018.html
如果您想为rtty贡献代码，请参考[CONTRIBUTING_ZH.md](/CONTRIBUTING_ZH.md)文件，了解详细的贡献指南。
## 推荐学习
**强烈推荐佐大的OpenWrt培训班**
想学习OpenWrt开发，但是摸不着门道？自学没毅力？基础太差？怕太难学不会？快来参加<跟着佐大学OpenWrt开发入门培训班>，佐大助你能学有所成！
培训班报名地址：http://forgotfun.org/2018/04/openwrt-training-2018.html