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: docs/07-deploy-file/02-deploy.file.reference.v1.md
+61Lines changed: 61 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -837,6 +837,67 @@ docker:
837
837
Now you can access the applications from the `{ IP address 1 }` and `{ IP address 2 }` IP addresses.
838
838
839
839
840
+
### Per-store and per-region maintenance pages
841
+
842
+
By default, all endpoints of an application share the same maintenance page located at `public/{application}/maintenance/index.html` (e.g., `public/Yves/maintenance/index.html`).
843
+
844
+
You can customize the maintenance page per store or per region by placing an `index.html` file in a subdirectory named after the store or region code:
If no store-specific or region-specific page exists, the default `maintenance/index.html` is served. The default maintenance page is required and must always be present.
873
+
874
+
#### Testing maintenance pages locally
875
+
876
+
To verify a maintenance page locally without changing the deploy file, follow these steps:
877
+
878
+
1. Boot the environment with your deploy file:
879
+
```bash
880
+
docker/sdk boot {deploy file name}
881
+
```
882
+
883
+
2. Open the generated `docker/deployment/default/docker-compose.yml` and add the `SPRYKER_MAINTENANCE_MODE_ENABLED` environment variable to the `frontend` service:
884
+
```yaml
885
+
services:
886
+
frontend:
887
+
image: ...
888
+
environment:
889
+
SPRYKER_MAINTENANCE_MODE_ENABLED: 1
890
+
```
891
+
892
+
3. Start the environment:
893
+
```bash
894
+
docker/sdk up
895
+
```
896
+
897
+
4. Open Yves in a browser — the maintenance page should be displayed.
898
+
899
+
> **Note:** `docker/deployment/default/docker-compose.yml` is a generated file and will be overwritten the next time `docker/sdk boot` is run. This approach is intended for temporary local testing only. Do not commit this change.
900
+
840
901
841
902
### docker: logs:
842
903
* `docker: logs: path:` defines the path to the directory with Docker logs. This variable is optional. If not specified, the default value applies: `path: '/var/log/spryker`.
0 commit comments