@@ -50,26 +50,146 @@ Monitor, configure, and interact with your OpenClaw instance from the browser.
5050
5151## Quick Start / 快速开始
5252
53+ ### Windows
54+
55+ 1 . Install [ Node.js] ( https://nodejs.org/ ) 18+ (if not already) / 安装 [ Node.js] ( https://nodejs.org/ ) 18+
56+ 2 . Download ` arona-webui-latest.zip ` from [ Latest Release] ( https://github.com/lingshichat/Arona_WebUI/releases/latest ) / 从 [ 最新发行版] ( https://github.com/lingshichat/Arona_WebUI/releases/latest ) 下载 ` .zip `
57+ 3 . Extract the zip / 解压
58+ 4 . Double-click ** ` start.bat ` ** / 双击 ** ` start.bat ` ** (首次会自动安装依赖)
59+ 5 . Browser opens automatically → Setup Wizard / 浏览器自动打开 → 配置向导
60+
61+ ### macOS / Linux
62+
63+ ``` bash
64+ # 1. Install Node.js 18+ (if not already)
65+ # macOS: brew install node
66+ # Ubuntu: sudo apt install -y nodejs
67+
68+ # 2. Download & extract latest release / 下载解压最新发行包
69+ curl -fsSL https://github.com/lingshichat/Arona_WebUI/releases/latest/download/arona-webui-latest.tar.gz \
70+ | tar xz
71+ cd arona-webui-* /
72+
73+ # 3. Start (auto-installs dependencies on first run) / 启动(首次自动安装依赖)
74+ ./start.sh
75+ ```
76+
77+ ### First-run Setup / 首次配置
78+
79+ On first launch, the browser will open the ** Setup Wizard** automatically:
80+
81+ 首次启动时,浏览器会自动打开** 配置向导** :
82+
83+ 1 . ** Fill in your gateway info / 填写网关信息** — Gateway URL (` ws://127.0.0.1:18789 ` ), password or token, username
84+ 2 . ** Test connection / 测试连接** — Click "测试连接" to verify
85+ 3 . ** Save & restart / 保存重启** — WebUI restarts and connects to your gateway
86+ 4 . ** (Optional) Patch gateway / 配置网关** — Set ` allowedOrigins ` and ` dangerouslyDisableDeviceAuth ` on your gateway
87+
88+ > You can also skip the wizard and configure manually: ` cp .env.example .env.local ` then edit.
89+ >
90+ > 也可以跳过向导手动配置:` cp .env.example .env.local ` 然后编辑。
91+
92+ ### Gateway-side preparation / 网关侧准备
93+
94+ If your gateway uses ** non-loopback** access (e.g. LAN or Docker), you may need to configure it:
95+
96+ 如果网关不是 loopback 访问(如局域网或 Docker),可能需要在网关侧配置:
97+
98+ ``` json5
99+ // ~/.openclaw/openclaw.json
100+ {
101+ gateway: {
102+ controlUi: {
103+ allowedOrigins: [" http://localhost:18790" ],
104+ dangerouslyDisableDeviceAuth: true // required for Arona WebUI
105+ }
106+ }
107+ }
108+ ```
109+
110+ Or use ` openclaw config set ` / 或通过命令设置:
111+
112+ ``` bash
113+ openclaw config set gateway.controlUi.allowedOrigins ' ["http://localhost:18790"]'
114+ openclaw config set gateway.controlUi.dangerouslyDisableDeviceAuth true
115+ ```
116+
117+ > The Setup Wizard (Step 3) can also apply these settings automatically via WebSocket.
118+ >
119+ > 配置向导第 3 步也可以通过 WebSocket 自动应用这些设置。
120+
121+ > Default port is ` 18790 ` . To change it, edit ` PORT=<your-port> ` in ` .env.local ` .
122+ >
123+ > 默认端口 ` 18790 ` 。如需修改,在 ` .env.local ` 中设置 ` PORT=<端口号> ` 。
124+
125+ ---
126+
127+ ## Other Install Methods / 其他安装方式
128+
129+ <details >
130+ <summary ><b >One-line Install Script / 一键安装脚本</b ></summary >
131+
53132``` bash
54- git clone https://github.com/nicepkg/arona-webui.git
55- cd arona-webui
56- npm install
133+ bash <( curl -fsSL https://raw.githubusercontent.com/lingshichat/Arona_WebUI/main/scripts/install.sh)
57134```
58135
59- Create ` .env.local ` with your gateway connection info / 创建 ` .env.local ` 填写网关连接信息:
136+ Downloads the latest release, extracts it, and walks you through configuring ` .env.local ` interactively.
137+
138+ 下载最新发行包、解压、交互式配置 ` .env.local ` 。
139+
140+ </details >
60141
61- ``` env
62- GATEWAY_URL=ws://127.0.0.1:18789
63- GATEWAY_PASSWORD=your-gateway-password
142+ <details >
143+ <summary ><b >Docker</b ></summary >
144+
145+ ``` bash
146+ git clone https://github.com/lingshichat/Arona_WebUI.git
147+ cd Arona_WebUI
148+ docker compose up -d
149+ # Open http://localhost:18790 → Setup Wizard
150+ ```
151+
152+ Gateway on another machine / 网关在其他机器上:
153+
154+ ``` bash
155+ GATEWAY_URL=ws://192.168.1.100:18789 GATEWAY_PASSWORD=xxx docker compose up -d
64156```
65157
66- Start the server / 启动服务:
158+ > ** Linux host gateway / Linux 宿主机网关** : Uncomment ` extra_hosts ` in ` docker-compose.yml ` , or use ` network_mode: host ` .
159+ >
160+ > ** Linux 宿主机网关** : 取消 ` docker-compose.yml ` 中 ` extra_hosts ` 的注释,或使用 ` network_mode: host ` 。
161+
162+ </details >
163+
164+ <details >
165+ <summary ><b >Manual / 手动安装(开发者)</b ></summary >
67166
68167``` bash
69- npm start
70- # Open / 打开 http://localhost:18790
168+ git clone https://github.com/lingshichat/Arona_WebUI.git
169+ cd Arona_WebUI
170+ ./start.sh # auto-installs deps + starts server / 自动安装依赖并启动
171+ # Or: npm install && npm start
172+ # Open http://localhost:18790 → Setup Wizard
71173```
72174
175+ </details >
176+
177+ ## Setup Wizard / 配置向导
178+
179+ On first launch, the browser auto-redirects to the Setup Wizard. You can also open it manually:
180+
181+ 首次启动时浏览器会自动跳转到配置向导,也可以手动访问:
182+
183+ ```
184+ http://localhost:18790/setup.html
185+ ```
186+
187+ The wizard guides you through: WebUI config → connection check → gateway config.
188+
189+ 向导流程:WebUI 配置 → 连接检测 → 网关配置(bind / allowedOrigins / disableDeviceAuth)。
190+
191+ > Setup APIs are localhost-only (403 from remote). / Setup API 仅限本机访问。
192+
73193## Configuration / 配置项
74194
75195| Variable / 变量 | Default / 默认值 | Description / 说明 |
0 commit comments