Skip to content

Commit a47f622

Browse files
authored
Merge pull request Wei-Shaw#1159 from JerryFan626/fix/docker-compose-to-docker-compose-v2
docs: update docker-compose commands to Docker Compose V2 syntax
2 parents 3529148 + f2f819d commit a47f622

3 files changed

Lines changed: 62 additions & 62 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -178,10 +178,10 @@ mkdir -p sub2api-deploy && cd sub2api-deploy
178178
curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash
179179

180180
# Start services
181-
docker-compose up -d
181+
docker compose up -d
182182

183183
# View logs
184-
docker-compose logs -f sub2api
184+
docker compose logs -f sub2api
185185
```
186186

187187
**What the script does:**
@@ -245,16 +245,16 @@ mkdir -p data postgres_data redis_data
245245

246246
# 5. Start all services
247247
# Option A: Local directory version (recommended - easy migration)
248-
docker-compose -f docker-compose.local.yml up -d
248+
docker compose -f docker-compose.local.yml up -d
249249

250250
# Option B: Named volumes version (simple setup)
251-
docker-compose up -d
251+
docker compose up -d
252252

253253
# 6. Check status
254-
docker-compose -f docker-compose.local.yml ps
254+
docker compose -f docker-compose.local.yml ps
255255

256256
# 7. View logs
257-
docker-compose -f docker-compose.local.yml logs -f sub2api
257+
docker compose -f docker-compose.local.yml logs -f sub2api
258258
```
259259

260260
#### Deployment Versions
@@ -272,15 +272,15 @@ Open `http://YOUR_SERVER_IP:8080` in your browser.
272272

273273
If admin password was auto-generated, find it in logs:
274274
```bash
275-
docker-compose -f docker-compose.local.yml logs sub2api | grep "admin password"
275+
docker compose -f docker-compose.local.yml logs sub2api | grep "admin password"
276276
```
277277

278278
#### Upgrade
279279

280280
```bash
281281
# Pull latest image and recreate container
282-
docker-compose -f docker-compose.local.yml pull
283-
docker-compose -f docker-compose.local.yml up -d
282+
docker compose -f docker-compose.local.yml pull
283+
docker compose -f docker-compose.local.yml up -d
284284
```
285285

286286
#### Easy Migration (Local Directory Version)
@@ -289,7 +289,7 @@ When using `docker-compose.local.yml`, migrate to a new server easily:
289289

290290
```bash
291291
# On source server
292-
docker-compose -f docker-compose.local.yml down
292+
docker compose -f docker-compose.local.yml down
293293
cd ..
294294
tar czf sub2api-complete.tar.gz sub2api-deploy/
295295

@@ -299,23 +299,23 @@ scp sub2api-complete.tar.gz user@new-server:/path/
299299
# On new server
300300
tar xzf sub2api-complete.tar.gz
301301
cd sub2api-deploy/
302-
docker-compose -f docker-compose.local.yml up -d
302+
docker compose -f docker-compose.local.yml up -d
303303
```
304304

305305
#### Useful Commands
306306

307307
```bash
308308
# Stop all services
309-
docker-compose -f docker-compose.local.yml down
309+
docker compose -f docker-compose.local.yml down
310310

311311
# Restart
312-
docker-compose -f docker-compose.local.yml restart
312+
docker compose -f docker-compose.local.yml restart
313313

314314
# View all logs
315-
docker-compose -f docker-compose.local.yml logs -f
315+
docker compose -f docker-compose.local.yml logs -f
316316

317317
# Remove all data (caution!)
318-
docker-compose -f docker-compose.local.yml down
318+
docker compose -f docker-compose.local.yml down
319319
rm -rf data/ postgres_data/ redis_data/
320320
```
321321

README_CN.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -177,10 +177,10 @@ mkdir -p sub2api-deploy && cd sub2api-deploy
177177
curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash
178178

179179
# 启动服务
180-
docker-compose up -d
180+
docker compose up -d
181181

182182
# 查看日志
183-
docker-compose logs -f sub2api
183+
docker compose logs -f sub2api
184184
```
185185

186186
**脚本功能:**
@@ -244,16 +244,16 @@ mkdir -p data postgres_data redis_data
244244

245245
# 5. 启动所有服务
246246
# 选项 A:本地目录版(推荐 - 易于迁移)
247-
docker-compose -f docker-compose.local.yml up -d
247+
docker compose -f docker-compose.local.yml up -d
248248

249249
# 选项 B:命名卷版(简单设置)
250-
docker-compose up -d
250+
docker compose up -d
251251

252252
# 6. 查看状态
253-
docker-compose -f docker-compose.local.yml ps
253+
docker compose -f docker-compose.local.yml ps
254254

255255
# 7. 查看日志
256-
docker-compose -f docker-compose.local.yml logs -f sub2api
256+
docker compose -f docker-compose.local.yml logs -f sub2api
257257
```
258258

259259
#### 部署版本对比
@@ -283,15 +283,15 @@ docker-compose -f docker-compose.local.yml logs -f sub2api
283283

284284
如果管理员密码是自动生成的,在日志中查找:
285285
```bash
286-
docker-compose -f docker-compose.local.yml logs sub2api | grep "admin password"
286+
docker compose -f docker-compose.local.yml logs sub2api | grep "admin password"
287287
```
288288

289289
#### 升级
290290

291291
```bash
292292
# 拉取最新镜像并重建容器
293-
docker-compose -f docker-compose.local.yml pull
294-
docker-compose -f docker-compose.local.yml up -d
293+
docker compose -f docker-compose.local.yml pull
294+
docker compose -f docker-compose.local.yml up -d
295295
```
296296

297297
#### 轻松迁移(本地目录版)
@@ -300,7 +300,7 @@ docker-compose -f docker-compose.local.yml up -d
300300

301301
```bash
302302
# 源服务器
303-
docker-compose -f docker-compose.local.yml down
303+
docker compose -f docker-compose.local.yml down
304304
cd ..
305305
tar czf sub2api-complete.tar.gz sub2api-deploy/
306306

@@ -310,23 +310,23 @@ scp sub2api-complete.tar.gz user@new-server:/path/
310310
# 新服务器
311311
tar xzf sub2api-complete.tar.gz
312312
cd sub2api-deploy/
313-
docker-compose -f docker-compose.local.yml up -d
313+
docker compose -f docker-compose.local.yml up -d
314314
```
315315

316316
#### 常用命令
317317

318318
```bash
319319
# 停止所有服务
320-
docker-compose -f docker-compose.local.yml down
320+
docker compose -f docker-compose.local.yml down
321321

322322
# 重启
323-
docker-compose -f docker-compose.local.yml restart
323+
docker compose -f docker-compose.local.yml restart
324324

325325
# 查看所有日志
326-
docker-compose -f docker-compose.local.yml logs -f
326+
docker compose -f docker-compose.local.yml logs -f
327327

328328
# 删除所有数据(谨慎!)
329-
docker-compose -f docker-compose.local.yml down
329+
docker compose -f docker-compose.local.yml down
330330
rm -rf data/ postgres_data/ redis_data/
331331
```
332332

deploy/README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ chmod +x docker-deploy.sh
5353
**After running the script:**
5454
```bash
5555
# Start services
56-
docker-compose -f docker-compose.local.yml up -d
56+
docker compose -f docker-compose.local.yml up -d
5757

5858
# View logs
59-
docker-compose -f docker-compose.local.yml logs -f sub2api
59+
docker compose -f docker-compose.local.yml logs -f sub2api
6060

6161
# If admin password was auto-generated, find it in logs:
62-
docker-compose -f docker-compose.local.yml logs sub2api | grep "admin password"
62+
docker compose -f docker-compose.local.yml logs sub2api | grep "admin password"
6363

6464
# Access Web UI
6565
# http://localhost:8080
@@ -88,10 +88,10 @@ echo "TOTP_ENCRYPTION_KEY=${TOTP_ENCRYPTION_KEY}" >> .env
8888
mkdir -p data postgres_data redis_data
8989

9090
# Start all services using local directory version
91-
docker-compose -f docker-compose.local.yml up -d
91+
docker compose -f docker-compose.local.yml up -d
9292

9393
# View logs (check for auto-generated admin password)
94-
docker-compose -f docker-compose.local.yml logs -f sub2api
94+
docker compose -f docker-compose.local.yml logs -f sub2api
9595

9696
# Access Web UI
9797
# http://localhost:8080
@@ -121,7 +121,7 @@ When using Docker Compose with `AUTO_SETUP=true`:
121121

122122
3. If `ADMIN_PASSWORD` is not set, check logs for the generated password:
123123
```bash
124-
docker-compose logs sub2api | grep "admin password"
124+
docker compose logs sub2api | grep "admin password"
125125
```
126126

127127
### Database Migration Notes (PostgreSQL)
@@ -162,47 +162,47 @@ For **local directory version** (docker-compose.local.yml):
162162

163163
```bash
164164
# Start services
165-
docker-compose -f docker-compose.local.yml up -d
165+
docker compose -f docker-compose.local.yml up -d
166166

167167
# Stop services
168-
docker-compose -f docker-compose.local.yml down
168+
docker compose -f docker-compose.local.yml down
169169

170170
# View logs
171-
docker-compose -f docker-compose.local.yml logs -f sub2api
171+
docker compose -f docker-compose.local.yml logs -f sub2api
172172

173173
# Restart Sub2API only
174-
docker-compose -f docker-compose.local.yml restart sub2api
174+
docker compose -f docker-compose.local.yml restart sub2api
175175

176176
# Update to latest version
177-
docker-compose -f docker-compose.local.yml pull
178-
docker-compose -f docker-compose.local.yml up -d
177+
docker compose -f docker-compose.local.yml pull
178+
docker compose -f docker-compose.local.yml up -d
179179

180180
# Remove all data (caution!)
181-
docker-compose -f docker-compose.local.yml down
181+
docker compose -f docker-compose.local.yml down
182182
rm -rf data/ postgres_data/ redis_data/
183183
```
184184

185185
For **named volumes version** (docker-compose.yml):
186186

187187
```bash
188188
# Start services
189-
docker-compose up -d
189+
docker compose up -d
190190

191191
# Stop services
192-
docker-compose down
192+
docker compose down
193193

194194
# View logs
195-
docker-compose logs -f sub2api
195+
docker compose logs -f sub2api
196196

197197
# Restart Sub2API only
198-
docker-compose restart sub2api
198+
docker compose restart sub2api
199199

200200
# Update to latest version
201-
docker-compose pull
202-
docker-compose up -d
201+
docker compose pull
202+
docker compose up -d
203203

204204
# Remove all data (caution!)
205-
docker-compose down -v
205+
docker compose down -v
206206
```
207207

208208
### Environment Variables
@@ -232,7 +232,7 @@ When using `docker-compose.local.yml`, all data is stored in local directories,
232232
```bash
233233
# On source server: Stop services and create archive
234234
cd /path/to/deployment
235-
docker-compose -f docker-compose.local.yml down
235+
docker compose -f docker-compose.local.yml down
236236
cd ..
237237
tar czf sub2api-complete.tar.gz deployment/
238238

@@ -242,7 +242,7 @@ scp sub2api-complete.tar.gz user@new-server:/path/to/destination/
242242
# On new server: Extract and start
243243
tar xzf sub2api-complete.tar.gz
244244
cd deployment/
245-
docker-compose -f docker-compose.local.yml up -d
245+
docker compose -f docker-compose.local.yml up -d
246246
```
247247

248248
Your entire deployment (configuration + data) is migrated!
@@ -492,19 +492,19 @@ For **local directory version**:
492492

493493
```bash
494494
# Check container status
495-
docker-compose -f docker-compose.local.yml ps
495+
docker compose -f docker-compose.local.yml ps
496496

497497
# View detailed logs
498-
docker-compose -f docker-compose.local.yml logs --tail=100 sub2api
498+
docker compose -f docker-compose.local.yml logs --tail=100 sub2api
499499

500500
# Check database connection
501-
docker-compose -f docker-compose.local.yml exec postgres pg_isready
501+
docker compose -f docker-compose.local.yml exec postgres pg_isready
502502

503503
# Check Redis connection
504-
docker-compose -f docker-compose.local.yml exec redis redis-cli ping
504+
docker compose -f docker-compose.local.yml exec redis redis-cli ping
505505

506506
# Restart all services
507-
docker-compose -f docker-compose.local.yml restart
507+
docker compose -f docker-compose.local.yml restart
508508

509509
# Check data directories
510510
ls -la data/ postgres_data/ redis_data/
@@ -514,19 +514,19 @@ For **named volumes version**:
514514

515515
```bash
516516
# Check container status
517-
docker-compose ps
517+
docker compose ps
518518

519519
# View detailed logs
520-
docker-compose logs --tail=100 sub2api
520+
docker compose logs --tail=100 sub2api
521521

522522
# Check database connection
523-
docker-compose exec postgres pg_isready
523+
docker compose exec postgres pg_isready
524524

525525
# Check Redis connection
526-
docker-compose exec redis redis-cli ping
526+
docker compose exec redis redis-cli ping
527527

528528
# Restart all services
529-
docker-compose restart
529+
docker compose restart
530530
```
531531

532532
### Binary Install

0 commit comments

Comments
 (0)