Skip to content

docs: document Composer-in-container and PHP memory limit for CLI Docker - #2436

Merged
Su (sushmangupta) merged 4 commits into
mainfrom
docs/cli-docker-composer-memory
Aug 20, 2026
Merged

Su (sushmangupta) merged 4 commits into
mainfrom
docs/cli-docker-composer-memory

Conversation

@shyim

Copy link
Copy Markdown
Member

Summary

  • Document that Docker-based Shopware CLI projects should run Composer, PHP, and npm inside the web container (docker compose exec web …), not on the host.
  • Call out that the development TUI Setup health → Runtime → Memory limit check reflects container PHP, not host Composer PHP.
  • Surface the Shopware requirement memory_limit ≥ 512M on the CLI/dev documentation path (installation, start-developing, CLI index, helper commands).
  • Add troubleshooting for the common host-side OOM (Allowed memory size of 134217728 bytes exhausted).

Addresses the documentation gap discussed in shopware/shopware-cli#1343.

Test plan

  • Preview docs and confirm the new section renders: Development Environment → Running Composer, PHP, and npm
  • Follow links from Installation, Start Developing, CLI index, and helper commands to the new section
  • Verify anchor #running-composer-php-and-npm works in the developer portal preview

Clarify that Docker projects should run Composer inside the web container,
that the TUI runtime memory check does not cover host PHP, and that
Shopware requires memory_limit ≥ 512M when running PHP on the host.

Related to shopware/shopware-cli#1343.
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 12, 2026 •

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: f54f9f2
Preview: https://developer-documentation-qqmxbpjrf-shopware-frontends.vercel.app
Workflow run: #4933

@shyim
Soner (shyim) marked this pull request as ready for review August 13, 2026 07:32
Copilot AI lite review requested due to automatic review settings August 13, 2026 07:32
@github-actions

Copy link
Copy Markdown
Contributor

📊 Documentation Impact Analyzer

Metric Result
Score 18
Recommendation ✅ Highly meaningful
Categories None

Reasons

  • +4: 2 new headings
  • +8: Code examples
  • +4: Code examples
  • +2: 1 new headings

This score is automatically generated based on documentation impact heuristics.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Documents the Docker-first workflow for Shopware CLI projects by clarifying that Composer/PHP/npm commands should be executed inside the web container, and by surfacing the memory_limit ≥ 512M requirement and common host-side OOM troubleshooting across key entry points in the docs.

Changes:

  • Adds cross-links and callouts to run Composer/PHP/npm inside docker compose exec web … for Docker-based projects.
  • Clarifies that the DevTUI “Setup health → Runtime → Memory limit” reflects container PHP, not host PHP used by a local Composer binary.
  • Adds a troubleshooting note for the common host-side memory exhaustion error (Allowed memory size of 134217728 bytes exhausted).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
products/tools/cli/project-commands/helper-commands.md Adds a Docker-specific note linking to the new “Running Composer, PHP, and npm” section and the memory limit requirement.
products/tools/cli/project-commands/dev-environment.md Adds an additional “Further reading” entry pointing to the new container-tools guidance.
products/tools/cli/index.md Updates requirements guidance to point to hosting “recommended stack” (incl. memory limit) and links Docker users to the new section.
guides/installation/project-overview.md Adds docker compose exec web … as a core day-to-day command and explains why host Composer/PHP differs from container runtime.
guides/installation/index.md Adds a tip admonition emphasizing container-executed Composer/PHP tools for Docker installs and links to the new section.
guides/development/start-developing.md Adds a dedicated section on running Composer inside the container and updates private Composer registry auth guidance.
guides/development/dev-environment.md Expands DevTUI runtime/memory explanation, adds a new “Running Composer, PHP, and npm” section, and adds OOM troubleshooting.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread guides/installation/index.md Resolved
Comment thread guides/installation/project-overview.md Resolved
Comment thread guides/installation/project-overview.md Resolved
Comment thread guides/development/dev-environment.md Resolved
Comment thread guides/development/start-developing.md Resolved
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@shyim

Copy link
Copy Markdown
Member Author

Su (@sushmangupta) yes it was right applied it

@sushmangupta Su (sushmangupta) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR Soner (@shyim) :)

@sushmangupta
Su (sushmangupta) merged commit 18d3e5d into main Aug 20, 2026
9 checks passed
@sushmangupta
Su (sushmangupta) deleted the docs/cli-docker-composer-memory branch August 20, 2026 08:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants