From 90b76802683efd2b627c4c3f4cb144bcedaa0ab3 Mon Sep 17 00:00:00 2001 From: Micha Date: Fri, 24 Oct 2025 13:37:52 +0200 Subject: [PATCH 1/9] add/missing-envs --- .../shopware/environment-variables.md | 78 ++++++++++++------- 1 file changed, 49 insertions(+), 29 deletions(-) diff --git a/guides/hosting/configurations/shopware/environment-variables.md b/guides/hosting/configurations/shopware/environment-variables.md index 3e7c3ed9a..2cb74e5ad 100644 --- a/guides/hosting/configurations/shopware/environment-variables.md +++ b/guides/hosting/configurations/shopware/environment-variables.md @@ -9,32 +9,52 @@ nav: This page lists all environment variables that can be used to configure Shopware. -| Variable | Default Value | Description | -|----------------------------------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `APP_ENV` | `prod` | Environment | -| `APP_SECRET` | (empty) | Can be generated with `openssl rand -hex 32` | -| `APP_CACHE_DIR` | `{projectRoot}/var/cache` | Path to a directory to store caches (since 6.6.8.0) | -| `APP_BUILD_DIR` | `{projectRoot}/var/cache` | Path to a temporary directory to create cache folder (since 6.6.8.0) | -| `APP_LOG_DIR` | `{projectRoot}/var/log` | Path to a directory to store logs (since 6.6.8.0) | -| `INSTANCE_ID` | (empty) | Unique Identifier for the Store: Can be generated with `openssl rand -hex 32` | -| `LOCK_DSN` | `flock` | DSN for Symfony locking | -| `APP_URL` | (empty) | Where Shopware will be accessible | -| `BLUE_GREEN_DEPLOYMENT` | `0` | This needs super privilege to create trigger | -| `DATABASE_URL` | (empty) | MySQL credentials as DSN | -| `DATABASE_SSL_CA` | (empty) | Path to SSL CA file | -| `DATABASE_SSL_CERT` | (empty) | Path to SSL Cert file | -| `DATABASE_SSL_KEY` | (empty) | Path to SSL Key file | -| `DATABASE_SSL_DONT_VERIFY_SERVER_CERT` | (empty) | Disables verification of the server certificate (1 disables it) | -| `MAILER_DSN` | `null://localhost` | Mailer DSN (Admin Configuration overwrites this) | -| `ENABLE_SERVICES` | `auto` | Determines if services are enabled, auto detects that based on `APP_ENV`, other possible values are `true` (or `1`) and `false` (or `0`). When set to `0`, Shopware Services won't be installed on the system | -| `OPENSEARCH_URL` | (empty) | Open Search Hosts | -| `SHOPWARE_ES_ENABLED` | `0` | Open Search Support Enabled? | -| `SHOPWARE_ES_INDEXING_ENABLED` | `0` | Open Search Indexing Enabled? | -| `SHOPWARE_ES_INDEX_PREFIX` | (empty) | Open Search Index Prefix | -| `COMPOSER_HOME` | `/tmp/composer` | Caching for the Plugin Manager | -| `SHOPWARE_HTTP_CACHE_ENABLED` | `1` | Is HTTP Cache enabled? | -| `SHOPWARE_HTTP_DEFAULT_TTL` | `7200` | Default TTL for HTTP Cache | -| `MESSENGER_TRANSPORT_DSN` | (empty) | DSN for default async queue (example: `amqp://guest:guest@localhost:5672/%2f/default`) | -| `MESSENGER_TRANSPORT_LOW_PRIORITY_DSN` | (empty) | DSN for low priority queue (example: `amqp://guest:guest@localhost:5672/%2f/low_prio`) | -| `MESSENGER_TRANSPORT_FAILURE_DSN` | (empty) | DSN for failed messages queue (example: `amqp://guest:guest@localhost:5672/%2f/failure`) | -| `COMPOSER_PLUGIN_LOADER` | (empty) | When set to a non-empty value (e.g., `1` or `true`), enables the Composer plugin loader instead of the database plugin loader. All plugins defined in the root `composer.json` will be automatically active, regardless of database settings. | +| Variable | Default Value | Description | +|------------------------------------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `APP_ENV` | `prod` | Environment | +| `APP_SECRET` | (empty) | Can be generated with `openssl rand -hex 32` | +| `APP_CACHE_DIR` | `{projectRoot}/var/cache` | Path to a directory to store caches (since 6.6.8.0) | +| `APP_BUILD_DIR` | `{projectRoot}/var/cache` | Path to a temporary directory to create cache folder (since 6.6.8.0) | +| `APP_LOG_DIR` | `{projectRoot}/var/log` | Path to a directory to store logs (since 6.6.8.0) | +| `INSTANCE_ID` | (empty) | Unique Identifier for the Store: Can be generated with `openssl rand -hex 32` | +| `JWT_PRIVATE_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | +| `JWT_PUBLIC_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | +| `LOCK_DSN` | `flock` | DSN for Symfony locking | +| `APP_URL` | (empty) | Where Shopware will be accessible | +| `BLUE_GREEN_DEPLOYMENT` | `0` | This needs super privilege to create trigger | +| `DATABASE_URL` | (empty) | MySQL credentials as DSN | +| `DATABASE_SSL_CA` | (empty) | Path to SSL CA file | +| `DATABASE_SSL_CERT` | (empty) | Path to SSL Cert file | +| `DATABASE_SSL_KEY` | (empty) | Path to SSL Key file | +| `DATABASE_SSL_DONT_VERIFY_SERVER_CERT` | (empty) | Disables verification of the server certificate (1 disables it) | +| `MAILER_DSN` | `null://localhost` | Mailer DSN (Admin Configuration overwrites this) | +| `ENABLE_SERVICES` | `auto` | Determines if services are enabled, auto detects that based on `APP_ENV`, other possible values are `true` (or `1`) and `false` (or `0`). When set to `0`, Shopware Services won't be installed on the system | +| `OPENSEARCH_URL` | (empty) | Open Search Hosts | +| `SHOPWARE_ES_ENABLED` | `0` | Open Search Support Enabled? | +| `SHOPWARE_ES_INDEXING_ENABLED` | `0` | Open Search Indexing Enabled? | +| `SHOPWARE_ES_INDEX_PREFIX` | (empty) | Open Search Index Prefix | +| `COMPOSER_HOME` | `/tmp/composer` | Caching for the Plugin Manager | +| `SHOPWARE_HTTP_CACHE_ENABLED` | `1` | Is HTTP Cache enabled? | +| `SHOPWARE_HTTP_DEFAULT_TTL` | `7200` | Default TTL for HTTP Cache | +| `MESSENGER_TRANSPORT_DSN` | (empty) | DSN for default async queue (example: `amqp://guest:guest@localhost:5672/%2f/default`) | +| `MESSENGER_TRANSPORT_LOW_PRIORITY_DSN` | (empty) | DSN for low priority queue (example: `amqp://guest:guest@localhost:5672/%2f/low_prio`) | +| `MESSENGER_TRANSPORT_FAILURE_DSN` | (empty) | DSN for failed messages queue (example: `amqp://guest:guest@localhost:5672/%2f/failure`) | +| `COMPOSER_PLUGIN_LOADER` | (empty) | When set to a non-empty value (e.g., `1` or `true`), enables the Composer plugin loader instead of the database plugin loader. All plugins defined in the root `composer.json` will be automatically active, regardless of database settings. | +| `REDIS_URL` | (empty) | Redis connection URL for caching and sessions | +| `REDIS_PREFIX` | (empty) | Prefix for Redis keys | +| `SERVICE_REGISTRY_URL` | `https://registry.services.shopware.io` | URL for Shopware Services registry | +| `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface | +| `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration | +| `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors | +| `SHOPWARE_ADMIN_ES_ENABLED` | (empty) | Enable Elasticsearch for administration | +| `ADMIN_OPENSEARCH_URL` | (empty) | OpenSearch URL for administration | +| `SHOPWARE_ADMIN_ES_INDEX_PREFIX` | `sw-admin` | Index prefix for administration Elasticsearch | +| `SHOPWARE_ADMIN_ES_REFRESH_INDICES` | (empty) | Refresh administration indices | +| `SHOPWARE_ES_INDEXING_BATCH_SIZE` | `100` | Batch size for Elasticsearch indexing | +| `SHOPWARE_ES_EXCLUDE_SOURCE` | `0` | Exclude source from Elasticsearch | +| `SHOPWARE_ES_NGRAM_MIN_GRAM` | `4` | Minimum n-gram size for Elasticsearch | +| `SHOPWARE_ES_NGRAM_MAX_GRAM` | `5` | Maximum n-gram size for Elasticsearch | +| `APP_URL_CHECK_DISABLED` | `false` | Disable URL validation checks | +| `SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED` | `0` | Enable timezone support in DBAL | +| `SHOPWARE_DBAL_TOKEN_MINIMUM_LENGTH` | `3` | Minimum token length for DBAL | +| `SHOPWARE_DISABLE_UPDATE_CHECK` | (empty) | Disable automatic update checks | From e56a290981760716dfe6f1161292c6d4b7a57e4d Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Wed, 3 Dec 2025 17:28:33 +0100 Subject: [PATCH 2/9] Update guides/hosting/configurations/shopware/environment-variables.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- guides/hosting/configurations/shopware/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/hosting/configurations/shopware/environment-variables.md b/guides/hosting/configurations/shopware/environment-variables.md index 2cb74e5ad..92d105025 100644 --- a/guides/hosting/configurations/shopware/environment-variables.md +++ b/guides/hosting/configurations/shopware/environment-variables.md @@ -44,7 +44,7 @@ This page lists all environment variables that can be used to configure Shopware | `REDIS_PREFIX` | (empty) | Prefix for Redis keys | | `SERVICE_REGISTRY_URL` | `https://registry.services.shopware.io` | URL for Shopware Services registry | | `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface | -| `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration | +| `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration. **Keep this value secure and do not commit it to version control.** | | `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors | | `SHOPWARE_ADMIN_ES_ENABLED` | (empty) | Enable Elasticsearch for administration | | `ADMIN_OPENSEARCH_URL` | (empty) | OpenSearch URL for administration | From 1be40b2a2bbf3b19580e7a5c927cd1f097b1c829 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Wed, 3 Dec 2025 17:28:55 +0100 Subject: [PATCH 3/9] Update guides/hosting/configurations/shopware/environment-variables.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- guides/hosting/configurations/shopware/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/hosting/configurations/shopware/environment-variables.md b/guides/hosting/configurations/shopware/environment-variables.md index 92d105025..1f2fe3ab3 100644 --- a/guides/hosting/configurations/shopware/environment-variables.md +++ b/guides/hosting/configurations/shopware/environment-variables.md @@ -45,7 +45,7 @@ This page lists all environment variables that can be used to configure Shopware | `SERVICE_REGISTRY_URL` | `https://registry.services.shopware.io` | URL for Shopware Services registry | | `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface | | `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration. **Keep this value secure and do not commit it to version control.** | -| `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors | +| `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors (`1` to enable, `0` to disable) | | `SHOPWARE_ADMIN_ES_ENABLED` | (empty) | Enable Elasticsearch for administration | | `ADMIN_OPENSEARCH_URL` | (empty) | OpenSearch URL for administration | | `SHOPWARE_ADMIN_ES_INDEX_PREFIX` | `sw-admin` | Index prefix for administration Elasticsearch | From dc438c4edd594eac398c72c1f5fe5f97e71578d9 Mon Sep 17 00:00:00 2001 From: Micha Date: Wed, 3 Dec 2025 17:30:35 +0100 Subject: [PATCH 4/9] chore/reformat-table --- .../shopware/environment-variables.md | 97 +++++++++---------- 1 file changed, 48 insertions(+), 49 deletions(-) diff --git a/guides/hosting/configurations/shopware/environment-variables.md b/guides/hosting/configurations/shopware/environment-variables.md index 1f2fe3ab3..8ce1f72d2 100644 --- a/guides/hosting/configurations/shopware/environment-variables.md +++ b/guides/hosting/configurations/shopware/environment-variables.md @@ -9,52 +9,51 @@ nav: This page lists all environment variables that can be used to configure Shopware. -| Variable | Default Value | Description | -|------------------------------------------|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `APP_ENV` | `prod` | Environment | -| `APP_SECRET` | (empty) | Can be generated with `openssl rand -hex 32` | -| `APP_CACHE_DIR` | `{projectRoot}/var/cache` | Path to a directory to store caches (since 6.6.8.0) | -| `APP_BUILD_DIR` | `{projectRoot}/var/cache` | Path to a temporary directory to create cache folder (since 6.6.8.0) | -| `APP_LOG_DIR` | `{projectRoot}/var/log` | Path to a directory to store logs (since 6.6.8.0) | -| `INSTANCE_ID` | (empty) | Unique Identifier for the Store: Can be generated with `openssl rand -hex 32` | -| `JWT_PRIVATE_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | -| `JWT_PUBLIC_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | -| `LOCK_DSN` | `flock` | DSN for Symfony locking | -| `APP_URL` | (empty) | Where Shopware will be accessible | -| `BLUE_GREEN_DEPLOYMENT` | `0` | This needs super privilege to create trigger | -| `DATABASE_URL` | (empty) | MySQL credentials as DSN | -| `DATABASE_SSL_CA` | (empty) | Path to SSL CA file | -| `DATABASE_SSL_CERT` | (empty) | Path to SSL Cert file | -| `DATABASE_SSL_KEY` | (empty) | Path to SSL Key file | -| `DATABASE_SSL_DONT_VERIFY_SERVER_CERT` | (empty) | Disables verification of the server certificate (1 disables it) | -| `MAILER_DSN` | `null://localhost` | Mailer DSN (Admin Configuration overwrites this) | -| `ENABLE_SERVICES` | `auto` | Determines if services are enabled, auto detects that based on `APP_ENV`, other possible values are `true` (or `1`) and `false` (or `0`). When set to `0`, Shopware Services won't be installed on the system | -| `OPENSEARCH_URL` | (empty) | Open Search Hosts | -| `SHOPWARE_ES_ENABLED` | `0` | Open Search Support Enabled? | -| `SHOPWARE_ES_INDEXING_ENABLED` | `0` | Open Search Indexing Enabled? | -| `SHOPWARE_ES_INDEX_PREFIX` | (empty) | Open Search Index Prefix | -| `COMPOSER_HOME` | `/tmp/composer` | Caching for the Plugin Manager | -| `SHOPWARE_HTTP_CACHE_ENABLED` | `1` | Is HTTP Cache enabled? | -| `SHOPWARE_HTTP_DEFAULT_TTL` | `7200` | Default TTL for HTTP Cache | -| `MESSENGER_TRANSPORT_DSN` | (empty) | DSN for default async queue (example: `amqp://guest:guest@localhost:5672/%2f/default`) | -| `MESSENGER_TRANSPORT_LOW_PRIORITY_DSN` | (empty) | DSN for low priority queue (example: `amqp://guest:guest@localhost:5672/%2f/low_prio`) | -| `MESSENGER_TRANSPORT_FAILURE_DSN` | (empty) | DSN for failed messages queue (example: `amqp://guest:guest@localhost:5672/%2f/failure`) | -| `COMPOSER_PLUGIN_LOADER` | (empty) | When set to a non-empty value (e.g., `1` or `true`), enables the Composer plugin loader instead of the database plugin loader. All plugins defined in the root `composer.json` will be automatically active, regardless of database settings. | -| `REDIS_URL` | (empty) | Redis connection URL for caching and sessions | -| `REDIS_PREFIX` | (empty) | Prefix for Redis keys | -| `SERVICE_REGISTRY_URL` | `https://registry.services.shopware.io` | URL for Shopware Services registry | -| `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface | -| `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration. **Keep this value secure and do not commit it to version control.** | -| `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors (`1` to enable, `0` to disable) | -| `SHOPWARE_ADMIN_ES_ENABLED` | (empty) | Enable Elasticsearch for administration | -| `ADMIN_OPENSEARCH_URL` | (empty) | OpenSearch URL for administration | -| `SHOPWARE_ADMIN_ES_INDEX_PREFIX` | `sw-admin` | Index prefix for administration Elasticsearch | -| `SHOPWARE_ADMIN_ES_REFRESH_INDICES` | (empty) | Refresh administration indices | -| `SHOPWARE_ES_INDEXING_BATCH_SIZE` | `100` | Batch size for Elasticsearch indexing | -| `SHOPWARE_ES_EXCLUDE_SOURCE` | `0` | Exclude source from Elasticsearch | -| `SHOPWARE_ES_NGRAM_MIN_GRAM` | `4` | Minimum n-gram size for Elasticsearch | -| `SHOPWARE_ES_NGRAM_MAX_GRAM` | `5` | Maximum n-gram size for Elasticsearch | -| `APP_URL_CHECK_DISABLED` | `false` | Disable URL validation checks | -| `SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED` | `0` | Enable timezone support in DBAL | -| `SHOPWARE_DBAL_TOKEN_MINIMUM_LENGTH` | `3` | Minimum token length for DBAL | -| `SHOPWARE_DISABLE_UPDATE_CHECK` | (empty) | Disable automatic update checks | +| Variable | Default Value | Description | +|------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `APP_ENV` | `prod` | Environment | +| `APP_SECRET` | (empty) | Can be generated with `openssl rand -hex 32` | +| `APP_CACHE_DIR` | `{projectRoot}/var/cache` | Path to a directory to store caches (since 6.6.8.0) | +| `APP_BUILD_DIR` | `{projectRoot}/var/cache` | Path to a temporary directory to create cache folder (since 6.6.8.0) | +| `APP_LOG_DIR` | `{projectRoot}/var/log` | Path to a directory to store logs (since 6.6.8.0) | +| `INSTANCE_ID` | (empty) | Unique Identifier for the Store: Can be generated with `openssl rand -hex 32` | +| `JWT_PRIVATE_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | +| `JWT_PUBLIC_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | +| `LOCK_DSN` | `flock` | DSN for Symfony locking | +| `APP_URL` | (empty) | Where Shopware will be accessible | +| `BLUE_GREEN_DEPLOYMENT` | `0` | This needs super privilege to create trigger | +| `DATABASE_URL` | (empty) | MySQL credentials as DSN | +| `DATABASE_SSL_CA` | (empty) | Path to SSL CA file | +| `DATABASE_SSL_CERT` | (empty) | Path to SSL Cert file | +| `DATABASE_SSL_KEY` | (empty) | Path to SSL Key file | +| `DATABASE_SSL_DONT_VERIFY_SERVER_CERT` | (empty) | Disables verification of the server certificate (1 disables it) | +| `MAILER_DSN` | `null://localhost` | Mailer DSN (Admin Configuration overwrites this) | +| `ENABLE_SERVICES` | `auto` | Determines if services are enabled, auto detects that based on `APP_ENV`, other possible values are `true` (or `1`) and `false` (or `0`). When set to `0`, Shopware Services won't be installed on the system | +| `OPENSEARCH_URL` | (empty) | Open Search Hosts | +| `SHOPWARE_ES_ENABLED` | `0` | Open Search Support Enabled? | +| `SHOPWARE_ES_INDEXING_ENABLED` | `0` | Open Search Indexing Enabled? | +| `SHOPWARE_ES_INDEX_PREFIX` | (empty) | Open Search Index Prefix | +| `COMPOSER_HOME` | `/tmp/composer` | Caching for the Plugin Manager | +| `SHOPWARE_HTTP_CACHE_ENABLED` | `1` | Is HTTP Cache enabled? | +| `SHOPWARE_HTTP_DEFAULT_TTL` | `7200` | Default TTL for HTTP Cache | +| `MESSENGER_TRANSPORT_DSN` | (empty) | DSN for default async queue (example: `amqp://guest:guest@localhost:5672/%2f/default`) | +| `MESSENGER_TRANSPORT_LOW_PRIORITY_DSN` | (empty) | DSN for low priority queue (example: `amqp://guest:guest@localhost:5672/%2f/low_prio`) | +| `MESSENGER_TRANSPORT_FAILURE_DSN` | (empty) | DSN for failed messages queue (example: `amqp://guest:guest@localhost:5672/%2f/failure`) | +| `COMPOSER_PLUGIN_LOADER` | (empty) | When set to a non-empty value (e.g., `1` or `true`), enables the Composer plugin loader instead of the database plugin loader. All plugins defined in the root `composer.json` will be automatically active, regardless of database settings. | +| `REDIS_URL` | (empty) | Redis connection URL for caching and sessions | +| `REDIS_PREFIX` | (empty) | Prefix for Redis keys | +| `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface | +| `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration. **Keep this value secure and do not commit it to version control.** | +| `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors (`1` to enable, `0` to disable) | +| `SHOPWARE_ADMIN_ES_ENABLED` | (empty) | Enable Elasticsearch for administration | +| `ADMIN_OPENSEARCH_URL` | (empty) | OpenSearch URL for administration | +| `SHOPWARE_ADMIN_ES_INDEX_PREFIX` | `sw-admin` | Index prefix for administration Elasticsearch | +| `SHOPWARE_ADMIN_ES_REFRESH_INDICES` | (empty) | Refresh administration indices | +| `SHOPWARE_ES_INDEXING_BATCH_SIZE` | `100` | Batch size for Elasticsearch indexing | +| `SHOPWARE_ES_EXCLUDE_SOURCE` | `0` | Exclude source from Elasticsearch | +| `SHOPWARE_ES_NGRAM_MIN_GRAM` | `4` | Minimum n-gram size for Elasticsearch | +| `SHOPWARE_ES_NGRAM_MAX_GRAM` | `5` | Maximum n-gram size for Elasticsearch | +| `APP_URL_CHECK_DISABLED` | `false` | Disable URL validation checks | +| `SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED` | `0` | Enable timezone support in DBAL | +| `SHOPWARE_DBAL_TOKEN_MINIMUM_LENGTH` | `3` | Minimum token length for DBAL | +| `SHOPWARE_DISABLE_UPDATE_CHECK` | (empty) | Disable automatic update checks | From 735bd6d6503c04ddb1c76d768594dab0f3a83812 Mon Sep 17 00:00:00 2001 From: Micha Date: Wed, 3 Dec 2025 17:33:38 +0100 Subject: [PATCH 5/9] chore/add-deprecation --- guides/hosting/configurations/shopware/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/hosting/configurations/shopware/environment-variables.md b/guides/hosting/configurations/shopware/environment-variables.md index 8ce1f72d2..ac4547f94 100644 --- a/guides/hosting/configurations/shopware/environment-variables.md +++ b/guides/hosting/configurations/shopware/environment-variables.md @@ -55,5 +55,5 @@ This page lists all environment variables that can be used to configure Shopware | `SHOPWARE_ES_NGRAM_MAX_GRAM` | `5` | Maximum n-gram size for Elasticsearch | | `APP_URL_CHECK_DISABLED` | `false` | Disable URL validation checks | | `SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED` | `0` | Enable timezone support in DBAL | -| `SHOPWARE_DBAL_TOKEN_MINIMUM_LENGTH` | `3` | Minimum token length for DBAL | +| `SHOPWARE_DBAL_TOKEN_MINIMUM_LENGTH` | `3` | Minimum token length for DBAL (@deprecated v6.8.0) | | `SHOPWARE_DISABLE_UPDATE_CHECK` | (empty) | Disable automatic update checks | From 9edf1ce36516a23ec3d36953387936e2ca521ea8 Mon Sep 17 00:00:00 2001 From: Micha Date: Wed, 3 Dec 2025 18:03:30 +0100 Subject: [PATCH 6/9] chore/sort-by-name-and-group --- .../shopware/environment-variables.md | 58 +++++++++---------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/guides/hosting/configurations/shopware/environment-variables.md b/guides/hosting/configurations/shopware/environment-variables.md index ac4547f94..ca754a5fe 100644 --- a/guides/hosting/configurations/shopware/environment-variables.md +++ b/guides/hosting/configurations/shopware/environment-variables.md @@ -11,49 +11,49 @@ This page lists all environment variables that can be used to configure Shopware | Variable | Default Value | Description | |------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `APP_ENV` | `prod` | Environment | -| `APP_SECRET` | (empty) | Can be generated with `openssl rand -hex 32` | -| `APP_CACHE_DIR` | `{projectRoot}/var/cache` | Path to a directory to store caches (since 6.6.8.0) | +| `ADMIN_OPENSEARCH_URL` | (empty) | OpenSearch URL for administration | | `APP_BUILD_DIR` | `{projectRoot}/var/cache` | Path to a temporary directory to create cache folder (since 6.6.8.0) | +| `APP_CACHE_DIR` | `{projectRoot}/var/cache` | Path to a directory to store caches (since 6.6.8.0) | +| `APP_ENV` | `prod` | Environment | | `APP_LOG_DIR` | `{projectRoot}/var/log` | Path to a directory to store logs (since 6.6.8.0) | -| `INSTANCE_ID` | (empty) | Unique Identifier for the Store: Can be generated with `openssl rand -hex 32` | -| `JWT_PRIVATE_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | -| `JWT_PUBLIC_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | -| `LOCK_DSN` | `flock` | DSN for Symfony locking | +| `APP_SECRET` | (empty) | Can be generated with `openssl rand -hex 32` | | `APP_URL` | (empty) | Where Shopware will be accessible | +| `APP_URL_CHECK_DISABLED` | `false` | Disable URL validation checks | | `BLUE_GREEN_DEPLOYMENT` | `0` | This needs super privilege to create trigger | -| `DATABASE_URL` | (empty) | MySQL credentials as DSN | +| `COMPOSER_HOME` | `/tmp/composer` | Caching for the Plugin Manager | +| `COMPOSER_PLUGIN_LOADER` | (empty) | When set to a non-empty value (e.g., `1` or `true`), enables the Composer plugin loader instead of the database plugin loader. All plugins defined in the root `composer.json` will be automatically active, regardless of database settings. | | `DATABASE_SSL_CA` | (empty) | Path to SSL CA file | | `DATABASE_SSL_CERT` | (empty) | Path to SSL Cert file | -| `DATABASE_SSL_KEY` | (empty) | Path to SSL Key file | | `DATABASE_SSL_DONT_VERIFY_SERVER_CERT` | (empty) | Disables verification of the server certificate (1 disables it) | -| `MAILER_DSN` | `null://localhost` | Mailer DSN (Admin Configuration overwrites this) | +| `DATABASE_SSL_KEY` | (empty) | Path to SSL Key file | +| `DATABASE_URL` | (empty) | MySQL credentials as DSN | | `ENABLE_SERVICES` | `auto` | Determines if services are enabled, auto detects that based on `APP_ENV`, other possible values are `true` (or `1`) and `false` (or `0`). When set to `0`, Shopware Services won't be installed on the system | -| `OPENSEARCH_URL` | (empty) | Open Search Hosts | -| `SHOPWARE_ES_ENABLED` | `0` | Open Search Support Enabled? | -| `SHOPWARE_ES_INDEXING_ENABLED` | `0` | Open Search Indexing Enabled? | -| `SHOPWARE_ES_INDEX_PREFIX` | (empty) | Open Search Index Prefix | -| `COMPOSER_HOME` | `/tmp/composer` | Caching for the Plugin Manager | -| `SHOPWARE_HTTP_CACHE_ENABLED` | `1` | Is HTTP Cache enabled? | -| `SHOPWARE_HTTP_DEFAULT_TTL` | `7200` | Default TTL for HTTP Cache | +| `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration. **Keep this value secure and do not commit it to version control.** | +| `INSTANCE_ID` | (empty) | Unique Identifier for the Store: Can be generated with `openssl rand -hex 32` | +| `JWT_PRIVATE_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | +| `JWT_PUBLIC_KEY` | (empty) | Can be generated with `shopware-cli project generate-jwt --env` | +| `LOCK_DSN` | `flock` | DSN for Symfony locking | +| `MAILER_DSN` | `null://localhost` | Mailer DSN (Admin Configuration overwrites this) | | `MESSENGER_TRANSPORT_DSN` | (empty) | DSN for default async queue (example: `amqp://guest:guest@localhost:5672/%2f/default`) | -| `MESSENGER_TRANSPORT_LOW_PRIORITY_DSN` | (empty) | DSN for low priority queue (example: `amqp://guest:guest@localhost:5672/%2f/low_prio`) | | `MESSENGER_TRANSPORT_FAILURE_DSN` | (empty) | DSN for failed messages queue (example: `amqp://guest:guest@localhost:5672/%2f/failure`) | -| `COMPOSER_PLUGIN_LOADER` | (empty) | When set to a non-empty value (e.g., `1` or `true`), enables the Composer plugin loader instead of the database plugin loader. All plugins defined in the root `composer.json` will be automatically active, regardless of database settings. | -| `REDIS_URL` | (empty) | Redis connection URL for caching and sessions | +| `MESSENGER_TRANSPORT_LOW_PRIORITY_DSN` | (empty) | DSN for low priority queue (example: `amqp://guest:guest@localhost:5672/%2f/low_prio`) | +| `OPENSEARCH_URL` | (empty) | Open Search Hosts | | `REDIS_PREFIX` | (empty) | Prefix for Redis keys | -| `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface | -| `FASTLY_API_KEY` | (empty) | API key for Fastly CDN integration. **Keep this value secure and do not commit it to version control.** | -| `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors (`1` to enable, `0` to disable) | +| `REDIS_URL` | (empty) | Redis connection URL for caching and sessions (example: `redis://host:port`) | | `SHOPWARE_ADMIN_ES_ENABLED` | (empty) | Enable Elasticsearch for administration | -| `ADMIN_OPENSEARCH_URL` | (empty) | OpenSearch URL for administration | | `SHOPWARE_ADMIN_ES_INDEX_PREFIX` | `sw-admin` | Index prefix for administration Elasticsearch | | `SHOPWARE_ADMIN_ES_REFRESH_INDICES` | (empty) | Refresh administration indices | -| `SHOPWARE_ES_INDEXING_BATCH_SIZE` | `100` | Batch size for Elasticsearch indexing | -| `SHOPWARE_ES_EXCLUDE_SOURCE` | `0` | Exclude source from Elasticsearch | -| `SHOPWARE_ES_NGRAM_MIN_GRAM` | `4` | Minimum n-gram size for Elasticsearch | -| `SHOPWARE_ES_NGRAM_MAX_GRAM` | `5` | Maximum n-gram size for Elasticsearch | -| `APP_URL_CHECK_DISABLED` | `false` | Disable URL validation checks | +| `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface | | `SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED` | `0` | Enable timezone support in DBAL | | `SHOPWARE_DBAL_TOKEN_MINIMUM_LENGTH` | `3` | Minimum token length for DBAL (@deprecated v6.8.0) | | `SHOPWARE_DISABLE_UPDATE_CHECK` | (empty) | Disable automatic update checks | +| `SHOPWARE_ES_ENABLED` | `0` | Open Search Support Enabled? | +| `SHOPWARE_ES_EXCLUDE_SOURCE` | `0` | Exclude source from Elasticsearch | +| `SHOPWARE_ES_INDEX_PREFIX` | (empty) | Open Search Index Prefix | +| `SHOPWARE_ES_INDEXING_BATCH_SIZE` | `100` | Batch size for Elasticsearch indexing | +| `SHOPWARE_ES_INDEXING_ENABLED` | `0` | Open Search Indexing Enabled? | +| `SHOPWARE_ES_NGRAM_MAX_GRAM` | `5` | Maximum n-gram size for Elasticsearch | +| `SHOPWARE_ES_NGRAM_MIN_GRAM` | `4` | Minimum n-gram size for Elasticsearch | +| `SHOPWARE_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on Elasticsearch errors (`1` to enable, `0` to disable) | +| `SHOPWARE_HTTP_CACHE_ENABLED` | `1` | Is HTTP Cache enabled? | +| `SHOPWARE_HTTP_DEFAULT_TTL` | `7200` | Default TTL for HTTP Cache | From b857cc783566fddd2dd9a26e27c3495de72f4044 Mon Sep 17 00:00:00 2001 From: Micha Date: Wed, 3 Dec 2025 18:21:48 +0100 Subject: [PATCH 7/9] add/more-info-on-one-setting-by-community-feedback --- .../elasticsearch/elasticsearch-setup.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md b/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md index 05b5341d6..bbc84ef90 100644 --- a/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md +++ b/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md @@ -91,6 +91,17 @@ Normally a shard in Elasticsearch can hold at least tens of gigabytes, so you mi | `SHOPWARE_ES_INDEX_PREFIX` | `sw_myshop` | This variable defines the prefix for the Elasticsearch indices | | `SHOPWARE_ES_THROW_EXCEPTION` | `0` / `1` | This variable activates the debug mode for Elasticsearch. Without this variable as = 0 you will get a fallback to mysql without any error message if Elasticsearch is not working | +:::info +The `SHOPWARE_ES_INDEXING_ENABLED` and `SHOPWARE_ES_ENABLED` can seem as a duplicate setting, but has it's purpose. Here are two use cases for setting these differently: + +## Full Support +`SHOPWARE_ES_ENABLED=1` + `SHOPWARE_ES_INDEXING_ENABLED=1` - Both search and indexing enabled. + +## Read-Only +`SHOPWARE_ES_ENABLED=1` + `SHOPWARE_ES_INDEXING_ENABLED=0` - Search enabled, indexing disabled. Could be useful in bigger setups where some appservers can only read the index but not update it. + +::: + ### Example file for productive environments ```bash From 575e39d3f8435f15a81fe14f7841e80b2f11d694 Mon Sep 17 00:00:00 2001 From: Micha Date: Wed, 3 Dec 2025 18:26:47 +0100 Subject: [PATCH 8/9] chore/fix-markdown --- .../hosting/infrastructure/elasticsearch/elasticsearch-setup.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md b/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md index bbc84ef90..cfb05875f 100644 --- a/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md +++ b/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md @@ -95,9 +95,11 @@ Normally a shard in Elasticsearch can hold at least tens of gigabytes, so you mi The `SHOPWARE_ES_INDEXING_ENABLED` and `SHOPWARE_ES_ENABLED` can seem as a duplicate setting, but has it's purpose. Here are two use cases for setting these differently: ## Full Support + `SHOPWARE_ES_ENABLED=1` + `SHOPWARE_ES_INDEXING_ENABLED=1` - Both search and indexing enabled. ## Read-Only + `SHOPWARE_ES_ENABLED=1` + `SHOPWARE_ES_INDEXING_ENABLED=0` - Search enabled, indexing disabled. Could be useful in bigger setups where some appservers can only read the index but not update it. ::: From c9ca9a6a771b61c059f88ea252c8363cc272eac1 Mon Sep 17 00:00:00 2001 From: Micha Date: Wed, 3 Dec 2025 19:30:35 +0100 Subject: [PATCH 9/9] chore/fix-spellcheck --- .wordlist.txt | 1 + .../hosting/infrastructure/elasticsearch/elasticsearch-setup.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.wordlist.txt b/.wordlist.txt index e68cd65a7..c678108e7 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -65,6 +65,7 @@ Aplaceholder AppRefundHandler AppScripts AppServer +AppServers AppSystem Archlinux ArrayFacade diff --git a/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md b/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md index cfb05875f..1c9cd6621 100644 --- a/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md +++ b/guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md @@ -100,7 +100,7 @@ The `SHOPWARE_ES_INDEXING_ENABLED` and `SHOPWARE_ES_ENABLED` can seem as a dupli ## Read-Only -`SHOPWARE_ES_ENABLED=1` + `SHOPWARE_ES_INDEXING_ENABLED=0` - Search enabled, indexing disabled. Could be useful in bigger setups where some appservers can only read the index but not update it. +`SHOPWARE_ES_ENABLED=1` + `SHOPWARE_ES_INDEXING_ENABLED=0` - Search enabled, indexing disabled. Could be useful in bigger setups where some AppServers can only read the index but not update it. :::