will/unitforge
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs(readme): update Docker section with current status and workarounds

Browse Source 
- Document Docker networking issues in main README
- Add host networking workaround instructions
- Update Docker command examples with current status
- Recommend native development as primary option
- Reference docker/README.md for detailed troubleshooting
- Update quick start section with networking alternatives
This commit is contained in:
William Valentin
2025-09-14 17:00:03 -07:00
parent 348a9817a3
commit e313de31e3
1 changed files with 28 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -80,8 +80,11 @@ make server
# Custom configuration # Custom configuration
./start-server.sh --host 127.0.0.1 --port 3000 --log-level debug ./start-server.sh --host 127.0.0.1 --port 3000 --log-level debug
# Docker development # Docker development (if networking works)
make docker-dev make docker-dev
# Docker with host networking (workaround)
make docker-dev-host
``` ```
Access the web interface at: **http://localhost:8000** Access the web interface at: **http://localhost:8000**
@@ -372,10 +375,10 @@ uv pip show <pkg> # Show package info
**Docker Development:** **Docker Development:**
```bash ```bash
make docker-build # Build all images make docker-build # Build images (may fail due to networking)
make docker-dev # Start dev environment make docker-dev # Development environment
make docker-test # Run tests in container make docker-dev-host # Development with host networking (workaround)
make docker-clean # Clean up containers make docker-clean # Clean up containers
``` ```
### Code Style ### Code Style
@@ -387,6 +390,9 @@ make docker-clean # Clean up containers
## 🐳 Docker Support ## 🐳 Docker Support
⚠️ **Current Status**: Docker networking issues prevent standard container builds. Use native development instead.
### Container Templates
UnitForge includes templates for containerized services: UnitForge includes templates for containerized services:
```bash ```bash
@@ -401,6 +407,23 @@ UnitForge includes templates for containerized services:
--param image=registry.example.com/myapp:v1.0 --param image=registry.example.com/myapp:v1.0
``` ```
### Docker Commands (when networking is fixed)
```bash
make docker-build # Build images
make docker-dev # Development environment
make docker-prod # Production environment
make docker-dev-host # Development with host networking (workaround)
make docker-clean # Clean up containers
```
**Recommended**: Use native development until Docker networking is resolved:
```bash
source .venv/bin/activate
./start-server.sh
```
See `docker/README.md` for detailed Docker troubleshooting and workarounds.
## 🔍 Validation Features ## 🔍 Validation Features
UnitForge provides comprehensive validation: UnitForge provides comprehensive validation: