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

docs: update docker-compose commands to Docker Compose V2 syntax

Browse Source 
The project prerequisites already require Docker Compose v2+, but command
examples still used the legacy `docker-compose` (hyphenated) form. Replace
all command invocations with `docker compose` (space-separated) while
keeping file name references (docker-compose.yml, etc.) unchanged.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Jerry Fan
2026-03-19 18:12:50 +08:00
parent a6764e82f2
commit f2f819d70f
3 changed files with 62 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
deploy/README.md
View File

@@ -53,13 +53,13 @@ chmod +x docker-deploy.sh
**After running the script:**
```bash
# Start services
docker-compose -f docker-compose.local.yml up -d
docker compose -f docker-compose.local.yml up -d
# 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:
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
# http://localhost:8080
@@ -88,10 +88,10 @@ echo "TOTP_ENCRYPTION_KEY=${TOTP_ENCRYPTION_KEY}" >> .env
mkdir -p data postgres_data redis_data
# 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)
docker-compose -f docker-compose.local.yml logs -f sub2api
docker compose -f docker-compose.local.yml logs -f sub2api
# Access Web UI
# 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:
```bash
docker-compose logs sub2api | grep "admin password"
docker compose logs sub2api | grep "admin password"
```
### Database Migration Notes (PostgreSQL)
@@ -162,23 +162,23 @@ For **local directory version** (docker-compose.local.yml):
```bash
# Start services
docker-compose -f docker-compose.local.yml up -d
docker compose -f docker-compose.local.yml up -d
# Stop services
docker-compose -f docker-compose.local.yml down
docker compose -f docker-compose.local.yml down
# 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
docker-compose -f docker-compose.local.yml restart sub2api
docker compose -f docker-compose.local.yml restart sub2api
# Update to latest version
docker-compose -f docker-compose.local.yml pull
docker-compose -f docker-compose.local.yml up -d
docker compose -f docker-compose.local.yml pull
docker compose -f docker-compose.local.yml up -d
# 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/
```
@@ -186,23 +186,23 @@ For **named volumes version** (docker-compose.yml):
```bash
# Start services
docker-compose up -d
docker compose up -d
# Stop services
docker-compose down
docker compose down
# View logs
docker-compose logs -f sub2api
docker compose logs -f sub2api
# Restart Sub2API only
docker-compose restart sub2api
docker compose restart sub2api
# Update to latest version
docker-compose pull
docker-compose up -d
docker compose pull
docker compose up -d
# Remove all data (caution!)
docker-compose down -v
docker compose down -v
```
### Environment Variables
@@ -232,7 +232,7 @@ When using `docker-compose.local.yml`, all data is stored in local directories,
```bash
# On source server: Stop services and create archive
cd /path/to/deployment
docker-compose -f docker-compose.local.yml down
docker compose -f docker-compose.local.yml down
cd ..
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
tar xzf sub2api-complete.tar.gz
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!
@@ -492,19 +492,19 @@ For **local directory version**:
```bash
# Check container status
docker-compose -f docker-compose.local.yml ps
docker compose -f docker-compose.local.yml ps
# 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
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
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
docker-compose -f docker-compose.local.yml restart
docker compose -f docker-compose.local.yml restart
# Check data directories
ls -la data/ postgres_data/ redis_data/
@@ -514,19 +514,19 @@ For **named volumes version**:
```bash
# Check container status
docker-compose ps
docker compose ps
# View detailed logs
docker-compose logs --tail=100 sub2api
docker compose logs --tail=100 sub2api
# Check database connection
docker-compose exec postgres pg_isready
docker compose exec postgres pg_isready
# Check Redis connection
docker-compose exec redis redis-cli ping
docker compose exec redis redis-cli ping
# Restart all services
docker-compose restart
docker compose restart
```
### Binary Install