You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: concepts/api/index.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,3 +21,7 @@ Both APIs use HTTP and exchange JSON payloads. The Administration API requires O
21
21
* Header-based contextual behavior
22
22
23
23
These patterns form the foundation of integration development.
24
+
25
+
## Start building
26
+
27
+
Use the [API](../../guides/development/integrations-api/index.md) guide for practical API setup, authentication, request examples, and links to the generated API reference.
Copy file name to clipboardExpand all lines: concepts/extensions/index.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,12 @@ Starting with Shopware 6.4.0.0, we introduced a new way to extend Shopware using
22
22
Plugins are executed within the Shopware Core process and can react to events, execute custom code or extend services. They have direct access to the database and guidelines are in place to ensure update-compatibility, such as a service facade or database migrations.
23
23
24
24
::: warning
25
-
**Plugins and Shopware cloud** - Due to their direct access to the Shopware process and the database, plugins are not supported by Shopware cloud.
25
+
Due to their direct access to the Shopware process and the database, **plugins are not supported by Shopware cloud**.
26
26
:::
27
27
28
-
## Start coding
28
+
## Start building
29
29
30
-
Refer to our Guides section for an [overview of how apps and plugins differ](../../guides/plugins/index).
30
+
Use the [Extensions](../../guides/development/extensions/index.md) guide to choose between apps and plugins, or go directly to the implementation path you need:
31
+
32
+
-[App Base Guide](../../guides/plugins/apps/app-base-guide.md)
33
+
-[Plugin Base Guide](../../guides/plugins/plugins/plugin-base-guide.md)
Copy file name to clipboardExpand all lines: guides/development/integrations-api/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ This guide helps you make your first successful API request. Your Shopware insta
11
11
12
12
Shopware provides two HTTP APIs:
13
13
14
-
-**Admin API** for backend operations such as products, orders, customers, plugins, and (via the Sync API) bulk processing
14
+
-**Admin API** for backend operations such as products, orders, customers, plugins, and — via the Sync API — bulk operations (for example, mass imports)
15
15
-**Store API** for storefront-facing interactions such as headless frontends, mobile apps, carts, checkout, and sales channel access
16
16
17
17
For the complete endpoint reference and schemas, use the official Stoplight documentation:
|`bin/console`| Commands provided by the Shopware application itself, such as plugin lifecycle commands, database migrations, cache clearing, scheduled tasks, and system inspection. |
19
+
|[`shopware-cli`](https://github.com/shopware/shopware-cli/)| Project and extension tooling around Shopware, such as creating projects, running the development environment, building assets, validating and packaging extensions, Store interaction, and CI workflows. |
20
+
|`shopware-cli project console <command>`| Running a Shopware `bin/console` command through Shopware CLI when you want the CLI to resolve the project context for you. |
21
+
|`swx <command>`| Short alias for `shopware-cli project console <command>`, useful for daily development commands. |
22
+
|`shopware-cli project dev`| Starting the interactive local development environment and TUI for managing the Docker-based stack, logs, watchers, and common development tasks. |
23
+
24
+
As a rule of thumb: use `bin/console` for application-level Shopware commands, use `shopware-cli` for project, extension, build, CI, and development-environment workflows, and use `swx` when you want a quick wrapper around `bin/console`.
25
+
26
+
## Raw commands, helper commands, or deployment tooling?
27
+
28
+
Use the lowest-level command that fits the task, but prefer helper or deployment tooling when the same steps need to be repeated reliably.
| Running a one-off Shopware application command locally |`bin/console`| Direct access to commands provided by the Shopware application. |
33
+
| Running common Shopware commands during daily development |`shopware-cli project console <command>` or `swx <command>`| Wraps `bin/console` through Shopware CLI and resolves the project context for you. |
34
+
| Starting or managing the local development stack |`shopware-cli project dev`| Provides the interactive development environment for the Docker-based stack, logs, watchers, and common development tasks. |
35
+
| Building a project in CI |`shopware-cli project ci`| Produces a reproducible build artifact with dependencies and assets prepared before deployment. |
36
+
| Installing, updating, or maintaining a deployed instance | Deployment Helper | Automates deploy-time tasks such as install/update detection, migrations, extension management, maintenance mode, cache handling, and one-time commands. |
37
+
| Debugging an exceptional production issue manually | Raw commands, carefully | Useful for investigation, but repeated deployment or maintenance steps should move into Deployment Helper configuration. |
38
+
39
+
As a rule of thumb: use raw `bin/console` commands for direct local or diagnostic work, Shopware CLI helpers for daily development convenience, and Deployment Helper for repeatable deployment and maintenance workflows.
40
+
41
+
## Available tooling
11
42
12
43
-[Development Environment](../dev-environment.md): The Docker-based development environment with an interactive terminal dashboard that manages your entire stack, streams logs, and controls watchers.
Copy file name to clipboardExpand all lines: guides/hosting/configurations/shopware/index.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,26 @@ nav:
5
5
6
6
---
7
7
8
-
# Shopware configurations
8
+
# Shopware Configurations
9
9
10
10
## Overview
11
11
12
12
The following section guides you on the security, performance or structural configurations specific to Shopware 6.
13
+
14
+
## How Shopware configuration works
15
+
16
+
Shopware configuration can come from different places, depending on whether the value is operational, environment-specific, or meant to be changed by shop administrators.
| Database-backed system configuration | Shop settings that can be changed in the Administration, through Admin API, or by app/plugin code | Stored in the database and read through Shopware's system configuration |
21
+
| Static system configuration | Settings that must be fixed, versioned, or controlled per environment |`config/packages/*.yaml` under `shopware.system_config`|
22
+
| Symfony / bundle configuration | Technical runtime configuration for Shopware, Symfony, or bundles |`config/packages/*.yaml`, including environment-specific folders such as `config/packages/prod/`|
23
+
| Environment variables | Secrets, infrastructure values, and deployment-specific values |`.env`, `.env.local`, server/container environment, or deployment platform |
24
+
| CLI commands | Reading, writing, or inspecting configuration during development, deployment, or maintenance |`bin/console` / `shopware-cli project console`|
25
+
26
+
As a rule of thumb: use Administration or database-backed system configuration for shop settings that merchants may change, static system configuration for values that should be fixed or version-controlled, and environment variables or Symfony configuration for deployment and infrastructure settings.
27
+
28
+
Static system configuration is an overlay on top of database-loaded system configuration. If the same key is configured in both places, the value from `config/packages` wins and the setting can no longer be changed in the Administration.
29
+
30
+
For details, see [Static System Configuration](./static-system-config.md).
You can also find the Composer package name when you click "Install via Composer" in the Shopware Account.
56
56
57
+
:::warning
58
+
Removing a Composer package or uninstalling a plugin does not cancel a paid subscription. License state is managed in the Shopware Account, and cancellation must be done there.
59
+
:::
60
+
57
61
## Migrating already installed extensions to Composer
58
62
59
63
If you already have extensions installed in your project, you can migrate them to Composer. First, you should install the extension with Composer:
Copy file name to clipboardExpand all lines: guides/installation/project-overview.md
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,23 +27,20 @@ Development tools such as:
27
27
28
28
are managed via the Shopware CLI. These are installed into the user's environment and shared across projects and extensions, rather than being added as project-level `require-dev` dependencies.
29
29
30
-
[Demo data](https://github.com/shopware/SwagPlatformDemoData) is optionaland can be installed during the in-browser first-run wizard.
30
+
[Demo data](https://github.com/shopware/SwagPlatformDemoData) is optional. For developer setups, prefer terminal-based setup and development workflows instead of the in-browser First Run Wizard.
31
31
32
32
Your local project is ready for debugging, profiling, and extension development out of the box.
33
33
34
34
In day-to-day development, you'll mostly interact with:
35
35
36
-
-**Makefile**: shortcuts for Docker and Shopware commands (`make up`, `make setup`, etc.)
37
-
-**custom/**: where you build your own plugins and themes
38
-
-**bin/console**: the application CLI that ships with Shopware (Symfony console).
39
-
It is used for tasks such as running migrations, installing plugins, clearing caches, or managing configuration in your project.
36
+
-**`shopware-cli project dev`**: starts and manages the Docker-based development environment, including containers, logs, watchers, credentials, and service URLs.
37
+
-**`shopware-cli project console <command>`**: runs Shopware application commands from your host without opening an interactive container shell.
38
+
-**`swx <command>`**: shortcut for `shopware-cli project console <command>`, for example `swx cache:clear`.
39
+
-**`custom/`**: where you build your own plugins and themes.
40
40
41
-
:::info
42
-
`bin/console` differs from the standalone [Shopware CLI](https://github.com/shopware/shopware-cli) used for extension builds and CI workflows.
43
-
The Docker setup already includes the standalone Shopware CLI inside the container.
44
-
:::
41
+
`bin/console` is the application CLI that ships with Shopware (Symfony console). Use it for Shopware application commands such as migrations, plugin installation, cache clearing, or configuration changes. In Docker-based setups, run those commands through `shopware-cli project console` or `swx` so they execute in the correct container context.
45
42
46
-
Most other files in the project either configure the environment or support these core layers.
43
+
The standalone [Shopware CLI](https://github.com/shopware/shopware-cli) is different from `bin/console`: it manages project workflows such as the development environment, helper commands, extension builds, and CI workflows.
47
44
48
45
## Project template
49
46
@@ -107,7 +104,7 @@ This table outlines the key directories and files in your Shopware project and t
107
104
|**config/**| Directory | Symfony configuration files (framework, database, mail, etc.). | Similar to `config/` in many web frameworks. |
108
105
|**custom/**| Directory | Your plugins, themes, or app customizations. | This is where you add new extensions - your "src" for Shopware plugins. |
109
106
|**files/**| Directory | Uploaded media and temporary files. | Ignored by git; generated at runtime. |
110
-
|**Makefile**|Build helper |Shortcuts for Docker tasks (`make up`, `make setup`, etc.). | Replaces long Docker commands with memorable aliases. |
107
+
|**Makefile**|Legacy build helper |May exist in older setups with shortcuts for Docker tasks (`make up`, `make setup`, etc.). | Replaces long Docker commands with memorable aliases. |
111
108
|**public/**| Web root | The actual web-server-accessible directory (contains `index.php`, assets, etc.). | Like `/dist` in JS frameworks or `/public_html`. |
112
109
|**src/**| Source code | Shopware's core application source. | Where the main PHP codebase lives; not usually edited in a project clone. |
113
110
|**symfony.lock**| Symfony dependency snapshot | Records Symfony recipes applied during setup. | Used internally by Symfony Flex; no manual editing. |
Copy file name to clipboardExpand all lines: guides/plugins/apps/administration/meteor-admin-sdk.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,12 @@ The [Meteor Admin SDK](https://github.com/shopware/meteor/tree/main/packages/adm
10
10
11
11
To write advanced apps, its recommended that you use the [Meteor Admin SDK](https://github.com/shopware/meteor/tree/main/packages/admin-sdk). It contains helper functions to communicate with the Administration, execute actions, subscribe to data or extend the user interface. It has many more features and is more flexible.
12
12
13
-
-🏗 **Works with Shopware 6 Apps and Plugins:** You can use the SDK for your plugins or apps. API usage is identical.
14
-
-🎢 **Shallow learning curve:** You don't need to have extensive knowledge about the internals of the Shopware 6 Administration. Our SDK hides the complicated stuff behind a beautiful API.
15
-
-🧰 **Many extension capabilities:** Includes throwing notifications, accessing context information, extending the current UI and more. The feature set of the SDK will gradually be extended, providing more possibilities and flexibility for your ideas and solutions.
16
-
-🪨 **A stable API with great backwards compatibility:** Don't fear Shopware updates anymore. Breaking changes in this SDK are an exception. If you use the SDK, your apps and plugins will stay stable for a longer time, without any need for code maintenance.
17
-
-🧭 **Type safety:** The whole SDK is written in TypeScript which provides great autocompletion support and more safety for your apps and plugins.
18
-
-💙 **Developer experience:** Have a great development experience right from the start. And it will become better and better in the future.
19
-
-🪶 **Lightweight:** The whole library is completely tree-shakable and dependency-free. Every functionality can be imported granularly to keep your bundle as small and fast as possible.
13
+
-**Works with Shopware 6 Apps and Plugins:** You can use the SDK for your plugins or apps. API usage is identical.
14
+
-**Shallow learning curve:** You don't need to have extensive knowledge about the internals of the Shopware 6 Administration. Our SDK hides the complicated stuff behind a beautiful API.
15
+
-**Many extension capabilities:** Includes throwing notifications, accessing context information, extending the current UI and more. The feature set of the SDK will gradually be extended, providing more possibilities and flexibility for your ideas and solutions.
16
+
-**A stable API with great backwards compatibility:** Don't fear Shopware updates anymore. Breaking changes in this SDK are an exception. If you use the SDK, your apps and plugins will stay stable for a longer time, without any need for code maintenance.
17
+
-**Type safety:** The whole SDK is written in TypeScript which provides great autocompletion support and more safety for your apps and plugins.
18
+
-**Developer experience:** Have a great development experience right from the start. And it will become better and better in the future.
19
+
-**Lightweight:** The whole library is completely tree-shakable and dependency-free. Every functionality can be imported granularly to keep your bundle as small and fast as possible.
20
20
21
-
Go to [Installation](https://developer.shopware.com/resources/admin-extension-sdk/getting-started/installation.html) to get started. Or check out the [quick start guide](https://developer.shopware.com/resources/admin-extension-sdk/#quick-start).
21
+
[Get started here](https://developer.shopware.com/resources/admin-extension-sdk/getting-started/).
Copy file name to clipboardExpand all lines: guides/plugins/plugins/administration/index.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,8 @@ Typical use cases include:
21
21
22
22
This section follows a practical development workflow. Start with registering a module and route, then build the components, connect data, and refine permissions and UI behavior.
23
23
24
+
For stable cross-version extension points, use the [Meteor Admin SDK](../../apps/administration/meteor-admin-sdk.md). The SDK can be used by both apps and plugins.
25
+
24
26
## Developer workflow
25
27
26
28
When extending the Administration inside a plugin, follow this sequence:
0 commit comments