Skip to content

Commit c06cf8a

Browse files
committed
docs: clarify docker compose env file usage
1 parent 5d3b7ad commit c06cf8a

5 files changed

Lines changed: 28 additions & 23 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ docker run -d -p 8081:80 \
156156
git clone https://github.com/linshenkx/prompt-optimizer.git
157157
cd prompt-optimizer
158158

159-
# 2. Optional: Create .env file for API keys and authentication
159+
# 2. Create .env file for API keys and authentication
160160
cat > .env << EOF
161161
# API Key Configuration
162162
VITE_OPENAI_API_KEY=your_openai_api_key
@@ -171,11 +171,13 @@ ACCESS_USERNAME=your_username # Optional, defaults to "admin"
171171
ACCESS_PASSWORD=your_password # Set access password
172172
EOF
173173

174+
# Because the compose file is under docker/, pass the root .env explicitly.
175+
174176
# 3. Start the service
175-
docker compose -f docker/docker-compose.yml up -d
177+
docker compose --env-file .env -f docker/docker-compose.yml up -d
176178

177179
# 4. View logs
178-
docker compose -f docker/docker-compose.yml logs -f
180+
docker compose --env-file .env -f docker/docker-compose.yml logs -f
179181

180182
# 5. Access the service
181183
Web Interface: http://localhost:8081

README.zh-CN.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,15 +160,16 @@ docker run -d -p 8081:80 \
160160
git clone https://github.com/linshenkx/prompt-optimizer.git
161161
cd prompt-optimizer
162162

163-
# 2. 可选:创建.env文件配置API密钥和访问认证
163+
# 2. 创建 .env 文件配置 API 密钥和访问认证
164164
cp env.local.example .env
165165
# 编辑 .env 文件,填入实际的 API 密钥和配置
166+
# docker-compose.yml 位于 docker/ 目录下,所以后续命令显式传入根目录 .env
166167

167168
# 3. 启动服务
168-
docker compose -f docker/docker-compose.yml up -d
169+
docker compose --env-file .env -f docker/docker-compose.yml up -d
169170

170171
# 4. 查看日志
171-
docker compose -f docker/docker-compose.yml logs -f
172+
docker compose --env-file .env -f docker/docker-compose.yml logs -f
172173

173174
# 5. 访问服务
174175
Web 界面:http://localhost:8081

docs/deployment/docker-mcp-integration.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,11 @@ cp env.local.example .env
5757
# 编辑.env文件,填入实际的API密钥
5858
```
5959

60+
由于 Compose 文件位于 `docker/` 目录下,下面的生产环境命令都显式传入仓库根目录的 `.env` 文件。
61+
6062
### 2. 启动服务
6163
```bash
62-
docker compose -f docker/docker-compose.yml up -d
64+
docker compose --env-file .env -f docker/docker-compose.yml up -d
6365
```
6466

6567
### 3. 访问服务
@@ -71,13 +73,13 @@ docker compose -f docker/docker-compose.yml up -d
7173
### 4. 健康检查
7274
```bash
7375
# 检查容器状态
74-
docker compose -f docker/docker-compose.yml ps
76+
docker compose --env-file .env -f docker/docker-compose.yml ps
7577

7678
# 查看日志
77-
docker compose -f docker/docker-compose.yml logs -f
79+
docker compose --env-file .env -f docker/docker-compose.yml logs -f
7880

7981
# 查看MCP服务器日志
80-
docker compose -f docker/docker-compose.yml exec prompt-optimizer supervisorctl tail -f mcp-server
82+
docker compose --env-file .env -f docker/docker-compose.yml exec prompt-optimizer supervisorctl tail -f mcp-server
8183
```
8284

8385
## MCP服务器API
@@ -111,21 +113,21 @@ curl -X POST http://localhost:8081/mcp \
111113

112114
### 查看服务状态
113115
```bash
114-
docker compose -f docker/docker-compose.yml exec prompt-optimizer supervisorctl status
116+
docker compose --env-file .env -f docker/docker-compose.yml exec prompt-optimizer supervisorctl status
115117
```
116118

117119
### 重启MCP服务器
118120
```bash
119-
docker compose -f docker/docker-compose.yml exec prompt-optimizer supervisorctl restart mcp-server
121+
docker compose --env-file .env -f docker/docker-compose.yml exec prompt-optimizer supervisorctl restart mcp-server
120122
```
121123

122124
### 查看详细日志
123125
```bash
124126
# Nginx日志
125-
docker compose -f docker/docker-compose.yml exec prompt-optimizer tail -f /var/log/nginx/error.log
127+
docker compose --env-file .env -f docker/docker-compose.yml exec prompt-optimizer tail -f /var/log/nginx/error.log
126128

127129
# MCP服务器日志
128-
docker compose -f docker/docker-compose.yml exec prompt-optimizer tail -f /var/log/supervisor/mcp-server.out.log
130+
docker compose --env-file .env -f docker/docker-compose.yml exec prompt-optimizer tail -f /var/log/supervisor/mcp-server.out.log
129131
```
130132

131133
## 开发模式

mkdocs/docs/zh/deployment/docker-basic.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ docker run -d -p 8081:80 --restart unless-stopped --name prompt-optimizer \
4949

5050
## 使用仓库自带的 Docker Compose
5151

52-
仓库 `docker/` 目录已经带了 `docker-compose.yml`,可以直接使用
52+
仓库 `docker/` 目录已经带了 `docker-compose.yml`。如果你在仓库根目录放了 `.env`,需要在命令里显式传入
5353

5454
```bash
55-
docker compose -f docker/docker-compose.yml up -d
55+
docker compose --env-file .env -f docker/docker-compose.yml up -d
5656
```
5757

5858
默认端口映射是:
@@ -69,8 +69,8 @@ docker compose -f docker/docker-compose.yml up -d
6969
常用命令:
7070

7171
```bash
72-
docker compose -f docker/docker-compose.yml logs -f
73-
docker compose -f docker/docker-compose.yml down
72+
docker compose --env-file .env -f docker/docker-compose.yml logs -f
73+
docker compose --env-file .env -f docker/docker-compose.yml down
7474
```
7575

7676
## 开发用 Compose

mkdocs/docs/zh/deployment/docker-troubleshooting.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
排查前先分清:
1313

1414
- `docker run -p 8081:80 ...`
15-
- `docker compose -f docker/docker-compose.yml up -d` 使用仓库自带 Compose 配置
15+
- `docker compose --env-file .env -f docker/docker-compose.yml up -d` 使用仓库自带 Compose 配置
1616
- `docker compose -f docker/docker-compose.dev.yml up -d --build`
1717

1818
因为三种方式默认端口不一样,很多“服务打不开”其实只是看错了端口。
@@ -41,8 +41,8 @@ docker logs prompt-optimizer
4141
如果你用的是仓库自带 compose,再看:
4242

4343
```bash
44-
docker compose -f docker/docker-compose.yml ps
45-
docker compose -f docker/docker-compose.yml logs -f
44+
docker compose --env-file .env -f docker/docker-compose.yml ps
45+
docker compose --env-file .env -f docker/docker-compose.yml logs -f
4646
```
4747

4848
常见原因:
@@ -156,8 +156,8 @@ extra_hosts:
156156
可以按这个顺序试:
157157
158158
```bash
159-
docker compose -f docker/docker-compose.yml down
160-
docker compose -f docker/docker-compose.yml up -d
159+
docker compose --env-file .env -f docker/docker-compose.yml down
160+
docker compose --env-file .env -f docker/docker-compose.yml up -d
161161
```
162162

163163
或者:

0 commit comments

Comments
 (0)