Skip to content

Commit d98388f

Browse files
JihaoXinclaude
andcommitted
Fix PR #1 follow-ups: sync multilingual READMEs, improve config comment
- Sync Web Portal docs to README_zh.md and README_ar.md - config.py: use <BASE_URL> placeholder instead of hardcoded http://host:9527 - Remove extra blank line in README.md Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ee80db5 commit d98388f

File tree

4 files changed

+63
-24
lines changed

4 files changed

+63
-24
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,6 @@ The web app is configured via `webapp.env` located in your ARK config directory
201201

202202
</details>
203203

204-
205204
<details>
206205
<summary><strong>Direct orchestrator invocation</strong></summary>
207206

README_ar.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,21 +163,41 @@ ark new mma --from-pdf proposal.pdf
163163
| `ark list` | سرد جميع المشاريع وحالتها |
164164
| `ark webapp install` | تثبيت خدمة بوابة الويب |
165165

166+
---
167+
168+
## بوابة الويب
169+
170+
يتضمن ARK بوابة ويب لإدارة المشاريع وعرض الدرجات وتوجيه الوكلاء.
171+
172+
### الإعدادات
173+
174+
يتم تكوين تطبيق الويب عبر `webapp.env` الموجود في دليل إعدادات ARK (الافتراضي: `.ark/webapp.env` في جذر المشروع). يتم إنشاؤه تلقائيًا عند أول تشغيل لـ `ark webapp`.
175+
176+
#### المصادقة والوصول
177+
- **SMTP**: مطلوب لتسجيل الدخول بالرابط السحري. عيّن `SMTP_HOST` و`SMTP_USER` و`SMTP_PASSWORD`.
178+
- **تقييد الوصول**: استخدم `ALLOWED_EMAILS` (مستخدمون محددون) أو `EMAIL_DOMAINS` (مؤسسات كاملة).
179+
- **Google OAuth**: اختياري. عيّن `GOOGLE_CLIENT_ID` و`GOOGLE_CLIENT_SECRET`.
180+
181+
### أوامر الإدارة
182+
183+
| الأمر | الوصف |
184+
|:------|:------|
185+
| `ark webapp` | بدء التطبيق في الواجهة (مفيد للتصحيح). |
186+
| `ark webapp release` | وسم الكود الحالي ونشره في شجرة العمل الإنتاجية. |
187+
| `ark webapp install [--dev]` | تثبيت وبدء كخدمة `systemd` للمستخدم. |
188+
| `ark webapp status` | عرض حالة خدمة systemd. |
189+
| `ark webapp restart` | إعادة تشغيل خدمة التطبيق. |
190+
| `ark webapp logs [-f]` | عرض أو متابعة سجلات الخدمة. |
191+
166192
<details>
167-
<summary><strong>بوابة الويب (تطوير/إنتاج)</strong></summary>
193+
<summary><strong>تفاصيل الخدمة (إنتاج مقابل تطوير)</strong></summary>
168194

169195
| | الإنتاج | التطوير |
170196
|--|:--------|:--------|
171-
| المنفذ | 9527 | 1027 |
172-
| الخدمة | `ark-webapp` | `ark-webapp-dev` |
173-
| بيئة Conda | `ark-prod` | `ark-dev` |
174-
| الكود | `~/.ark/prod/` (مقفل على وسم git) | المستودع الحالي (مباشر) |
175-
176-
```bash
177-
ark webapp release # وسم + نشر للإنتاج
178-
ark webapp install # بدء الإنتاج (المنفذ 9527)
179-
ark webapp install --dev # بدء التطوير (المنفذ 1027)
180-
```
197+
| **المنفذ** | 9527 | 1027 |
198+
| **اسم الخدمة** | `ark-webapp` | `ark-webapp-dev` |
199+
| **بيئة Conda** | `ark-prod` | `ark-dev` |
200+
| **مصدر الكود** | `~/.ark/prod/` (مقفل) | المستودع الحالي (مباشر) |
181201

182202
</details>
183203

README_zh.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,21 +163,41 @@ ARK 使用 PyMuPDF + Claude Haiku 解析 PDF,预填向导,从提取的规格
163163
| `ark list` | 列出所有项目及状态 |
164164
| `ark webapp install` | 安装 Web 门户服务 |
165165

166+
---
167+
168+
## Web 门户
169+
170+
ARK 提供基于 Web 的门户,用于管理项目、查看评分和控制智能体。
171+
172+
### 配置
173+
174+
Web 应用通过 `webapp.env` 配置,位于 ARK 配置目录(默认:项目根目录下的 `.ark/webapp.env`)。首次运行 `ark webapp` 时自动创建。
175+
176+
#### 认证与访问
177+
- **SMTP**:魔法链接登录所需。设置 `SMTP_HOST``SMTP_USER``SMTP_PASSWORD`
178+
- **访问限制**:使用 `ALLOWED_EMAILS`(指定用户)或 `EMAIL_DOMAINS`(整个组织)限制访问。
179+
- **Google OAuth**:可选。设置 `GOOGLE_CLIENT_ID``GOOGLE_CLIENT_SECRET`
180+
181+
### 管理命令
182+
183+
| 命令 | 描述 |
184+
|:-----|:-----|
185+
| `ark webapp` | 前台启动应用(适用于调试)。 |
186+
| `ark webapp release` | 打 tag 并部署到生产环境工作树。 |
187+
| `ark webapp install [--dev]` | 安装并启动为 `systemd` 用户服务。 |
188+
| `ark webapp status` | 查看 systemd 服务状态。 |
189+
| `ark webapp restart` | 重启 Web 应用服务。 |
190+
| `ark webapp logs [-f]` | 查看或追踪服务日志。 |
191+
166192
<details>
167-
<summary><strong>Web 门户(开发/生产环境)</strong></summary>
193+
<summary><strong>服务详情(生产 vs. 开发)</strong></summary>
168194

169195
| | 生产环境 | 开发环境 |
170196
|--|:---------|:---------|
171-
| 端口 | 9527 | 1027 |
172-
| 服务名 | `ark-webapp` | `ark-webapp-dev` |
173-
| Conda 环境 | `ark-prod` | `ark-dev` |
174-
| 代码 | `~/.ark/prod/`(锁定 git tag) | 当前 repo(实时生效) |
175-
176-
```bash
177-
ark webapp release # 打 tag + 部署到生产
178-
ark webapp install # 启动生产服务(端口 9527)
179-
ark webapp install --dev # 启动开发服务(端口 1027)
180-
```
197+
| **端口** | 9527 | 1027 |
198+
| **服务名** | `ark-webapp` | `ark-webapp-dev` |
199+
| **Conda 环境** | `ark-prod` | `ark-dev` |
200+
| **代码来源** | `~/.ark/prod/`(锁定版本) | 当前 repo(实时生效) |
181201

182202
</details>
183203

ark/webapp/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def _write_default_env():
7474
ADMIN_EMAILS=
7575
7676
# Google OAuth (optional). Get credentials at console.cloud.google.com → APIs & Services → Credentials.
77-
# Redirect URI to register: http://{hostname}:9527/auth/google/callback
77+
# Redirect URI to register: <BASE_URL>/auth/google/callback (use the BASE_URL value above)
7878
GOOGLE_CLIENT_ID=
7979
GOOGLE_CLIENT_SECRET=
8080

0 commit comments

Comments
 (0)