Skip to content

Commit 11afed4

Browse files
finch-xuclaude
andcommitted
docs: update README to reflect Windows platform support
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 28528f2 commit 11afed4

2 files changed

Lines changed: 19 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
[![Node.js](https://img.shields.io/badge/Node.js-24+-339933?logo=node.js&logoColor=white)](packages/relay/package.json)
1010
[![React](https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=black)](packages/web/package.json)
1111
[![Docker](https://img.shields.io/badge/Docker-ready-2496ED?logo=docker&logoColor=white)](Dockerfile)
12-
[![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux-lightgrey)]()
12+
[![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)]()
1313

14-
Remotely access the terminal on your home Mac from a browser, no NAT traversal needed. Run Claude Code, Codex, vim, or any CLI tool and command directly.
14+
Remotely access the terminal on your home PC/Mac from a browser, no NAT traversal needed. Run Claude Code, Codex, vim, or any CLI tool and command directly.
1515

1616
> ⚠️ **Warning**: This project is for personal use and experimentation only — do NOT deploy it in production environments. You are solely responsible for securing your own data and connections. When exposing the relay to the public internet, always use a reverse proxy with HTTPS (e.g. [Caddy](https://caddyserver.com/)) to encrypt all traffic.
1717
@@ -46,11 +46,11 @@ Local Machine(s) Remote Server Browser(s)
4646

4747
## Features
4848

49+
- No NAT traversal, no remote desktop, no remote AI tool — just remote your terminal
50+
- macOS, Linux, Windows full platform support
4951
- Multiple machines in one dashboard with online/offline status
50-
- Multiple terminal sessions per machine with tabs
5152
- Scrollback replay on browser reconnect (1MB buffer per session)
5253
- Multi-user authentication with JWT (httpOnly cookie + CSRF protection)
53-
- Agent token management for machine authorization
5454
- End-to-end encryption (ECDH P-256 + AES-256-GCM) — relay cannot read terminal content
5555
- Ed25519 challenge-response for server identity verification
5656
- Agent identity keys with TOFU (SSH-like trust model) for MITM protection
@@ -112,12 +112,17 @@ Go to the [Releases](https://github.com/finchxu/RemoteTTYs/releases) page and do
112112
| macOS (Intel) | `rttys-agent-macOS-x64` |
113113
| Linux (x86_64) | `rttys-agent-Linux-x64` |
114114
| Linux (ARM64) | `rttys-agent-Linux-arm64` |
115+
| Windows (x86_64) | `rttys-agent-Windows-x64.exe` |
116+
117+
**macOS / Linux:**
115118

116119
```bash
117120
chmod +x rttys-agent-*
118121
mv rttys-agent-* rttys-agent
119122
```
120123

124+
**Windows:** No extra steps — run the `.exe` directly.
125+
121126
### 2. Configure
122127

123128
```bash

README.zh-CN.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
[![Node.js](https://img.shields.io/badge/Node.js-24+-339933?logo=node.js&logoColor=white)](packages/relay/package.json)
1010
[![React](https://img.shields.io/badge/React-19-61DAFB?logo=react&logoColor=black)](packages/web/package.json)
1111
[![Docker](https://img.shields.io/badge/Docker-ready-2496ED?logo=docker&logoColor=white)](Dockerfile)
12-
[![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux-lightgrey)]()
12+
[![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)]()
1313

14-
在浏览器中远程访问自己家里Mac的终端,无需 NAT 穿透。直接运行 Claude Code、Codex、vim 等任何 CLI 工具和命令。
14+
在浏览器中远程访问自己家里PC/Mac的终端,无需 NAT 穿透。直接运行 Claude Code、Codex、vim 等任何 CLI 工具和命令。
1515

1616
> ⚠️ **警告**:本项目仅供个人使用和实验用途,请勿部署到生产环境。使用过程中请自行保障数据和连接的安全。在公网环境下,务必通过 HTTPS 反向代理(如 [Caddy](https://caddyserver.com/))来加密所有通信流量。
1717
@@ -46,12 +46,12 @@
4646

4747
## 功能特性
4848

49+
- 不内网映射、不远程桌面、不远程某个AI工具,只远程你电脑的终端
50+
- macos、Linux、windows全平台终端支持
4951
- 多台机器统一管理,实时在线/离线状态
50-
- 每台机器支持多个终端会话,标签页切换
5152
- 浏览器重连时自动回放 scrollback(每会话 1MB 缓冲区)
5253
- 多用户认证(JWT httpOnly cookie + CSRF 防护)
53-
- Agent token 管理,授权机器接入
54-
- 端到端加密(ECDH P-256 + AES-256-GCM)— Relay 无法读取终端内容
54+
- 端到端加密(ECDH P-256 + AES-256-GCM)— 服务端不读取终端内容
5555
- Ed25519 challenge-response 服务端身份验证
5656
- Agent 身份密钥 + TOFU 信任模型(类似 SSH)防中间人攻击
5757
- 机器指纹绑定,防止 token 跨机器使用
@@ -112,12 +112,17 @@ Agent 是一个单文件 Go 二进制,运行在你的本地机器上。
112112
| macOS (Intel) | `rttys-agent-macOS-x64` |
113113
| Linux (x86_64) | `rttys-agent-Linux-x64` |
114114
| Linux (ARM64) | `rttys-agent-Linux-arm64` |
115+
| Windows (x86_64) | `rttys-agent-Windows-x64.exe` |
116+
117+
**macOS / Linux:**
115118

116119
```bash
117120
chmod +x rttys-agent-*
118121
mv rttys-agent-* rttys-agent
119122
```
120123

124+
**Windows:** 无需额外步骤,直接运行 `.exe` 即可。
125+
121126
### 2. 配置
122127

123128
```bash

0 commit comments

Comments
 (0)