Skip to content

Commit 46c19e6

Browse files
committed
doc: update official demo
1 parent 5eed19c commit 46c19e6

4 files changed

Lines changed: 72 additions & 45 deletions

File tree

README.md

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,6 @@ An AI-driven intelligent VPN tunnel built with Rust, featuring automatic path se
2626

2727
**Status: Beta** 🚧
2828

29-
**Welcome to Rustun!** 🎉 Download our native apps for the best experience:
30-
31-
**🚀 Try Our Demo Environment:**
32-
- **Server**: `rustun.demo.beyondnetwork.cn:18080`
33-
- **Key**: `rustun@smartethnet.github.io`
34-
- **Encryption**: `xor`
35-
- **Web Dashboard**: [rustun.beyondnetwork.cn](https://rustun.beyondnetwork.cn) - Visual network management
36-
37-
Quick start: `sudo ./client -s rustun.demo.beyondnetwork.cn:18080 -i your-identity -c xor:rustun@smartethnet.github.io`
38-
39-
![Architecture](./doc/controlplane.png)
40-
41-
- 📱 [iOS App](https://testflight.apple.com/join/2zf3dwxH) - Available on TestFlight
42-
- 🍎 [macOS App](https://testflight.apple.com/join/2zf3dwxH) - Native macOS TestFlight
43-
44-
![](screenshot.png)
45-
4629
## ✨ Key Features
4730

4831
- 🔓 **Open Source** - MIT License, completely free and transparent
@@ -55,23 +38,53 @@ Quick start: `sudo ./client -s rustun.demo.beyondnetwork.cn:18080 -i your-identi
5538

5639
## 📋 Table of Contents
5740

41+
### [Official Demo Server](#-official-demo-server)
42+
5843
### For Users
59-
- [Quick Start](#quick-start)
60-
- [Installation](#installation)
61-
- [Configuration](#configuration)
62-
- [Usage](#usage)
44+
- [Quick Start](#-quick-start)
45+
- [Installation](#-installation)
46+
- [Configuration](#-configuration)
47+
- [Usage](#-usage)
6348
- [P2P Connections](#-p2p-direct-connection)
6449
- [Multi Tenant](#-multi-tenant-isolation)
6550
- [Use Cases](#-use-cases)
6651

6752
### For Developers
68-
- [Build from Source](#build-from-source)
69-
- [Architecture](#architecture)
70-
- [Contributing](#contributing)
53+
- [Build from Source](#-build-from-source)
54+
- [Architecture](#-architecture)
55+
- [Contributing](#-contributing)
7156

7257
### Roadmap
7358
- [Roadmap](#roadmap)
7459

60+
## 🎉 Official Demo Server
61+
62+
We provide a **free demo server** for you to try Rustun without deploying your own server. You can connect immediately and manage your network through our web dashboard.
63+
64+
**Quick Start:**
65+
66+
1. **Login to dashboard** at [rustun.beyondnetwork.cn](https://rustun.beyondnetwork.cn) (OAuth login required)
67+
68+
2. **Create a client** in the dashboard - this will generate a unique `identity` for your device
69+
70+
3. **Download the client** from [GitHub Releases](https://github.com/smartethnet/rustun/releases/latest)
71+
72+
4. **Connect to demo server** using the identity from step 2:
73+
```bash
74+
sudo ./client -s rustun.demo.beyondnetwork.cn:18080 -i <your-identity> -c xor:rustun@smartethnet.github.io
75+
```
76+
Replace `<your-identity>` with the identity you created in the dashboard
77+
78+
5. **Manage your network** in the dashboard - configure routes, monitor connections, and add more clients
79+
80+
**Mobile Apps:**
81+
- 📱 [iOS App](https://testflight.apple.com/join/2zf3dwxH) - TestFlight beta
82+
- 🍎 [macOS App](https://testflight.apple.com/join/2zf3dwxH) - TestFlight beta
83+
84+
![Architecture](./doc/controlplane.png)
85+
86+
![](screenshot.jpg)
87+
7588
## 🚀 Quick Start
7689

7790
### One-Click Installation (Recommended)

doc/README_CN.md

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,7 @@
2424

2525
基于 Rust 构建的 AI 驱动智能 VPN 隧道,具备自动路径选择和智能路由能力。
2626

27-
**状态:积极开发中** 🚧
28-
29-
**欢迎使用 Rustun!** 🎉 下载我们的原生应用以获得最佳体验:
30-
31-
**🚀 体验我们的演示环境:**
32-
- **服务器**`rustun.demo.beyondnetwork.cn:18080`
33-
- **密钥**`rustun@smartethnet.github.io`
34-
- **加密算法**`xor`
35-
- **Web 管理界面**[rustun.beyondnetwork.cn](https://rustun.beyondnetwork.cn) - 可视化网络管理
36-
37-
快速开始:`sudo ./client -s rustun.demo.beyondnetwork.cn:18080 -i your-identity -c xor:rustun@smartethnet.github.io`
38-
39-
![架构图](./controlplane.png)
40-
41-
- 📱 [iOS 应用](https://testflight.apple.com/join/2zf3dwxH) - TestFlight 测试版
42-
- 🍎 [macOS 应用](https://testflight.apple.com/join/2zf3dwxH) - macOS TestFlight 测试版
43-
44-
![](../screenshot.png)
27+
**状态:Beta** 🚧
4528

4629
## ✨ 核心特性
4730

@@ -55,6 +38,36 @@
5538

5639
## 📋 目录
5740

41+
### [官方演示服务器](#-官方演示服务器)
42+
43+
## 🎉 官方演示服务器
44+
45+
我们提供**免费的演示服务器**,让您无需部署自己的服务器即可体验 Rustun。您可以立即连接并通过我们的 Web 管理界面管理您的网络。
46+
47+
**快速开始:**
48+
49+
1. **登录管理界面** - 访问 [rustun.beyondnetwork.cn](https://rustun.beyondnetwork.cn)(需要 OAuth 登录)
50+
51+
2. **创建客户端** - 在管理界面中创建客户端,系统会为您的设备生成唯一的 `identity`
52+
53+
3. **下载客户端** - 从 [GitHub Releases](https://github.com/smartethnet/rustun/releases/latest) 下载
54+
55+
4. **连接演示服务器** - 使用步骤 2 中创建的 identity 连接:
56+
```bash
57+
sudo ./client -s rustun.demo.beyondnetwork.cn:18080 -i <your-identity> -c xor:rustun@smartethnet.github.io
58+
```
59+
`<your-identity>` 替换为在管理界面中创建的 identity
60+
61+
5. **管理网络** - 在管理界面中配置路由、监控连接、添加更多客户端
62+
63+
**移动应用:**
64+
- 📱 [iOS 应用](https://testflight.apple.com/join/2zf3dwxH) - TestFlight 测试版
65+
- 🍎 [macOS 应用](https://testflight.apple.com/join/2zf3dwxH) - TestFlight 测试版
66+
67+
![架构图](./controlplane.png)
68+
69+
![](../screenshot.jpg)
70+
5871
### 面向用户
5972
- [快速开始](#-快速开始)
6073
- [安装](#-安装)
@@ -320,10 +333,11 @@ sudo ./client -s SERVER_IP:8080 -i client-identity
320333
**演示环境:**
321334

322335
```bash
323-
# 连接到我们的演示服务器
324-
sudo ./client -s rustun.demo.beyondnetwork.cn:18080 -i your-identity -c xor:rustun@smartethnet.github.io
336+
# 1. 先登录 https://rustun.beyondnetwork.cn 创建客户端获取 identity
337+
# 2. 使用创建的 identity 连接演示服务器
338+
sudo ./client -s rustun.demo.beyondnetwork.cn:18080 -i <your-identity> -c xor:rustun@smartethnet.github.io
325339

326-
# 通过 Web 界面管理您的网络:
340+
# 3. 通过 Web 界面管理您的网络:
327341
# https://rustun.beyondnetwork.cn
328342
```
329343

screenshot.jpg

24.9 KB
Loading

screenshot.png

-817 KB
Binary file not shown.

0 commit comments

Comments
 (0)