Skip to content

Commit 3f6382d

Browse files
authored
docs: Update environment variable configuration and setup documentation across various files. (#297)
1 parent c1ea8cb commit 3f6382d

8 files changed

Lines changed: 43 additions & 9 deletions

File tree

.env.example

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ DEFAULT_CAMOUFOX_PORT=9222
2020
# =============================================================================
2121

2222
# 自动保存认证信息 (Auto Save Auth)
23-
# 设置为 true 以在每次成功登录后自动保存认证状态 (cookies/localStorage),无需人工确认。
24-
# 强烈建议在 headless 模式下开启,以便长期运行。
23+
# 设置为 true 以在成功登录后自动保存认证状态 (cookies/localStorage),无需人工确认。
24+
# [IMPORTANT] 必须在 debug 模式下设置为 true 才能保存新的认证配置文件!
25+
# Headless 模式使用已保存的配置文件,不需要此设置。
2526
# Default: false
2627
AUTO_SAVE_AUTH=false
2728

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,12 @@ poetry install
4242

4343
# 2️⃣ 配置环境
4444
cp .env.example .env
45-
nano .env # 编辑配置(可选)
45+
nano .env # 设置 AUTO_SAVE_AUTH=true 以保存认证
4646

4747
# 3️⃣ 首次认证并启动
4848
poetry run python launch_camoufox.py --debug # 首次认证(需登录 Google)
49-
# 认证成功后,Ctrl+C 停止,然后:
49+
# 认证成功后,将 auth_profiles/saved/*.json 移至 auth_profiles/active/
50+
# 然后:
5051
poetry run python launch_camoufox.py --headless
5152
```
5253

docker/README-Docker.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Docker 部署提供了以下优势:
2525
## 🔧 Docker 环境规格
2626

2727
- **基础镜像**: Python 3.10-slim-bookworm (稳定且轻量)
28-
- **Python版本**: 3.10 (在容器内运行,与主机Python版本无关)
28+
- **Python 版本**: 3.10 (在容器内运行,与主机 Python 版本无关)
2929
- **依赖管理**: Poetry (现代化 Python 依赖管理)
3030
- **构建方式**: 多阶段构建 (builder + runtime)
3131
- **架构支持**: x86_64 和 ARM64 (Apple Silicon)
@@ -180,6 +180,7 @@ docker run -d \
180180
```
181181

182182
**`.env` 文件的优势:**
183+
183184
-**版本更新无忧**: 一个 `git pull` 就完成更新,无需重新配置
184185
-**配置集中管理**: 所有配置项统一在 `.env` 文件中
185186
-**Docker 兼容**: 容器会自动读取挂载的 `.env` 文件
@@ -241,6 +242,8 @@ TRACE_LOGS_ENABLED=false
241242
242243
# 认证配置
243244
AUTO_CONFIRM_LOGIN=true
245+
# 注意:AUTO_SAVE_AUTH 仅在 debug 模式下用于保存新认证文件
246+
# Docker 容器运行于 headless 模式,使用预先生成的认证文件,此设置无效
244247
AUTO_SAVE_AUTH=false
245248
AUTH_SAVE_TIMEOUT=30
246249

docs/authentication-setup.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,13 @@ DEFAULT_FASTAPI_PORT=2048
2424
STREAM_PORT=0
2525
LAUNCH_MODE=normal
2626
DEBUG_LOGS_ENABLED=true
27+
28+
# [IMPORTANT] 必须设置为 true 才能保存认证配置文件!
29+
AUTO_SAVE_AUTH=true
2730
```
2831

32+
> [!WARNING] > `AUTO_SAVE_AUTH=true` 是保存认证配置文件的必要条件。如果设置为 `false`(默认值),登录成功后将不会保存认证状态。
33+
2934
```bash
3035
# 简化启动命令 (推荐)
3136
python launch_camoufox.py --debug

docs/env-variables-reference.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,10 @@
181181
- **类型**: 布尔值
182182
- **默认值**: `false`
183183
- **示例**: `AUTO_SAVE_AUTH=true`
184-
- **说明**: 启用后会自动保存 Google 认证 Cookie 到 `auth_profiles/` 目录
184+
- **说明**: 启用后会自动保存 Google 认证 Cookie 到 `auth_profiles/saved/` 目录
185+
186+
> [!WARNING]
187+
> 必须在 **debug 模式** 下设置为 `true` 才能保存新的认证配置文件!Headless 模式使用已保存的配置文件,此设置对其无效。
185188
186189
### AUTH_SAVE_TIMEOUT
187190

docs/environment-configuration.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ SERVER_REDIRECT_PRINT=false
108108

109109
```env
110110
# 自动保存认证信息
111+
# [IMPORTANT] 必须在 debug 模式下设置为 true 才能保存新的认证配置文件!
111112
AUTO_SAVE_AUTH=false
112113
113114
# 认证保存超时时间 (秒)
@@ -117,6 +118,8 @@ AUTH_SAVE_TIMEOUT=30
117118
ONLY_COLLECT_CURRENT_USER_ATTACHMENTS=false
118119
```
119120

121+
> [!WARNING] > `AUTO_SAVE_AUTH=true` 是在 debug 模式下保存认证配置文件的必要条件。首次设置时请务必启用此选项。Headless 模式使用已保存的配置文件,此设置对其无效。
122+
120123
### 浏览器配置
121124

122125
```env

docs/quick-start-guide.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,15 @@ SERVER_LOG_LEVEL=INFO
184184

185185
首次运行需要进行 Google 账号认证,获取访问 AI Studio 所需的 Cookie。
186186

187+
### 配置认证保存
188+
189+
`.env` 文件中确保设置了自动保存认证:
190+
191+
```env
192+
# [IMPORTANT] 必须设置为 true 才能保存认证配置文件!
193+
AUTO_SAVE_AUTH=true
194+
```
195+
187196
### 使用调试模式认证
188197

189198
```bash
@@ -196,13 +205,22 @@ poetry run python launch_camoufox.py --debug
196205
1. **浏览器窗口打开** - Camoufox 浏览器会自动打开
197206
2. **登录 Google 账号** - 在浏览器中登录您的 Google 账号
198207
3. **访问 AI Studio** - 浏览器会自动导航到 AI Studio 页面
199-
4. **等待保存** - 认证信息会自动保存到 `auth_profiles/active/` 目录
208+
4. **等待保存** - 认证信息会自动保存到 `auth_profiles/saved/` 目录
200209
5. **查看日志** - 终端会显示认证文件保存成功的消息
201210

202211
**成功标志**:
203212

204213
```
205-
✅ 认证文件已保存到: auth_profiles/active/XXXXXXXX.json
214+
✅ 认证文件已保存到: auth_profiles/saved/XXXXXXXX.json
215+
```
216+
217+
### 激活认证文件
218+
219+
将保存的认证文件移动到 `active` 目录:
220+
221+
```bash
222+
# 将认证文件从 saved 移到 active
223+
mv auth_profiles/saved/*.json auth_profiles/active/
206224
```
207225

208226
### 关闭调试模式

launcher/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
SAVED_AUTH_DIR = os.path.join(AUTH_PROFILES_DIR, "saved")
3232
LOG_DIR = os.path.join(os.path.dirname(os.path.dirname(__file__)), "logs")
3333
LAUNCHER_LOG_FILE_PATH = os.path.join(LOG_DIR, "launch_app.log")
34-
DIRECT_LAUNCH = os.environ.get("DIRECT_LAUNCH", False)
34+
DIRECT_LAUNCH = os.environ.get("DIRECT_LAUNCH", "").lower() in ("true", "1", "yes")
3535

3636
# --- WebSocket 端点正则表达式 ---
3737
import re

0 commit comments

Comments
 (0)