Skip to content

docs(pro): add the on-prem support bundle page and its email setup - #16275

Open
stevewallone wants to merge 3 commits into
DefectDojo:devfrom
stevewallone:docs/support-bundle
Open

stevewallone wants to merge 3 commits into
DefectDojo:devfrom
stevewallone:docs/support-bundle

Conversation

@stevewallone

@stevewallone stevewallone commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

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

  • New page docs/content/get_started/pro/onprem/docker_compose/support_bundle.md:
    • what a bundle contains and the steps to collect one, including choosing the log period (last hour, 24 hours, 7 days, or all available);
    • how much log a bundle holds (50 MB per container and 250 MB in all, newest lines first), the MANIFEST.txt that names trimmed logs, and the free disk space check;
    • setting up email: Email Settings first, DD_EMAIL_URL as the fallback, the sender address under System Settings, and the page's Test Connection button;
    • notes for Google Workspace and Gmail (app passwords, or allowing the server on the SMTP relay) and for Microsoft 365, plus Download as the fallback;
    • container log retention, which dojo-compose-cli now bounds;
    • troubleshooting for the host collector, disk space and email.
      The page says it applies to Docker Compose only and not to Helm installs, where the feature is hidden.
  • support_diagnostics.md links to the new page.
  • messaging_connectors.md pointed 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-cli release that implement the feature; please merge them together.

🤖 Generated with Claude Code

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 stevewallone left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  1. How it works says dojo-compose-cli installs two systemd units. There are now three: dojo-support-bundle.timer also starts the service 5 minutes after boot and every 30 minutes, to mark bundles whose collection stopped as failed.
  2. 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 / journalctl commands.
  3. 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.

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).

stevewallone and others added 2 commits October 11, 2026 10:59
…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

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant