Skip to content
This repository was archived by the owner on Sep 1, 2025. It is now read-only.

Commit 37d9859

Browse files
committed
[Update]: Docs v1.0.2
1 parent 4326a83 commit 37d9859

File tree

4 files changed

+553
-29
lines changed

4 files changed

+553
-29
lines changed

README-Docker.md

Lines changed: 96 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
# Accounting Panel - Docker Deployment Guide
1+
# PersonalAccounter v1.0.2 - Docker Deployment Guide
22

3-
This guide provides comprehensive instructions for deploying the Accounting Panel using Docker in both development and production environments.
3+
This guide provides comprehensive instructions for deploying PersonalAccounter using Docker in both development and production environments.
4+
5+
## 🆕 What's New in v1.0.2
6+
7+
- **🌐 Enhanced Network Compatibility**: Improved subnet configuration to avoid conflicts
8+
- **🛠️ CLI Management Tools**: New `control-docker` script for easy container management
9+
- **🔧 Network Diagnostics**: `network-check.sh` tool for troubleshooting network issues
10+
- **📊 Adminer Integration**: Lightweight database management interface
11+
- **⚡ Auto-Permission Fixes**: Automatic log directory permission resolution
412

513
## 🚀 Quick Start
614

@@ -191,6 +199,47 @@ The setup script supports various options:
191199

192200
## 🛠️ Management Commands
193201

202+
### 🆕 New CLI Tools (v1.0.2)
203+
204+
#### control-docker Script
205+
Easy container management without Docker expertise:
206+
207+
```bash
208+
# User management
209+
./control-docker user list
210+
./control-docker user create "John Doe" "john@example.com" "password" "admin"
211+
212+
# Database operations
213+
./control-docker migrate run
214+
./control-docker db status
215+
216+
# Interactive shell access
217+
./control-docker shell
218+
219+
# Get help
220+
./control-docker help
221+
```
222+
223+
#### network-check.sh Script
224+
Network troubleshooting and configuration:
225+
226+
```bash
227+
# Check for network conflicts
228+
./network-check.sh check
229+
230+
# Show configuration options
231+
./network-check.sh suggest
232+
233+
# Auto-fix network issues (maximum compatibility)
234+
./network-check.sh auto
235+
236+
# Use custom subnet to avoid conflicts
237+
./network-check.sh subnet 172.29.0.0/24 172.29.0.1
238+
239+
# Clean up existing networks
240+
./network-check.sh fix
241+
```
242+
194243
### Service Management
195244

196245
```bash
@@ -244,6 +293,15 @@ curl http://localhost/health
244293

245294
### Database Management
246295

296+
#### 🆕 Adminer Web Interface (v1.0.2)
297+
Access the lightweight database management interface:
298+
- **URL**: http://localhost:8080
299+
- **Server**: `database` (or leave blank)
300+
- **Username**: `accounting_user` or `root`
301+
- **Password**: Check your `.env` file for credentials
302+
- **Database**: `accounting_panel`
303+
304+
#### Command Line Access
247305
```bash
248306
# Access database directly
249307
docker compose exec database mysql -u root -p
@@ -256,6 +314,9 @@ docker compose exec -T database mysql -u root -p accounting_panel < backup.sql
256314

257315
# View database logs
258316
docker compose logs database
317+
318+
# 🆕 Start Adminer if not running
319+
docker compose up -d adminer
259320
```
260321

261322
## 🔍 Monitoring and Debugging
@@ -437,7 +498,32 @@ netstat -tulpn | grep :80
437498
HTTP_PORT=8080 HTTPS_PORT=8443 docker compose up -d
438499
```
439500

440-
#### 3. Database Connection Issues
501+
#### 🆕 3. Network Conflicts (v1.0.2)
502+
503+
Use the new network diagnostic tool for automatic resolution:
504+
505+
```bash
506+
# Check for network conflicts
507+
./network-check.sh check
508+
509+
# Auto-fix network issues (recommended)
510+
./network-check.sh auto
511+
512+
# Use custom subnet if conflicts persist
513+
./network-check.sh subnet 172.29.0.0/24 172.29.0.1
514+
515+
# Manual network cleanup
516+
./network-check.sh fix
517+
docker compose down
518+
docker compose up -d
519+
```
520+
521+
Common network conflict scenarios:
522+
- **Corporate VPNs**: Often use 172.20.x.x subnets
523+
- **Docker Desktop**: May conflict with default ranges
524+
- **Multiple Docker Projects**: Subnet overlap between projects
525+
526+
#### 4. Database Connection Issues
441527

442528
```bash
443529
# Check database health
@@ -450,12 +536,17 @@ docker compose restart database
450536
docker compose logs database
451537
```
452538

453-
#### 4. Permission Errors
539+
#### 5. Permission Errors
540+
541+
🆕 **v1.0.2 Auto-Fix**: The application now automatically fixes log permission issues on startup.
454542

455543
```bash
456-
# Fix file permissions
544+
# Manual permission fixes (if needed)
457545
sudo chown -R $USER:$USER .
458546
docker compose exec app chown -R www-data:www-data /var/www/html
547+
548+
# 🆕 Restart to trigger auto-fix
549+
docker compose restart app
459550
```
460551

461552
#### 5. CSRF Token Issues

0 commit comments

Comments
 (0)