oadmin/sub2api
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request #1159 from JerryFan626/fix/docker-compose-to-docker-compose-v2

Browse Source 
docs: update docker-compose commands to Docker Compose V2 syntax
This commit is contained in:
Wesley Liddick
2026-03-20 09:12:14 +08:00
committed by GitHub
parent 3529148455 f2f819d70f
commit a47f622e7e
3 changed files with 62 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -178,10 +178,10 @@ mkdir -p sub2api-deploy && cd sub2api-deploy
curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash
# Start services # Start services
docker-compose up -d docker compose up -d
# View logs # View logs
docker-compose logs -f sub2api docker compose logs -f sub2api
``` ```
**What the script does:** **What the script does:**
@@ -245,16 +245,16 @@ mkdir -p data postgres_data redis_data
# 5. Start all services # 5. Start all services
# Option A: Local directory version (recommended - easy migration) # Option A: Local directory version (recommended - easy migration)
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
# Option B: Named volumes version (simple setup) # Option B: Named volumes version (simple setup)
docker-compose up -d docker compose up -d
# 6. Check status # 6. Check status
docker-compose -f docker-compose.local.yml ps docker compose -f docker-compose.local.yml ps
# 7. View logs # 7. View logs
docker-compose -f docker-compose.local.yml logs -f sub2api docker compose -f docker-compose.local.yml logs -f sub2api
``` ```
#### Deployment Versions #### Deployment Versions
@@ -272,15 +272,15 @@ Open `http://YOUR_SERVER_IP:8080` in your browser.
If admin password was auto-generated, find it in logs: If admin password was auto-generated, find it in logs:
```bash ```bash
docker-compose -f docker-compose.local.yml logs sub2api | grep "admin password" docker compose -f docker-compose.local.yml logs sub2api | grep "admin password"
``` ```
#### Upgrade #### Upgrade
```bash ```bash
# Pull latest image and recreate container # Pull latest image and recreate container
docker-compose -f docker-compose.local.yml pull docker compose -f docker-compose.local.yml pull
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
``` ```
#### Easy Migration (Local Directory Version) #### Easy Migration (Local Directory Version)
@@ -289,7 +289,7 @@ When using `docker-compose.local.yml`, migrate to a new server easily:
```bash ```bash
# On source server # On source server
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
cd .. cd ..
tar czf sub2api-complete.tar.gz sub2api-deploy/ tar czf sub2api-complete.tar.gz sub2api-deploy/
@@ -299,23 +299,23 @@ scp sub2api-complete.tar.gz user@new-server:/path/
# On new server # On new server
tar xzf sub2api-complete.tar.gz tar xzf sub2api-complete.tar.gz
cd sub2api-deploy/ cd sub2api-deploy/
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
``` ```
#### Useful Commands #### Useful Commands
```bash ```bash
# Stop all services # Stop all services
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
# Restart # Restart
docker-compose -f docker-compose.local.yml restart docker compose -f docker-compose.local.yml restart
# View all logs # View all logs
docker-compose -f docker-compose.local.yml logs -f docker compose -f docker-compose.local.yml logs -f
# Remove all data (caution!) # Remove all data (caution!)
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
rm -rf data/ postgres_data/ redis_data/ rm -rf data/ postgres_data/ redis_data/
``` ```

30
README_CN.md
View File

@@ -177,10 +177,10 @@ mkdir -p sub2api-deploy && cd sub2api-deploy
curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/docker-deploy.sh | bash
# 启动服务 # 启动服务
docker-compose up -d docker compose up -d
# 查看日志 # 查看日志
docker-compose logs -f sub2api docker compose logs -f sub2api
``` ```
**脚本功能：** **脚本功能：**
@@ -244,16 +244,16 @@ mkdir -p data postgres_data redis_data
# 5. 启动所有服务 # 5. 启动所有服务
# 选项 A：本地目录版（推荐 - 易于迁移） # 选项 A：本地目录版（推荐 - 易于迁移）
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
# 选项 B：命名卷版（简单设置） # 选项 B：命名卷版（简单设置）
docker-compose up -d docker compose up -d
# 6. 查看状态 # 6. 查看状态
docker-compose -f docker-compose.local.yml ps docker compose -f docker-compose.local.yml ps
# 7. 查看日志 # 7. 查看日志
docker-compose -f docker-compose.local.yml logs -f sub2api docker compose -f docker-compose.local.yml logs -f sub2api
``` ```
#### 部署版本对比 #### 部署版本对比
@@ -283,15 +283,15 @@ docker-compose -f docker-compose.local.yml logs -f sub2api
如果管理员密码是自动生成的，在日志中查找： 如果管理员密码是自动生成的，在日志中查找：
```bash ```bash
docker-compose -f docker-compose.local.yml logs sub2api | grep "admin password" docker compose -f docker-compose.local.yml logs sub2api | grep "admin password"
``` ```
#### 升级 #### 升级
```bash ```bash
# 拉取最新镜像并重建容器 # 拉取最新镜像并重建容器
docker-compose -f docker-compose.local.yml pull docker compose -f docker-compose.local.yml pull
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
``` ```
#### 轻松迁移（本地目录版） #### 轻松迁移（本地目录版）
@@ -300,7 +300,7 @@ docker-compose -f docker-compose.local.yml up -d
```bash ```bash
# 源服务器 # 源服务器
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
cd .. cd ..
tar czf sub2api-complete.tar.gz sub2api-deploy/ tar czf sub2api-complete.tar.gz sub2api-deploy/
@@ -310,23 +310,23 @@ scp sub2api-complete.tar.gz user@new-server:/path/
# 新服务器 # 新服务器
tar xzf sub2api-complete.tar.gz tar xzf sub2api-complete.tar.gz
cd sub2api-deploy/ cd sub2api-deploy/
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
``` ```
#### 常用命令 #### 常用命令
```bash ```bash
# 停止所有服务 # 停止所有服务
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
# 重启 # 重启
docker-compose -f docker-compose.local.yml restart docker compose -f docker-compose.local.yml restart
# 查看所有日志 # 查看所有日志
docker-compose -f docker-compose.local.yml logs -f docker compose -f docker-compose.local.yml logs -f
# 删除所有数据（谨慎！） # 删除所有数据（谨慎！）
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
rm -rf data/ postgres_data/ redis_data/ rm -rf data/ postgres_data/ redis_data/
``` ```

64
deploy/README.md
View File

@@ -53,13 +53,13 @@ chmod +x docker-deploy.sh
**After running the script:** **After running the script:**
```bash ```bash
# Start services # Start services
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
# View logs # View logs
docker-compose -f docker-compose.local.yml logs -f sub2api docker compose -f docker-compose.local.yml logs -f sub2api
# If admin password was auto-generated, find it in logs: # If admin password was auto-generated, find it in logs:
docker-compose -f docker-compose.local.yml logs sub2api | grep "admin password" docker compose -f docker-compose.local.yml logs sub2api | grep "admin password"
# Access Web UI # Access Web UI
# http://localhost:8080 # http://localhost:8080
@@ -88,10 +88,10 @@ echo "TOTP_ENCRYPTION_KEY=${TOTP_ENCRYPTION_KEY}" >> .env
mkdir -p data postgres_data redis_data mkdir -p data postgres_data redis_data
# Start all services using local directory version # Start all services using local directory version
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
# View logs (check for auto-generated admin password) # View logs (check for auto-generated admin password)
docker-compose -f docker-compose.local.yml logs -f sub2api docker compose -f docker-compose.local.yml logs -f sub2api
# Access Web UI # Access Web UI
# http://localhost:8080 # http://localhost:8080
@@ -121,7 +121,7 @@ When using Docker Compose with `AUTO_SETUP=true`:
3. If `ADMIN_PASSWORD` is not set, check logs for the generated password: 3. If `ADMIN_PASSWORD` is not set, check logs for the generated password:
```bash ```bash
docker-compose logs sub2api | grep "admin password" docker compose logs sub2api | grep "admin password"
``` ```
### Database Migration Notes (PostgreSQL) ### Database Migration Notes (PostgreSQL)
@@ -162,23 +162,23 @@ For **local directory version** (docker-compose.local.yml):
```bash ```bash
# Start services # Start services
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
# Stop services # Stop services
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
# View logs # View logs
docker-compose -f docker-compose.local.yml logs -f sub2api docker compose -f docker-compose.local.yml logs -f sub2api
# Restart Sub2API only # Restart Sub2API only
docker-compose -f docker-compose.local.yml restart sub2api docker compose -f docker-compose.local.yml restart sub2api
# Update to latest version # Update to latest version
docker-compose -f docker-compose.local.yml pull docker compose -f docker-compose.local.yml pull
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
# Remove all data (caution!) # Remove all data (caution!)
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
rm -rf data/ postgres_data/ redis_data/ rm -rf data/ postgres_data/ redis_data/
``` ```
@@ -186,23 +186,23 @@ For **named volumes version** (docker-compose.yml):
```bash ```bash
# Start services # Start services
docker-compose up -d docker compose up -d
# Stop services # Stop services
docker-compose down docker compose down
# View logs # View logs
docker-compose logs -f sub2api docker compose logs -f sub2api
# Restart Sub2API only # Restart Sub2API only
docker-compose restart sub2api docker compose restart sub2api
# Update to latest version # Update to latest version
docker-compose pull docker compose pull
docker-compose up -d docker compose up -d
# Remove all data (caution!) # Remove all data (caution!)
docker-compose down -v docker compose down -v
``` ```
### Environment Variables ### Environment Variables
@@ -232,7 +232,7 @@ When using `docker-compose.local.yml`, all data is stored in local directories,
```bash ```bash
# On source server: Stop services and create archive # On source server: Stop services and create archive
cd /path/to/deployment cd /path/to/deployment
docker-compose -f docker-compose.local.yml down docker compose -f docker-compose.local.yml down
cd .. cd ..
tar czf sub2api-complete.tar.gz deployment/ tar czf sub2api-complete.tar.gz deployment/
@@ -242,7 +242,7 @@ scp sub2api-complete.tar.gz user@new-server:/path/to/destination/
# On new server: Extract and start # On new server: Extract and start
tar xzf sub2api-complete.tar.gz tar xzf sub2api-complete.tar.gz
cd deployment/ cd deployment/
docker-compose -f docker-compose.local.yml up -d docker compose -f docker-compose.local.yml up -d
``` ```
Your entire deployment (configuration + data) is migrated! Your entire deployment (configuration + data) is migrated!
@@ -492,19 +492,19 @@ For **local directory version**:
```bash ```bash
# Check container status # Check container status
docker-compose -f docker-compose.local.yml ps docker compose -f docker-compose.local.yml ps
# View detailed logs # View detailed logs
docker-compose -f docker-compose.local.yml logs --tail=100 sub2api docker compose -f docker-compose.local.yml logs --tail=100 sub2api
# Check database connection # Check database connection
docker-compose -f docker-compose.local.yml exec postgres pg_isready docker compose -f docker-compose.local.yml exec postgres pg_isready
# Check Redis connection # Check Redis connection
docker-compose -f docker-compose.local.yml exec redis redis-cli ping docker compose -f docker-compose.local.yml exec redis redis-cli ping
# Restart all services # Restart all services
docker-compose -f docker-compose.local.yml restart docker compose -f docker-compose.local.yml restart
# Check data directories # Check data directories
ls -la data/ postgres_data/ redis_data/ ls -la data/ postgres_data/ redis_data/
@@ -514,19 +514,19 @@ For **named volumes version**:
```bash ```bash
# Check container status # Check container status
docker-compose ps docker compose ps
# View detailed logs # View detailed logs
docker-compose logs --tail=100 sub2api docker compose logs --tail=100 sub2api
# Check database connection # Check database connection
docker-compose exec postgres pg_isready docker compose exec postgres pg_isready
# Check Redis connection # Check Redis connection
docker-compose exec redis redis-cli ping docker compose exec redis redis-cli ping
# Restart all services # Restart all services
docker-compose restart docker compose restart
``` ```
### Binary Install ### Binary Install