Repository navigation
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
Conversation
…nstall options Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Developer Docs healthcheckStatus: Completed with |
Developer Docs healthcheckStatus: Running. |
… 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>
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.
Summary
INSTALL_*variables "apply only on fresh installation (system:install)". Read literally, this suggests thatbin/console system:installreads them. It does not: no Shopware platform source readsINSTALL_ADMIN_USERNAME,INSTALL_ADMIN_PASSWORD,INSTALL_LOCALEorINSTALL_CURRENCY. A chatbot answer built on that reading told users to runINSTALL_ADMIN_USERNAME=... bin/console system:install --basic-setup, which does nothing with those variables.system:installwith a one-line description and no options, and no page has a complete option list (--basic-setup,--forceand a few others only appear in passing). This PR adds the option list under the System table.system:install), and that it passes the locale and currency on as--shop-localeand--shop-currency, and links to the option list.system:installcreates 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.phpL74, L78-L89 at368f819); in the platform,system:installcreates them only with--basic-setup(SystemInstallCommand.phpL131-L156), which Deployment Helper does not pass (L64). The text also claimedSALES_CHANNEL_URL"defaults tohttp://localhost"; Deployment Helper passesSALES_CHANNEL_URL, elseAPP_URL, else an empty string (L46-L47); thehttp://localhostdefault exists only in the platform's--basic-setuppath (SystemInstallCommand.phpL143). 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:
environment.mdL51 (sentence above the variable table)commands-reference.mdL397-L408 (new option table after the System table)Platform source (tag
v6.7.15.1):SystemInstallCommand.phpL50-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;forceis "Force install even if install.lock exists", not "skip confirmation prompts".git grep -E 'INSTALL_ADMIN|INSTALL_LOCALE|INSTALL_CURRENCY' -- srchas no hit atv6.7.15.1,v6.6.10.29,v6.5.8.19ortrunk.v6.6.10.29(L41-L52) has the same options plusskip-jwt-keys-generation;v6.5.8.19has noskip-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.phpL41-L47, L64, L74 at368f819reads the variables itself and callssystem:install --create-database --shop-locale=... --shop-currency=... --force, thenuser:create <name> --password=.... That is the state of the package'smainat the time of writing; the behaviour of older released versions was not checked.Checklist
PageRefreferences where relevant. (Option names checked at the tag linked above; the relative link to the commands reference was resolved from the page's folder.).gitbook.yamlif pages were moved, renamed, or deleted. (N/A, no page moved.).wordlist.txt(and sorted it) if spellcheck flags new legitimate terms. (No new words outside code spans;rumdl@0.2.67passes on both changed files.)Notes
main(Shopware 6.7). The Deployment Helper split pages exist onmainonly.🤖 Generated with Claude Code