Skip to content

Commit e74f304

Browse files
committed
Update configuration examples to use env(string:) syntax
- Update DFS configuration in clustering.md - Update Solr configuration examples in install_solr.md - Align with changes from ibexa/recipes-dev#222
1 parent 1bb752d commit e74f304

File tree

4 files changed

+48
-30
lines changed

4 files changed

+48
-30
lines changed

docs/ibexa_cloud/environment_variables.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ description: Environment variables automatically generated by Ibexa Cloud based
55
# Environment variables on Ibexa Cloud
66

77
[[= product_name_cloud =]] automatically generates environment variables based on the Platform.sh relationships and routes configuration.
8-
The system parses `PLATFORM_RELATIONSHIPS` and `PLATFORM_ROUTES` environment variables and exposes them as application-specific variables.
8+
It parses `PLATFORM_RELATIONSHIPS` and `PLATFORM_ROUTES` environment variables and exposes them as application-specific variables.
9+
Environment variable names are created by converting relationship names to uppercase and replacing hyphens with underscores.
910

1011
## Database variables
1112

@@ -20,12 +21,12 @@ For MySQL and PostgreSQL databases, the following variables are generated based
2021
- `{RELATIONSHIP_NAME}_DRIVER` - database driver
2122
- `{RELATIONSHIP_NAME}_SERVER` - database server
2223

23-
Example: A relationship named `database` generates `DATABASE_URL`, `DATABASE_HOST`, `DATABASE_USER`, etc.
24+
For example, for a relationship called `database` the environment variables are named `DATABASE_URL`, `DATABASE_HOST`, `DATABASE_USER`, etc.
2425

2526
## DFS database variables
2627

27-
For distributed file storage (DFS) using a separate database, use the relationship name `dfs_database` (required).
28-
This generates the standard database variables listed above, plus additional DFS-specific variables when `PLATFORMSH_DFS_NFS_PATH` is set:
28+
When using [distributed file storage (DFS) using a separate database](clustering.md#dfs-io-handler), you must use the relationship name `dfs_database`.
29+
In addition to the database variables listed above, additional DFS-specific variables are created when `PLATFORMSH_DFS_NFS_PATH` is set:
2930

3031
- `DFS_NFS_PATH` - NFS path for DFS storage
3132
- `DFS_DATABASE_CHARSET` - database character set
@@ -98,4 +99,3 @@ Use the following relationship names in `.platform.app.yaml`:
9899
- `elasticsearch` - Elasticsearch search service
99100
- `solr` - Solr search service
100101

101-
Environment variable names are derived from relationship names by converting to uppercase and replacing hyphens with underscores.

docs/infrastructure_and_maintenance/clustering/clustering.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,9 @@ This example uses Doctrine connection named `dfs`:
143143
``` yaml
144144
parameters:
145145
env(DFS_DATABASE_URL): '%env(resolve:DATABASE_URL)%'
146-
dfs_nfs_path: '%env(resolve:DFS_NFS_PATH)%'
147146
dfs_database_url: '%env(resolve:DFS_DATABASE_URL)%'
148147
ibexa.io.nfs.adapter.config:
149-
root: '%dfs_nfs_path%'
148+
root: '%kernel.project_dir%/%env(string:DFS_NFS_PATH)%'
150149
path: '$var_dir$/$storage_dir$/'
151150
writeFlags: ~
152151
linkHandling: ~
@@ -158,12 +157,12 @@ doctrine:
158157
connections:
159158
dfs:
160159
# configure these for your database server
161-
driver: '%dfs_database_driver%'
162-
charset: '%dfs_database_charset%'
160+
driver: '%env(string:DFS_DATABASE_DRIVER)%'
161+
charset: '%env(string:DFS_DATABASE_CHARSET)%'
163162
default_table_options:
164-
charset: '%dfs_database_charset%'
165-
collate: '%dfs_database_collation%'
166-
url: '%dfs_database_url%'
163+
charset: '%env(string:DFS_DATABASE_CHARSET)%'
164+
collate: '%env(string:DFS_DATABASE_COLLATION)%'
165+
url: '%env(string:DFS_DATABASE_URL)%'
167166

168167
# define the Flysystem handler
169168
oneup_flysystem:

docs/release_notes/ibexa_dxp_v5.0.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,25 @@ month_change: true
1010

1111
<div class="release-notes" markdown="1">
1212

13+
[[% set version = 'v5.0.5' %]]
14+
15+
[[= release_note_entry_begin("Ibexa DXP " + version, '2025-XX-XX', ['Headless', 'Experience', 'Commerce', 'New feature']) =]]
16+
17+
#### Ibexa Cloud improvements
18+
19+
##### New cloud configuration package
20+
21+
A new `ibexa/cloud` package is now available for [[= product_name_cloud =]] deployments.
22+
This package replaces the previous `composer ibexa:setup --platformsh` command with a dedicated console command.
23+
24+
The package automatically generates environment variables based on Platform.sh relationships and routes configuration, making it easier to configure services like databases, cache, search engines, and session storage.
25+
26+
For more information, see [Install on Ibexa Cloud](install_on_ibexa_cloud.md) and [Environment variables on Ibexa Cloud](environment_variables.md).
27+
28+
[[% include 'snippets/release_50.md' %]]
29+
30+
[[= release_note_entry_end() =]]
31+
1332
[[% set version = 'v5.0.4' %]]
1433

1534
[[= release_note_entry_begin("Integrated help " + version, '2025-12-10', ['Headless', 'Experience', 'Commerce', 'LTS Update', 'New feature']) =]]

docs/search/search_engines/solr_search_engine/install_solr.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,8 @@ Out of the box in [[= product_name =]] the following is enabled for a setup:
183183
ibexa_solr:
184184
endpoints:
185185
endpoint0:
186-
dsn: '%solr_dsn%'
187-
core: '%solr_core%'
186+
dsn: '%env(string:SOLR_DSN)%'
187+
core: '%env(string:SOLR_CORE)%'
188188
connections:
189189
default:
190190
entry_endpoints:
@@ -202,10 +202,10 @@ The installation contains several similar languages, and one different language
202202
ibexa_solr:
203203
endpoints:
204204
endpoint0:
205-
dsn: '%solr_dsn%'
205+
dsn: '%env(string:SOLR_DSN)%'
206206
core: core0
207207
endpoint1:
208-
dsn: '%solr_dsn%'
208+
dsn: '%env(string:SOLR_DSN)%'
209209
core: core1
210210
connections:
211211
default:
@@ -232,25 +232,25 @@ ibexa_solr:
232232
version: '9.8.1' # Required only if using Solr 9
233233
endpoints:
234234
endpoint0:
235-
dsn: '%solr_dsn%'
235+
dsn: '%env(string:SOLR_DSN)%'
236236
core: core0
237237
endpoint1:
238-
dsn: '%solr_dsn%'
238+
dsn: '%env(string:SOLR_DSN)%'
239239
core: core1
240240
endpoint2:
241-
dsn: '%solr_dsn%'
241+
dsn: '%env(string:SOLR_DSN)%'
242242
core: core2
243243
endpoint3:
244-
dsn: '%solr_dsn%'
244+
dsn: '%env(string:SOLR_DSN)%'
245245
core: core3
246246
endpoint4:
247-
dsn: '%solr_dsn%'
247+
dsn: '%env(string:SOLR_DSN)%'
248248
core: core4
249249
endpoint5:
250-
dsn: '%solr_dsn%'
250+
dsn: '%env(string:SOLR_DSN)%'
251251
core: core5
252252
endpoint6:
253-
dsn: '%solr_dsn%'
253+
dsn: '%env(string:SOLR_DSN)%'
254254
core: core6
255255
connections:
256256
default:
@@ -286,14 +286,14 @@ The example is based on multi-core setup so any specific language analysis optio
286286
ibexa_solr:
287287
endpoints:
288288
main:
289-
dsn: '%solr_dsn%'
290-
core: '%solr_main_core%'
289+
dsn: '%env(string:SOLR_DSN)%'
290+
core: '%env(string:SOLR_MAIN_CORE)%'
291291
en:
292-
dsn: '%solr_dsn%'
293-
core: '%solr_en_core%'
292+
dsn: '%env(string:SOLR_DSN)%'
293+
core: '%env(string:SOLR_EN_CORE)%'
294294
fr:
295-
dsn: '%solr_dsn%'
296-
core: '%solr_fr_core%'
295+
dsn: '%env(string:SOLR_DSN)%'
296+
core: '%env(string:SOLR_FR_CORE)%'
297297
# ...
298298
connections:
299299
default:
@@ -325,7 +325,7 @@ In the example below we configured Solr Bundle to work with secured Solr core.
325325
ibexa_solr:
326326
endpoints:
327327
endpoint0:
328-
dsn: '%solr_dsn%'
328+
dsn: '%env(string:SOLR_DSN)%'
329329
core: core0
330330
user: example
331331
pass: password

0 commit comments

Comments
 (0)