Skip to content

Commit 4fabe58

Browse files
committed
docs: update README.md
1 parent b622970 commit 4fabe58

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/README.en.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ git clone https://github.com/chenyme/grok2api
3131
docker compose up -d
3232
```
3333

34+
### Admin panel
35+
36+
URL: `http://<host>:8000/admin`
37+
Default password: `grok2api` (config key `app.app_key`, change it in production).
38+
3439
### Environment variables
3540

3641
| Variable | Description | Default | Example |
@@ -140,6 +145,10 @@ Note: any other parameters will be discarded and ignored.
140145

141146
Config file: `data/config.toml`
142147

148+
> [!NOTE]
149+
> In production or behind a reverse proxy, make sure `app.app_url` is set to the public URL.
150+
> Otherwise file links may be incorrect or return 403.
151+
143152
| Module | Field | Key | Description | Default |
144153
| :--- | :--- | :--- | :--- | :--- |
145154
| **app** | `app_url` | App URL | External access URL for Grok2API (used for file links). | `http://127.0.0.1:8000` |

readme.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ git clone https://github.com/chenyme/grok2api
3131
docker compose up -d
3232
```
3333

34+
### 管理面板
35+
36+
访问地址:`http://<host>:8000/admin`
37+
默认登录密码:`grok2api`(对应配置项 `app.app_key`,建议修改)。
38+
3439
### 环境变量
3540

3641
> 配置 `.env` 文件
@@ -144,6 +149,10 @@ curl http://localhost:8000/v1/images/generations \
144149

145150
配置文件:`data/config.toml`
146151

152+
> [!NOTE]
153+
> 生产环境或反向代理部署时,请确保 `app.app_url` 配置为对外可访问的完整 URL,
154+
> 否则可能出现文件访问链接不正确或 403 等问题。
155+
147156
| 模块 | 字段 | 配置名 | 说明 | 默认值 |
148157
| :-------------------- | :--------------------------- | :----------- | :--------------------------------------------------- | :-------------------------------------------------------- |
149158
| **app** | `app_url` | 应用地址 | 当前 Grok2API 服务的外部访问 URL,用于文件链接访问。 | `http://127.0.0.1:8000` |

0 commit comments

Comments
 (0)