Repository navigation
docs(pro): add the on-prem support bundle page and its email setup - #16275
Open
stevewallone wants to merge 3 commits into
Open
stevewallone wants to merge 3 commits into
stevewallone wants to merge 3 commits into
Conversation
Documents collecting a support bundle from Settings > License & Support > Support Bundle on a Docker Compose install: choosing the log period, the size caps, Docker log retention, setting up email (Email Settings, DD_EMAIL_URL, Gmail and Microsoft 365 notes), Test Connection, and troubleshooting. Also corrects the messaging connectors page, which pointed SMTP setup at System Settings instead of Email Settings. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
stevewallone
commented
Oct 11, 2026
stevewallone
left a comment
Contributor
Author
There was a problem hiding this comment.
Review (separate session): request changes
I checked this against the current heads of the paired Pro and dojo-compose-cli changes. Since this was written, those changes added recovery behaviour that the page doesn't describe yet.
Out of date
- How it works says
dojo-compose-cliinstalls two systemd units. There are now three:dojo-support-bundle.timeralso starts the service 5 minutes after boot and every 30 minutes, to mark bundles whose collection stopped as failed. - Troubleshooting: "A bundle stays Queued"
- A request the host doesn't pick up within 10 minutes is now shown as Failed ("The host collector did not pick up this request").
- A collection still running after 2 hours is shown as Failed, with a Host Collector Stopped warning on the page.
- In both cases, Collect Logs is available again once the collector is fixed. Worth saying that, and keeping the
systemctl status/journalctlcommands.
- Container log retention should say that:
- an operator's own
COMPOSE_FILE(from the environment or the install's.env) is honoured, with the logging file appended to it; - services that already set their own
logging:are left unchanged.
- an operator's own
Should fix
- No milestone. Please attach the next open milestone, for the same release as the paired Pro change.
Nit
- The menu item is named Email Settings; the page says "Settings > System > Email" in three places.
Checked and accurate: what a bundle contains; the per-container and total log caps; the 200-line fallback; the free-space check, which lowers the per-container cap and fails with the MB free; the 15 MB email limit; the --since values of diagnostics collect; the Gmail and Microsoft 365 guidance; and the gating (Docker Compose only, not Cloud or Helm).
…POSE_FILE Describe the third systemd unit, what a request the host never picked up and a collection cut off mid-run now look like on the page, how the log retention overlay treats an operator's own COMPOSE_FILE and a service's own logging, and name the Email Settings menu entry as it appears. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…tors page Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents a new DefectDojo Pro feature for on-prem Docker Compose installs: a superuser can collect a support bundle (container logs and redacted settings) from Settings > License & Support > Support Bundle, download it, and email it to DefectDojo support, instead of running commands on the server and attaching log files by hand.
What changed
docs/content/get_started/pro/onprem/docker_compose/support_bundle.md:MANIFEST.txtthat names trimmed logs, and the free disk space check;DD_EMAIL_URLas the fallback, the sender address under System Settings, and the page's Test Connection button;dojo-compose-clinow bounds;The page says it applies to Docker Compose only and not to Helm installs, where the feature is hidden.
support_diagnostics.mdlinks to the new page.messaging_connectors.mdpointed SMTP setup at System Settings. It now points at Settings > System > Email Settings, with the sender address under System Settings.Text-only change; no code or screenshots.
Pairs with the DefectDojo Pro change and a
dojo-compose-clirelease that implement the feature; please merge them together.🤖 Generated with Claude Code