Skip to content

docs(hosting): explain SHOPWARE_ADMIN_ES_REFRESH_INDICES and align its default #2467

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
Vin Le (vienthuong) wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(hosting): explain SHOPWARE_ADMIN_ES_REFRESH_INDICES and align its default #2467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b29bf64
docs(hosting): explain SHOPWARE_ADMIN_ES_REFRESH_INDICES and align it…
vienthuong Aug 21, 2026
7b67480
fix: grammar
vienthuong Aug 21, 2026
2503481
Merge branch 'main' into docs/admin-es-refresh-indices
vienthuong Aug 21, 2026
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
2 changes: 1 addition & 1 deletion guides/hosting/configurations/shopware/environment-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This page lists all environment variables that can be used to configure Shopware
| `SHOPWARE_ADMIN_ES_ENABLED` | (empty) | Enable Elasticsearch for administration |
| `SHOPWARE_ADMIN_ES_INDEX_PREFIX` | `sw-admin` | Index prefix for administration Elasticsearch |
| `SHOPWARE_ADMIN_ES_INDEXING_BATCH_SIZE` | `1000` | Batch size for administration Elasticsearch indexing (since 6.7.9.0) |
| `SHOPWARE_ADMIN_ES_REFRESH_INDICES` | (empty) | Refresh administration indices |
| `SHOPWARE_ADMIN_ES_REFRESH_INDICES` | (empty) | Automatically create missing administration indices and aliases when an indexed entity is written, instead of requiring `bin/console es:admin:index` (`1` to enable, `0` to disable). Costs one alias check per indexer on every write, and auto-created indices start empty until a full reindex. |
Comment thread
vienthuong marked this conversation as resolved.
| `SHOPWARE_ADMIN_ES_THROW_EXCEPTION` | `1` | Whether to throw exceptions on administration Elasticsearch errors (`1` to enable, `0` to disable). Mainly useful in local development for debugging (since 6.7.9.0) |
| `SHOPWARE_ADMINISTRATION_PATH_NAME` | `admin` | Custom path name for administration interface |
| `SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED` | `0` | Enable timezone support in DBAL |
Expand Down
6 changes: 5 additions & 1 deletion guides/hosting/infrastructure/elasticsearch/elasticsearch-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,10 +202,14 @@ ADMIN_OPENSEARCH_URL=YOUR OPENSEARCH URL
SHOPWARE_ADMIN_ES_ENABLED=1
SHOPWARE_ADMIN_ES_INDEX_PREFIX=sw-admin
SHOPWARE_ADMIN_ES_INDEXING_BATCH_SIZE=1000
SHOPWARE_ADMIN_ES_REFRESH_INDICES=1
SHOPWARE_ADMIN_ES_REFRESH_INDICES=0
SHOPWARE_ADMIN_ES_THROW_EXCEPTION=1
```

::: info
`SHOPWARE_ADMIN_ES_REFRESH_INDICES=1` makes Shopware create missing administration indices and aliases on the fly when an indexed entity is written, instead of relying on `bin/console es:admin:index`. Enable it in environments where nobody runs CLI commands after installing an extension or replacing the search cluster. It adds one alias check per indexer on every write, and an index created this way stays empty until a full reindex, so prefer `0` together with `bin/console es:admin:index` in your deployment pipeline.
:::

Also, the CLI commands can be used as below:

```bash
Expand Down
Loading