alvaro/normogen
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions
normogen/docs/deployment
History
goose 17efc4f656 docs: reconcile documentation with reality (P3) 
Make the project's documentation match the code and remove the sprawl. The docs
claimed Phase 2.8 (drug interactions) was 'planning/0%' and the backend '~91%
complete' — both wrong: 2.8 is implemented and live, plus the P0/P1 security
and test work is done. Five root CI/CD docs described a 'docker-build' CI job
that was removed; ~18 backend/ status snapshots and ~24 docs/implementation
duplicates cluttered the tree.

Deletions (85 files):
- Root: 4 stale CI/CD reports (CI-CD-{COMPLETION-REPORT,IMPLEMENTATION-SUMMARY,
  STATUS-REPORT,FINAL-STATUS}.md) — all describe the removed docker-build job.
- backend/: 18 phase/build/fix snapshots and code-dump .txt files.
- docs/: the 3 one-time reorg reports; ~17 docs/implementation duplicates and
  process artifacts; 4 stale docs/development CI docs + git snapshots;
  redundant deployment/testing files.
- thoughts/: STATUS.md (said Phase 2.4 in-progress), superseded phase notes and
  duplicative research inputs. tmp/ (928KB of CI debug logs, gitignored).

Moves (18 files):
- 9 genuine decision records -> docs/adr/ (Architecture Decision Records),
  date-prefixes stripped, with an index README.
- 8 historical-but-valuable phase plans/specs + the old CI-CD-FINAL-SOLUTION ->
  docs/archive/ (now-populated, with a README explaining it's superseded
  material). thoughts/ tree removed.

Rewrites (13 files) to match reality:
- Drop the fake '% complete' figures everywhere in favor of Implemented /
  In-Progress / Planned with concrete endpoint/feature lists.
- Phase 2.8 -> Implemented; add /api/interactions/* and /api/auth/{refresh,
  logout} to the endpoint lists; fix 'Rust 1.93' -> edition 2021.
- Add a Security section (token_version validation, hashed refresh-token
  persistence, fail-fast config, real-IP audit) and correct the test-coverage
  and deployment claims to reality.
- New canonical docs/development/CI-CD.md (4 jobs: format/clippy/build/test,
  mongo service, no docker-build + why).
- README, docs/README, product/{STATUS,ROADMAP,PROGRESS,README,introduction},
  implementation/README, development/README, testing/README, AI_AGENT_GUIDE,
  .cursorrules, .gooserules all updated.

Verified: greps for 'Phase 2.8 (Planning)', 'PLANNING (0%)', 'Rust 1.93',
'91%/10%/85% complete', and 'docker-build' return nothing outside docs/archive;
all internal doc links resolve; backend/src untouched (cargo build clean).
2026-06-27 16:02:16 -03:00
..
deploy-and-test-solaria.sh docs(ai): reorganize documentation and update product docs 2026-03-09 11:04:44 -03:00
deploy-and-test.sh docs(ai): reorganize documentation and update product docs 2026-03-09 11:04:44 -03:00
deploy-local-build.sh docs(ai): reorganize documentation and update product docs 2026-03-09 11:04:44 -03:00
deploy-to-solaria.sh docs(ai): reorganize documentation and update product docs 2026-03-09 11:04:44 -03:00
DEPLOYMENT_GUIDE.md docs(ai): reorganize documentation and update product docs 2026-03-09 11:04:44 -03:00
README.md docs(ai): reorganize documentation and update product docs 2026-03-09 11:04:44 -03:00

README.md

Deployment Documentation

This section contains deployment guides, Docker configuration, and deployment automation scripts.

📚 Guides

Getting Started

Docker Optimization

🚀 Deployment Scripts

General Deployment

Solaria Deployment

🐳 Docker Deployment

Quick Start

cd backend
docker compose up -d

Environment Configuration

Required environment variables:

  • DATABASE_URI - MongoDB connection string
  • DATABASE_NAME - Database name
  • JWT_SECRET - JWT signing secret (min 32 chars)
  • SERVER_HOST - Server host (default: 0.0.0.0)
  • SERVER_PORT - Server port (default: 8080)
  • RUST_LOG - Log level (debug/info/warn)

Health Check

curl http://localhost:8000/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