Skip to content

docs: update Devenv legacy setup for frosh/devenv-meta 0.4 - #2558

Merged
Micha Hobert (Isengo1989) merged 3 commits into
shopware:mainfrom
GregorLohaus:docs/devenv-recipe-0.4
Oct 8, 2026
Merged

Micha Hobert (Isengo1989) merged 3 commits into
shopware:mainfrom
GregorLohaus:docs/devenv-recipe-0.4

Conversation

@GregorLohaus

Copy link
Copy Markdown
Contributor

Summary

Bring the Devenv pages in line with the 0.4 recipe and Devenv 2.4

Related links

pull request

Checklist

  • [ x] I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • [ x] I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • [ x] I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • [ x] Any required dependent changes in downstream modules have already been merged and published.
  • [ x] This pull request is ready for review.

Notes

  • No pages were moved or renamed, so no redirects were needed.
  • Added nixpkgs to .wordlist.txt.

Bring the Devenv pages in line with the 0.4 recipe and Devenv 2.4:

- Create the project and add frosh/devenv-meta with `nix run` Composer,
  so no PHP or Composer is needed on the host
- Require Devenv 2.4+, install it with `nix profile add nixpkgs#devenv`
- Document strict ports, automatic DATABASE_URL/MAILER_DSN and the
  automatically created database and user
- MailHog → Mailpit, Adminer port 9080 → 8010, mention Caddy's admin API
- Fix demo data instructions (needs shopware/dev-tools; `composer setup`
  only exists in shopware/shopware)
- Add RabbitMQ, OpenSearch and "multiple projects" sections
- Use lib.mkForce where the recipe sets values explicitly (MySQL package,
  Caddy virtual hosts), and update the sales channel domain on port changes
- Replace the broken mysql80 overrideAttrs example with a pinned nixpkgs input
- Replace non-existent `devenv reload` and the kill-all-Nix-processes command
- Fix indentation of all Nix examples and remove nodejs-18_x

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@shopware-dev-docs-connector

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

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: GregorLohaus/docs
Commit: 711fe28
Preview: https://developer-documentation-p6vcsmyqa-shopware-frontends.vercel.app
Workflow run: #5540

Fork PRs need approval from a maintainer with write access before the healthcheck can run. GitHub approves only the latest commit, so every new commit pushed after approval needs another approval.

@JoshuaBehrens

Copy link
Copy Markdown
Contributor

Glad to see updates on a "legacy" setup :)

@Isengo1989
Micha Hobert (Isengo1989) requested a balanced review from Copilot October 5, 2026 09:32
@Isengo1989 Micha Hobert (Isengo1989) added the Improvement PR created to append/modify info in the existing article label Oct 5, 2026

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.

Copilot review overview

🟡 Changes recommended

The multi-project Caddy guidance and custom-domain database command can produce incorrect configurations.

Review effort: Balanced
Findings: 4 Low severity

Open (4)
What changed in this PR

Updates the legacy Shopware Devenv documentation for frosh/devenv-meta 0.4 and Devenv 2.4.

Changes:

  • Updates installation, services, ports, and environment variables.
  • Adds RabbitMQ, OpenSearch, and multi-project guidance.
  • Adds nixpkgs to the spellcheck wordlist.
File Description
.wordlist.txt Allows the nixpkgs term
devenv-setup.md Updates setup and service documentation
devenv-options.md Expands customization guidance

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

The SQL example hardcoded http://127.0.0.1:8001, which only matched the
"Change port only" tab. Use the APP_URL and MYSQL_TCP_PORT variables that
Devenv exports instead, so the command matches every example on the page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Caddy opens all TCP listeners, including the admin API, with SO_REUSEPORT
on Unix systems, so multiple Devenv projects share 127.0.0.1:2019.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Isengo1989

Copy link
Copy Markdown
Contributor

Thank you for the PR Gregor Lohaus (@GregorLohaus) 👍

@Isengo1989
Micha Hobert (Isengo1989) merged commit 2052771 into shopware:main Oct 8, 2026
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants