Skip to content

docs(onprem): fix the Docker Compose install guide from an end-to-end install run - #16090

Merged
Maffooch merged 4 commits into
bugfixfrom
docs/onprem-install-fixes
Sep 25, 2026
Merged

Maffooch merged 4 commits into
bugfixfrom
docs/onprem-install-fixes

Conversation

@Maffooch

@Maffooch Maffooch commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

[sc-15945]

Description

Corrections to the Docker Compose install guide, found by following it end to end on a fresh two-host install of 3.3.200 with dojo-compose-cli 2.1.4.

  • Database setup: shows how to run the SQL (sudo -u postgres psql) and links the PostgreSQL tuning table in Hardware Sizing.
  • Install wizard: removes the "Deploy Version" row (2.1.4 doesn't ask it) and recommends pinning a release from the Pro changelog instead of latest. Adds a checksums.txt integrity check for the archive, shows sudo -E at first-install, and says what to do if the printed admin password doesn't work (app change-password).
  • TLS certificate: the shipped certificate is a placeholder for a different hostname, not self-signed. The replacement steps now give ownership and modes (dojosrv:root, 0644 cert, 0640 key) that the nginx container can read, and a check that nginx is serving afterwards.
  • Inbound access: a new section. Allow 80/443, keep the other published ports off the network, and note that ufw does not cover Docker-published ports.
  • Troubleshooting: a short note on the systemd unit restart loop after a reboot, and why not to systemctl stop an active unit.

English only, matching recent on-prem doc PRs. The Kubernetes page is generated from the Helm chart repository, so its fixes go there.

Targets bugfix, per the current convention. If #16086 merges first, this can be retargeted to dev.

Test results

  • hugo --minify --gc --config config/production/hugo.toml builds with no errors.
  • I checked the new links and anchors by hand in the built site. lychee was not run.
  • I have not run the new commands on a live host from the updated page.

🤖 Generated with Claude Code

Maffooch and others added 4 commits September 25, 2026 10:41
…ning

Tell readers to open psql as the postgres superuser before the CREATE
statements, and point to the Hardware Sizing database tuning section at
the database step.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Drop the Deploy Version prompt from the table. The wizard only shows
  it in developer mode; the deployment files follow the DefectDojo
  version.
- Say that the version defaults to latest and recommend pinning a
  release from the Pro changelog.
- Add an archive integrity check against the release's checksums.txt.
- Show exporting DOJO_CLI_KEY and running first-install with sudo -E.
- Point to change-password if the printed admin password does not work.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The shipped certificate is a placeholder for another hostname, not a
usable self-signed certificate, so say it must be replaced. Give the
ownership and modes nginx needs (it runs as UID 1002 with group 0, so
a dojosrv:dojosrv 0640 key stops it from starting) and add a check that
nginx is up after the restart.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…p note for compose

- Say that users need only 80 and 443, and that the stack also publishes
  9142 (MCP server) and 9871 (orchestration) on all interfaces. Because
  Docker's rules for published ports bypass ufw, restrict them at the
  network firewall or in the DOCKER-USER chain.
- Add a troubleshooting entry for the unit repeatedly failing with
  "already running": disable the unit rather than stopping it, since
  its ExecStop runs app stop and removes the containers.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Maffooch Maffooch added this to the 3.3.300 milestone Sep 25, 2026
@github-actions github-actions Bot added the docs label Sep 25, 2026
@Maffooch
Maffooch enabled auto-merge September 25, 2026 18:22
@Maffooch
Maffooch added this pull request to the merge queue Sep 25, 2026
Merged via the queue into bugfix with commit 3c367da Sep 25, 2026
31 checks passed
@Maffooch
Maffooch deleted the docs/onprem-install-fixes branch September 25, 2026 20:44
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.

3 participants