From de1fed43a343bddcc64b15d860bd2cd2c129bde8 Mon Sep 17 00:00:00 2001 From: RoomWithOutRoof <166608075+Jah-yee@users.noreply.github.com> Date: Fri, 6 Mar 2026 02:02:28 +0800 Subject: [PATCH] docs(join-keys): align docs with runtime sample file Made-with: Cursor --- README.en.md | 4 ++-- README.ja.md | 4 ++-- README.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.en.md b/README.en.md index 5d00695..0a11ba5 100644 --- a/README.en.md +++ b/README.en.md @@ -137,7 +137,7 @@ Add the following rule to your `SOUL.md` (or agent config) so your lobster updat **Step 1: Prepare join keys** -The repo ships with `join-keys.json` (containing `ocj_starteam01` through `ocj_starteam08`), each supporting up to 3 concurrent users. Feel free to add your own keys. +When you start the backend for the first time, if there is no `join-keys.json` in the project root, the service will automatically create one based on `join-keys.sample.json` (which contains an example key such as `ocj_example_team_01`). You can then edit the generated `join-keys.json` to add, modify, or remove keys; by default each key supports up to 3 concurrent users. **Step 2: Have the guest run the push script** @@ -256,7 +256,7 @@ Star-Office-UI/ ├── office-agent-push.py # Guest push script ├── set_state.py # Status switch script ├── state.sample.json # State file template -├── join-keys.json # Join key config +├── join-keys.sample.json # Join key template (runtime generates join-keys.json) ├── SKILL.md # OpenClaw Skill └── LICENSE # MIT License ``` diff --git a/README.ja.md b/README.ja.md index 572937d..3ba4cd2 100644 --- a/README.ja.md +++ b/README.ja.md @@ -137,7 +137,7 @@ cp SKILL.md ~/.openclaw/workspace/SKILL.md **Step 1:join key を準備** -リポジトリには `join-keys.json`(`ocj_starteam01` 〜 `ocj_starteam08`)が含まれており、各キーで最大 3 名まで同時接続可能。独自のキーを追加することもできます。 +バックエンドを初回起動するとき、カレントディレクトリに `join-keys.json` が存在しない場合は、`join-keys.sample.json` を元にランタイム用の `join-keys.json` が自動生成されます(例として `ocj_example_team_01` などのサンプル key が含まれます)。生成された `join-keys.json` を編集して key を追加・変更・削除できます。各 key はデフォルトで最大 3 名まで同時接続できます。 **Step 2:ゲストにプッシュスクリプトを実行してもらう** @@ -256,7 +256,7 @@ Star-Office-UI/ ├── office-agent-push.py # ゲストプッシュスクリプト ├── set_state.py # ステータス切替スクリプト ├── state.sample.json # 状態ファイルテンプレート -├── join-keys.json # Join Key 設定 +├── join-keys.sample.json # Join Key テンプレート(起動時に join-keys.json を生成) ├── SKILL.md # OpenClaw Skill └── LICENSE # MIT ライセンス ``` diff --git a/README.md b/README.md index c09adb4..0296098 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ cp SKILL.md ~/.openclaw/workspace/SKILL.md **Step 1:准备 join key** -仓库默认提供 `join-keys.json`(含 `ocj_starteam01` ~ `ocj_starteam08`),每个 key 最多 3 人同时在线。你也可以自行编辑添加新 key。 +首次启动后端时,如果当前目录下不存在 `join-keys.json`,服务会自动根据 `join-keys.sample.json` 生成一个运行时的 `join-keys.json`(内含示例 key,例如 `ocj_example_team_01`)。你可以在生成后的 `join-keys.json` 中自行添加、修改或删除 key,每个 key 默认支持最多 3 人同时在线。 **Step 2:让访客龙虾运行推送脚本** @@ -256,7 +256,7 @@ Star-Office-UI/ ├── office-agent-push.py # 访客推送脚本 ├── set_state.py # 状态切换脚本 ├── state.sample.json # 状态文件模板 -├── join-keys.json # Join Key 配置 +├── join-keys.sample.json # Join Key 模板(启动时生成 join-keys.json) ├── SKILL.md # OpenClaw Skill └── LICENSE # MIT 许可 ```