Repository navigation
docs(onprem): document doctor, certs and offline upgrade bundles for Compose - #16300
Conversation
…Compose Add a page for dojo-compose-cli doctor (including --fix) and certs status, add-ca and test. Lead the air-gapped upgrade with bundle create and app upgrade --bundle, keeping the manual path for CLI 2.1.5 and earlier. Update the air-gapped SSO troubleshooting row for the clearer message newer releases show on an IdP certificate failure. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Lead the air-gapped upgrade with the CLI condition and the --help test, describe the bundle's disk needs and check order, drop the unreleased SSO message promise, document the merged REQUESTS_CA_BUNDLE log line from 3.4.0, and show how to build the CA bundle before 3.4.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Review: APPROVE (two rounds), hold the merge until the dojo-compose-cli releaseReviewed by a separate session that did not write this PR. Every flag, default, refusal and quoted message was checked against the Hold. This branch deploys to docs.defectdojo.com on merge. The commands it documents ( Fixed after round 1:
Fixed after round 2: the pre-3.4.0 paragraph says to use it instead of the Both builds (development and production) are clean. It merges cleanly with #16298 and #16301. 🤖 Generated with Claude Code |
Description
Documents the
dojo-compose-clicommands that had no docs page, and reworks the air-gapped upgrade around the new offline bundle.New page: Checking a Deployment with doctor and certs (
docker_compose/checking_a_deployment.md)doctor: what each section checks, OK/warning/failure, exit codes,--strict,--offline, and what--fixchanges (ownership ofmedia/, and movingDOJO_CLI_KEYand the proxy out of the systemd unit'sEnvironment=lines).certs status: what it inspects and when it fails or warns, plus--strict.certs add-ca: both CA bundles,--app-only,--connectors-only,--restart, and the rule that options go before file names.certs testandcerts test --connectors: how to read theOK/FAILED/trust store:output.certs installandcerts self-signed, which ship in the same release.Each of these commands ships in the next
dojo-compose-clirelease after 2.1.5. 2.1.5 is the latest release and does not include them, so the pages say "the next release" and give no version number. Every section links to the manual steps for older CLIs.Air-gapped install page
bundle createon the staging host (--defectdojo-version,--output,--extra-image), thenapp upgrade --bundleon the air-gapped host. It also explains what the CLI verifies before it changes anything.app upgraderow in the air-gapped command table mentions--bundle.certificate verify failedtext, notes that a later DefectDojo release replaces it with a clearer message on the login form, and points the fix tocerts add-caandcerts test. It also describes theREQUESTS_CA_BUNDLE set tolog line, which from DefectDojo 3.4.0 names a merged file (system roots + /app/certs/private/dojo-ca-bundle.crt).app upgrade --bundleruns.Other pages
doctor.dojo-ca-bundle.crtfrom the host's public roots on DefectDojo before 3.4.0, documents the 3.4.0 log line, and points tocerts add-ca. This PR does not touch the sections that docs(onprem): recover a Compose first install that gives up during initialization #16298 edits.Test results
npm ci && npm run build -- --environment developmentandhugo --config config/production/hugo.tomlindocs/: both finish with no warnings or errors.public/output.Checklist
dev.Only the English pages are updated. The translated pages will lag until they are regenerated.
🤖 Generated with Claude Code