fff1ed2e6d
Resolve the operational/config sprawl (#10-#14 from the review): the app read NORMOGEN_*/MONGODB_* env vars but every env/compose file set SERVER_*/DATABASE_*, the ports were all over the place (8080/8000/6500/6800), there were 5 inconsistent Dockerfiles (rust:1.82 vs rust:1.93, missing curl), and an 18 MB binary was committed. Env-var names — standardize on what the code reads: * config/mod.rs: NORMOGEN_PORT default 8080 -> 6500 (avoid the over-common 8000/8080). * db/mod.rs: create_database() now reads MONGODB_DATABASE (was DATABASE_NAME). * .env.example, defaults.env, docker-compose.yml, docker-compose.dev.yml, DEPLOYMENT_GUIDE.md, deployment/README.md, deploy-and-test-solaria.sh, deploy-local-build.sh: use NORMOGEN_HOST/NORMOGEN_PORT/MONGODB_URI/ MONGODB_DATABASE/APP_ENVIRONMENT; drop the dead SERVER_*/DATABASE_URI/ DATABASE_NAME names. Ports — canonical container port 6500 everywhere: * Both Dockerfiles EXPOSE 6500; prod compose maps 6500:6500, dev 6501:6500. * Bulk-replaced the long tail of solaria:8000/localhost:8000/localhost:8080 in docs and test scripts -> 6500. Dockerfiles — 2 canonical, rust:latest, curl + healthcheck: * backend/Dockerfile (prod): rust:latest builder, debian runtime now installs curl (so the compose HEALTHCHECK actually works), EXPOSE 6500. * backend/docker/Dockerfile.dev (dev): rust:latest both stages, EXPOSE 6500. * Deleted 3 redundant Dockerfiles (Dockerfile.improved x2, docker/Dockerfile). * Deleted the committed 18 MB binary backend/docker/normogen-backend. * Deleted 2 stray fix-notes in backend/docker/. Compose: * docker-compose.yml: correct env names, 6500:6500, APP_ENVIRONMENT=production, JWT_SECRET/ENCRYPTION_KEY required via compose interpolation, dropped the obsolete top-level version: key. * docker-compose.dev.yml: correct env names, 6501:6500, mongo:7 (was 6.0), added a working backend healthcheck. * Deleted docker/docker-compose.improved.yml + backend/deploy-to-solaria-improved.sh (built around the now-deleted 'improved' Docker files). Verified: cargo fmt --check clean, build + clippy --all-targets clean, 18 unit tests pass; grep confirms no SERVER_*/DATABASE_* env names and no rust:1.x tags remain outside docs/archive and docs/adr (historical).
89 lines
2.5 KiB
Markdown
89 lines
2.5 KiB
Markdown
# Deployment Documentation
|
|
|
|
This section contains deployment guides, Docker configuration, and deployment automation scripts.
|
|
|
|
## 📚 Guides
|
|
|
|
### Getting Started
|
|
- **[DEPLOYMENT_GUIDE.md](./DEPLOYMENT_GUIDE.md)** - Complete deployment guide (7.8K)
|
|
- **[DEPLOY_README.md](./DEPLOY_README.md)** - Deployment quick reference
|
|
- **[QUICK_DEPLOYMENT_REFERENCE.md](./QUICK_DEPLOYMENT_REFERENCE.md)** - Quick command reference
|
|
|
|
### Docker Optimization
|
|
- **[DOCKER_DEPLOYMENT_IMPROVEMENTS.md](./DOCKER_DEPLOYMENT_IMPROVEMENTS.md)** - Docker optimization notes (15K)
|
|
- **[DOCKER_IMPROVEMENTS_SUMMARY.md](./DOCKER_IMPROVEMENTS_SUMMARY.md)** - Summary of improvements
|
|
|
|
## 🚀 Deployment Scripts
|
|
|
|
### General Deployment
|
|
- **[deploy-and-test.sh](./deploy-and-test.sh)** - Deploy and run tests
|
|
- **[deploy-local-build.sh](./deploy-local-build.sh)** - Local deployment build
|
|
|
|
### Solaria Deployment
|
|
- **[deploy-to-solaria.sh](./deploy-to-solaria.sh)** - Deploy to Solaria server
|
|
- **[deploy-and-test-solaria.sh](./deploy-and-test-solaria.sh)** - Deploy and test on Solaria
|
|
- **[deploy-to-solaria-manual.sh](./deploy-to-solaria-manual.sh)** - Manual Solaria deployment
|
|
|
|
## 🐳 Docker Deployment
|
|
|
|
### Quick Start
|
|
```bash
|
|
cd backend
|
|
docker compose up -d
|
|
```
|
|
|
|
### Environment Configuration
|
|
Required environment variables:
|
|
- `MONGODB_URI` - MongoDB connection string
|
|
- `MONGODB_DATABASE` - Database name
|
|
- `JWT_SECRET` - JWT signing secret (min 32 chars)
|
|
- `NORMOGEN_HOST` - Server host (default: 0.0.0.0)
|
|
- `NORMOGEN_PORT` - Server port (default: 6500)
|
|
- `APP_ENVIRONMENT` - `development` (default) or `production`
|
|
- `RUST_LOG` - Log level (debug/info/warn)
|
|
|
|
### Health Check
|
|
```bash
|
|
curl http://localhost:6500/health
|
|
```
|
|
|
|
## 🌐 Deployment Environments
|
|
|
|
### Local Development
|
|
- Uses `docker-compose.dev.yml`
|
|
- Hot reloading enabled
|
|
- Debug logging
|
|
- Port 8000 → 8080
|
|
|
|
### Production (Solaria)
|
|
- Uses `docker-compose.yml`
|
|
- Optimized image
|
|
- Release logging
|
|
- Health checks configured
|
|
- Automatic restarts
|
|
|
|
## 🔧 Deployment Checklist
|
|
|
|
### Pre-Deployment
|
|
- [ ] Update `JWT_SECRET` in production
|
|
- [ ] Verify MongoDB connection string
|
|
- [ ] Check environment variables
|
|
- [ ] Run test suite
|
|
- [ ] Build Docker image
|
|
|
|
### Post-Deployment
|
|
- [ ] Verify health endpoint
|
|
- [ ] Check application logs
|
|
- [ ] Run API tests
|
|
- [ ] Monitor resource usage
|
|
|
|
## 📊 Deployment Status
|
|
|
|
**Current Deployment**: Solaria (homelab server)
|
|
**Backend Port**: 8000 (external) → 8080 (internal)
|
|
**MongoDB Port**: 27017
|
|
**Status**: ✅ Operational
|
|
|
|
---
|
|
|
|
*Last Updated: 2026-03-09*
|