Skip to content

docs: clarify the INSTALL_* variables are Deployment Helper inputs and list the system:install options - #2588

Open
Daniel Kirkland (d-kirkland) wants to merge 3 commits into
mainfrom
fix/docs-system-install-options-and-deployment-helper-env
Open

Daniel Kirkland (d-kirkland) wants to merge 3 commits into
mainfrom
fix/docs-system-install-options-and-deployment-helper-env

Conversation

@d-kirkland

@d-kirkland Daniel Kirkland (d-kirkland) commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • The Deployment Helper environment page says the INSTALL_* variables "apply only on fresh installation (system:install)". Read literally, this suggests that bin/console system:install reads them. It does not: no Shopware platform source reads INSTALL_ADMIN_USERNAME, INSTALL_ADMIN_PASSWORD, INSTALL_LOCALE or INSTALL_CURRENCY. A chatbot answer built on that reading told users to run INSTALL_ADMIN_USERNAME=... bin/console system:install --basic-setup, which does nothing with those variables.
  • The Commands Reference lists system:install with a one-line description and no options, and no page has a complete option list (--basic-setup, --force and a few others only appear in passing). This PR adds the option list under the System table.
  • Reworded the sentence on the environment page to say the variables are read by Deployment Helper (not by system:install), and that it passes the locale and currency on as --shop-locale and --shop-currency, and links to the option list.
  • Second commit: the section "What gets created on fresh install" said Deployment Helper's system:install creates the admin user, the Storefront sales channel and the theme assignment. Those are separate Deployment Helper steps (user:create, sales-channel:create:storefront, theme:change, the last two only if the Storefront is installed, InstallationManager.php L74, L78-L89 at 368f819); in the platform, system:install creates them only with --basic-setup (SystemInstallCommand.php L131-L156), which Deployment Helper does not pass (L64). The text also claimed SALES_CHANNEL_URL "defaults to http://localhost"; Deployment Helper passes SALES_CHANNEL_URL, else APP_URL, else an empty string (L46-L47); the http://localhost default exists only in the platform's --basic-setup path (SystemInstallCommand.php L143). The page now says an empty URL is passed if neither is set (what is passed, not a verified runtime outcome).

Related links

Docs lines changed:

Platform source (tag v6.7.15.1):

  • SystemInstallCommand.php L50-L60: the eleven options (create-database, drop-database, basic-setup, force, no-assign-theme, shop-name, shop-email, shop-locale, shop-currency, skip-assets-install, skip-first-run-wizard) with their descriptions; force is "Force install even if install.lock exists", not "skip confirmation prompts".
  • git grep -E 'INSTALL_ADMIN|INSTALL_LOCALE|INSTALL_CURRENCY' -- src has no hit at v6.7.15.1, v6.6.10.29, v6.5.8.19 or trunk.
  • v6.6.10.29 (L41-L52) has the same options plus skip-jwt-keys-generation; v6.5.8.19 has no skip-first-run-wizard. Hence the option table says "as of Shopware 6.7" and points to --help.

Deployment Helper (separate package, not part of the platform tags): InstallationManager.php L41-L47, L64, L74 at 368f819 reads the variables itself and calls system:install --create-database --shop-locale=... --shop-currency=... --force, then user:create <name> --password=.... That is the state of the package's main at the time of writing; the behaviour of older released versions was not checked.

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant. (Option names checked at the tag linked above; the relative link to the commands reference was resolved from the page's folder.)
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted. (N/A, no page moved.)
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms. (No new words outside code spans; rumdl@0.2.67 passes on both changed files.)
  • Any required dependent changes in downstream modules have already been merged and published. (N/A)
  • This pull request is ready for review.

Notes

  • This PR was fully AI generated (Claude Code) and requires human review. It has not been merged, approved or reviewed by the AI session. Please verify the claims and the changed text against the source before merging.
  • Scope: main (Shopware 6.7). The Deployment Helper split pages exist on main only.
  • Severity is low to medium: the variables themselves are correct as Deployment Helper inputs; the defect is the ambiguous wording plus the missing option list. An earlier internal list described this as "variables not read by anything"; independent verification against the Deployment Helper source corrected that, so this PR does not claim it.
  • Please check the Deployment Helper sentence against the released Deployment Helper version you document.

🤖 Generated with Claude Code

…nstall options

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@d-kirkland Daniel Kirkland (d-kirkland) added Improvement PR created to append/modify info in the existing article Info Missed To Document Info Missed To Document labels Oct 13, 2026
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: db951a0
Preview: https://developer-documentation-bfajob4zo-shopware-frontends.vercel.app
Workflow run: #5619

@shopware-dev-docs-connector

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Running.
Repository: shopware/docs
Commit: f5d4b72
Preview: Waiting for workflow logs.

… theme assignment with separate commands, and drop the unsupported localhost default

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
… with the installation steps

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement PR created to append/modify info in the existing article Info Missed To Document Info Missed To Document

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant