Skip to main content

Installation

Purpose​

This is the canonical v1.6 install and first bring-up page for jhf-dobby.

It gives the stable bootstrap and verify route that Fabric and docs-platform consumers can rely on, while deeper runtime behavior stays in the existing operations and deployment docs.

Prerequisites​

  • Python 3.11+
  • local editable install with dev dependencies
  • Docker/Compose for runtime-backed verification
  • optional live-host reachability to <internal-runtime-redacted>

Repo-Side Bring-Up​

python -m pip install -e .[dev]
python scripts/validate_contract_conformance.py
python scripts/validate_docs_platform_v1_6.py
python scripts/validate_fabric_consumer_contract.py
python scripts/verify_runtime_materialization.py
python -m pytest -q

Runtime Bring-Up​

export JHF_DOBBY_POSTGRES_PASSWORD=change-me
docker compose -f deploy/compose/jhf-dobby.stack.yml up -d
python scripts/verify_runtime_guardrails.py
python scripts/verify_runtime_materialization.py

The named volumes compose_jhf_dobby_postgres and compose_jhf_dobby_artifacts are compose-managed by this stack. No manual docker volume create ... bootstrap is required before the first up -d.

Use deploy/env/jhf-dobby.host.env.example (deploy/env/jhf-dobby.host.env.example) only as a reference template. Keep the real password in a host-local env file or secret store outside committed repo truth.

Run This Check​

python scripts/validate_docs_platform_v1_6.py
python scripts/verify_runtime_guardrails.py
python scripts/verify_runtime_materialization.py

Supporting Deep-Dive Docs​

  • Deployment Verify (docs/DEPLOYMENT_VERIFY.md)
  • Operations
  • Stack Contract (docs/STACK_CONTRACT.md)

License: AGPLv3. See ../LICENSE (LICENSE). Learn more at helpifyr.com.