Skip to content

[docs] Document deprecation of top-level url/admin_api in favor of environments #2462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shopware-docs-updater wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs] Document deprecation of top-level url/admin_api in favor of environments #2462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions guides/development/dev-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,8 +270,6 @@ The web container exposes these ports by default:
```yaml
compatibility_date: '2026-03-01'

url: http://127.0.0.1:8000

docker:
php:
version: "8.3" # 8.2, 8.3, 8.4, 8.5
Expand All @@ -289,6 +287,8 @@ environments:
password: shopware
```

Shop URL and Admin API credentials belong under `environments` (an empty `-e`/`--env` defaults to `environments.local`). Top-level `url` and `admin_api` keys are deprecated: existing config files that still use them keep working and log a deprecation warning, but `project create` and `project config init` only write `environments.local`.

### `.shopware-project.local.yml`

Sensitive credentials are stored in `.shopware-project.local.yml` (add to `.gitignore`):
Expand Down
4 changes: 3 additions & 1 deletion products/tools/cli/project-commands/helper-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,9 @@ To create a new `.shopware-project.yml` configuration file interactively:
shopware-cli project config init
```

This generates a basic configuration file for your Shopware project. The file is also referenced in development environment setup and deployment configurations.
This generates a basic configuration file for your Shopware project. Shop URL and Admin API credentials are written under `environments.local` (omit `-e`/`--env` on other project commands to target it). The file is also referenced in development environment setup and deployment configurations.

Top-level `url` and `admin_api` keys are deprecated: config files that still use them keep working, but the CLI logs a deprecation warning telling you to move these values under `environments`.

## Generate JWT secret

Expand Down
Loading