Skip to content

Commit a907d35

Browse files
Update README.md
1 parent dc3c82a commit a907d35

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ A real-time dashboard for analyzing Traefik logs with IP geolocation, status cod
4040

4141
3. **Build and run**
4242
```bash
43-
docker-compose up -d
43+
docker compose up -d
4444
```
4545

4646
4. **Access the dashboard**
@@ -191,6 +191,7 @@ Edit `frontend/src/index.css` to customize colors and styling.
191191
- Rate limits may apply for high-traffic sites
192192

193193

194+
## Dev SetUp
194195

195196
### Step 1: Create all directories
196197

@@ -218,8 +219,8 @@ make build
218219
make up
219220

220221
# Or using Docker Compose directly
221-
docker-compose build
222-
docker-compose up -d
222+
docker compose build
223+
docker compose up -d
223224
```
224225

225226
## Configuration Options
@@ -270,22 +271,22 @@ accessLog:
270271
271272
### Basic Deployment
272273
```bash
273-
docker-compose up -d
274+
docker compose up -d
274275
```
275276

276277
### Development Mode
277278
```bash
278-
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
279+
docker compose -f docker-compose.yml -f docker-compose.dev.yml up
279280
```
280281

281282
### Production Mode
282283
```bash
283-
docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d
284+
docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
284285
```
285286

286287
### With Monitoring
287288
```bash
288-
docker-compose -f docker-compose.yml -f docker-compose.monitoring.yml up -d
289+
docker compose -f docker-compose.yml -f docker-compose.monitoring.yml up -d
289290
```
290291

291292
## Testing
@@ -314,17 +315,17 @@ curl http://localhost:3000
314315

315316
1. Check log file path:
316317
```bash
317-
docker-compose exec backend ls -la /logs
318+
docker compose exec backend ls -la /logs
318319
```
319320

320321
2. Verify log format is JSON:
321322
```bash
322-
docker-compose exec backend head -n 1 /logs/traefik.log
323+
docker compose exec backend head -n 1 /logs/traefik.log
323324
```
324325

325326
3. Check backend logs:
326327
```bash
327-
docker-compose logs backend
328+
docker compose logs backend
328329
```
329330

330331
### WebSocket disconnects frequently
@@ -404,7 +405,7 @@ Connect to `ws://localhost:3001` and receive:
404405

405406
For more help, create an issue on GitHub or check the logs:
406407
```bash
407-
docker-compose logs -f --tail=100
408+
docker compose logs -f --tail=100
408409
```
409410
# Traefik Log Dashboard - Quick Reference
410411

@@ -413,26 +414,26 @@ docker-compose logs -f --tail=100
413414
```bash
414415
# Start
415416
./setup.sh # First time setup
416-
docker-compose up -d # Start services
417+
docker compose up -d # Start services
417418
make up # Alternative: using Makefile
418419

419420
# Stop
420-
docker-compose down # Stop services
421+
docker compose down # Stop services
421422
make down # Alternative: using Makefile
422423

423424
# Logs
424-
docker-compose logs -f # View all logs
425-
docker-compose logs backend # Backend logs only
426-
docker-compose logs frontend # Frontend logs only
425+
docker compose logs -f # View all logs
426+
docker compose logs backend # Backend logs only
427+
docker compose logs frontend # Frontend logs only
427428

428429
# Restart
429-
docker-compose restart # Restart all services
430+
docker compose restart # Restart all services
430431
make restart # Alternative: using Makefile
431432

432433
# Update
433434
git pull # Get latest code
434-
docker-compose build --no-cache # Rebuild images
435-
docker-compose up -d # Restart with new images
435+
docker compose build --no-cache # Rebuild images
436+
docker compose up -d # Restart with new images
436437
```
437438

438439
## 🔍 Common Issues & Solutions
@@ -461,19 +462,19 @@ curl http://localhost:3001/api/logs?limit=10 | jq .
461462

462463
```bash
463464
# View running containers
464-
docker-compose ps
465+
docker compose ps
465466

466467
# Enter backend container
467-
docker-compose exec backend sh
468+
docker compose exec backend sh
468469

469470
# Enter frontend container
470-
docker-compose exec frontend sh
471+
docker compose exec frontend sh
471472

472473
# View resource usage
473474
docker stats
474475

475476
# Clean up everything
476-
docker-compose down -v --rmi all
477+
docker compose down -v --rmi all
477478
```
478479

479480
## Important Files
@@ -536,4 +537,4 @@ MIT License - feel free to use in personal and commercial projects.
536537
- IP geolocation by ip-api.com
537538
- Icons by Lucide
538539

539-
---
540+
---

0 commit comments

Comments
 (0)