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/getting_started/requirements.md
+121-1Lines changed: 121 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The following server requirements cover both running the software on-premise and
17
17
For running on [[[= product_name_cloud =]]](https://www.ibexa.co/products/ibexa-cloud), where recommended configuration and support is provided out of the box, see separate [[[= product_name_cloud =]] section](#ibexa-cloud-requirements-and-setup) for further reading on its requirements.
18
18
19
19
The minimal setup requires PHP, MySQL/MariaDB, Apache/Nginx, Node.js and `yarn`.
20
-
Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached, NFS/EFS/S3 and Solr/Elasticsearch in a [clustered setup](clustering.md).
20
+
For production setups it's recommended that you use Varnish/Fastly, Redis, NFS/EFS/S3 and Solr/Elasticsearch in a [clustered setup](clustering.md).
21
21
22
22
!!! caution "Recommended versions"
23
23
@@ -30,6 +30,17 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
30
30
31
31
## Operating system
32
32
33
+
=== "[[= product_name =]] v5.0"
34
+
35
+
|Name|Version|
36
+
|---|---|
37
+
|Debian 11 "Bullseye"|11.0-11.7+|
38
+
|Ubuntu "Noble Numbat"| 24.04 |
39
+
|RHEL / CentOS / CentOS Stream | 8.1-9.5+ |
40
+
41
+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
42
+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
43
+
33
44
=== "[[= product_name =]] v4.6"
34
45
35
46
|Name|Version|
@@ -59,6 +70,15 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
event MPM is recommended, if you need to use prefork you also need the `mod_php` module)
78
+
79
+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
80
+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
81
+
62
82
=== "[[= product_name =]] v4.6"
63
83
64
84
- Nginx 1.18-1.25+
@@ -76,6 +96,15 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
76
96
77
97
## DBMS
78
98
99
+
=== "[[= product_name =]] v5.0"
100
+
101
+
- MariaDB 10.11+
102
+
- MySQL 8.4
103
+
- PostgreSQL 14
104
+
105
+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
106
+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
107
+
79
108
=== "[[= product_name =]] v4.6"
80
109
81
110
- MariaDB 10.3-10.11+
@@ -115,6 +144,21 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
115
144
116
145
### PHP extensions
117
146
147
+
=== "[[= product_name =]] v5.0"
148
+
149
+
- `php-cli`
150
+
- `php-fpm`
151
+
- `php-mysql` (`php-mysqlnd`) or `php-pgsql`
152
+
- `php-xml`
153
+
- `php-mbstring`
154
+
- `php-process` (on RHEL/CentOS)
155
+
- `php-intl`
156
+
- `php-curl`
157
+
- `php-pear` (optional, provides pecl)
158
+
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
159
+
- `php-sodium`
160
+
- `php-bcmath`
161
+
118
162
=== "[[= product_name =]] v4.6"
119
163
120
164
- `php-cli`
@@ -148,6 +192,10 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
148
192
149
193
### Cluster PHP extensions
150
194
195
+
=== "[[= product_name =]] v5.0"
196
+
197
+
- `php-redis`
198
+
151
199
=== "[[= product_name =]] v4.6"
152
200
153
201
- `php-redis` or `php-memcached`
@@ -158,6 +206,11 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
158
206
159
207
## Search
160
208
209
+
=== "[[= product_name =]] v5.0"
210
+
211
+
- For content search, Solr 8.11.1 or higher.
212
+
Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
213
+
161
214
=== "[[= product_name =]] v4.6"
162
215
163
216
- For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher.
@@ -206,6 +259,15 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
206
259
207
260
## [Clustering](clustering.md)
208
261
262
+
=== "[[= product_name =]] v5.0"
263
+
264
+
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
265
+
- Redis 7.2+ (separate instances for session and cache, both using a `volatile-*` [eviction policy](https://redis.io/docs/latest/develop/reference/eviction/), session instance configured for persistence)
266
+
- [Varnish](http://varnish-cache.org/) 6.0LTS or 7.1 with [varnish-modules](https://github.com/varnish/varnish-modules/blob/master/README.md) or [Fastly](https://www.fastly.com/) using [the provided bundle](http_cache.md) (for HTTP Cache)
267
+
268
+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
269
+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
270
+
209
271
=== "[[= product_name =]] v4.6"
210
272
211
273
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
@@ -236,6 +298,10 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
236
298
237
299
## Package manager
238
300
301
+
=== "[[= product_name =]] v5.0"
302
+
303
+
- Composer: recent 2.8 version
304
+
239
305
=== "[[= product_name =]] v4.6"
240
306
241
307
- Composer: recent 2.7 version
@@ -246,6 +312,14 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
246
312
247
313
## Asset manager
248
314
315
+
=== "[[= product_name =]] v5.0"
316
+
317
+
- `Node.js` 22+
318
+
- `yarn` 1.15.2+
319
+
320
+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
321
+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
322
+
249
323
=== "[[= product_name =]] v4.6"
250
324
251
325
- `Node.js` 18+, 20+, 22+
@@ -287,6 +361,52 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
287
361
288
362
## [[= product_name_cloud =]] requirements and setup
289
363
364
+
=== "[[= product_name =]] v5.0"
365
+
366
+
### Cloud hosting with [[= product_name_cloud =]] and Platform.sh
367
+
368
+
In general, [[= product_name_cloud =]] supports all features and services of [Platform.sh](https://platform.sh/marketplace/ibexa/) that are compatible and supported by the [[= product_name =]] version you use.
369
+
370
+
For example:
371
+
372
+
- Platform.sh provides Redis support for versions 7.2, 7.0, and 6.2. [[= product_name =]] supports Redis version 7.2.
373
+
As a result, Redis is supported on [[= product_name_cloud =]] in versions 7.2.
374
+
375
+
Features or services supported by [[= product_name =]] but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations).
376
+
377
+
### [[= product_name_cloud =]] Setup support matrix
378
+
379
+
All [[= product_name =]] features are supported in accordance with the example above.
380
+
381
+
!!! note
382
+
383
+
As Platform.sh doesn't support a configuration with multiple PostgreSQL databases, for [[= product_name_cloud =]] / Platform.sh it's impossible to have a DFS table in a separate database.
384
+
385
+
### Recommended [[= product_name_cloud =]] setup
386
+
387
+
For more details on recommended setup configuration see bundled `.platform.app.yaml` and `.platform/` configuration files.
388
+
389
+
These files are kept up-to-date with latest recommendations and can be improved through contributions.
390
+
391
+
### Supported [[= product_name_cloud =]] setup
392
+
393
+
Because of the large range of possible configurations of [[= product_name =]], there are many possibilities beyond what is provided in the default recommended configuration.
394
+
395
+
Make sure to set aside time and budget for:
396
+
397
+
- Verifying your requirements and ensuring they're supported by Platform.sh
398
+
- Additional time for adaptation and configuration work, and testing by your development team
399
+
- Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience in using Platform.sh with [[= product_name =]]
400
+
401
+
The cost and effort of this isn't included in [[= product_name_cloud =]] subscription and is vary depending on the project.
402
+
403
+
### Custom integrations
404
+
405
+
Features supported by [[= product_name =]], but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services.
406
+
407
+
For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of [[= product_name =]].
408
+
We recommend giving the development team working on the project access to the bucket to ensure work is done in a DevOps way without depending on external teams when changes are needed.
409
+
290
410
=== "[[= product_name =]] v4.6"
291
411
292
412
### Cloud hosting with [[= product_name_cloud =]] and Platform.sh
0 commit comments