Skip to content

Commit 633ed4c

Browse files
committed
Improvements to the requirements page (#2419)
1 parent 9318d34 commit 633ed4c

File tree

1 file changed

+4
-163
lines changed

1 file changed

+4
-163
lines changed

docs/getting_started/requirements.md

Lines changed: 4 additions & 163 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
3838

3939
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
4040

41-
=== "Ibexa DXP v4.5"
42-
43-
|Name|Version|
44-
|---|---|
45-
|Debian 10 "Buster" |10.0-10.13+|
46-
|Debian 11 "Bullseye"|11.0-11.7+|
47-
|Ubuntu "Focal Fossa" | 20.04 |
48-
|Ubuntu "Jammy Jellyfish"| 22.04 |
49-
|RHEL / CentOS | 8.1-8.5+ |
50-
51-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
52-
5341
=== "Ibexa DXP v3.3"
5442

5543
|Name|Version|
@@ -82,14 +70,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
8270

8371
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
8472

85-
=== "Ibexa DXP v4.5"
86-
87-
- Nginx 1.18-1.25+
88-
- Apache 2.4 (with required modules `mod_rewrite`, `mod_env` and recommended: `mod_setenvif`, `mod_expires`;
89-
event MPM is recommended, if you need to use prefork you also need the `mod_php` module)
90-
91-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
92-
9373
=== "Ibexa DXP v3.3"
9474

9575
- Nginx 1.18
@@ -112,14 +92,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
11292

11393
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
11494

115-
=== "Ibexa DXP v4.5"
116-
117-
- MariaDB 10.3-10.11+
118-
- MySQL 8.0
119-
- PostgreSQL 14
120-
121-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
122-
12395
=== "Ibexa DXP v3.3"
12496

12597
- MariaDB 10.3, 10.4 (optionally 10.2 - deprecated)
@@ -146,12 +118,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
146118
- 8.0 (PHP 8.0 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
147119
- 7.4 (PHP 7.4 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
148120

149-
=== "Ibexa DXP v4.5"
150-
151-
- 8.1
152-
- 8.0 (PHP 8.0 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
153-
- 7.4 (PHP 7.4 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should use PHP 8.1)
154-
155121
=== "Ibexa DXP v3.3"
156122

157123
- 8.2 (see note below)
@@ -184,7 +150,7 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
184150
- 7.3 (PHP 7.3 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should upgrade to Ibexa DXP v3.3 or v4.x)
185151
- 7.4 (PHP 7.4 has reached its End of Life. Unless you have extended support from vendors like Debian or Zend, you should upgrade to Ibexa DXP v3.3 or v4.x)
186152

187-
### PHP packages
153+
### PHP extensions
188154

189155
=== "Ibexa DXP v4.6"
190156

@@ -200,21 +166,7 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
200166
- `php-pear` (optional, provides pecl)
201167
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
202168
- `php-sodium`
203-
204-
=== "Ibexa DXP v4.5"
205-
206-
- `php-cli`
207-
- `php-fpm`
208-
- `php-mysql` (`php-mysqlnd`) or `php-pgsql`
209-
- `php-xml`
210-
- `php-mbstring`
211-
- `php-json`
212-
- `php-process` (on RHEL/CentOS)
213-
- `php-intl`
214-
- `php-curl`
215-
- `php-pear` (optional, provides pecl)
216-
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
217-
- `php-sodium`
169+
- `php-bcmath`
218170

219171
=== "Ibexa DXP v3.3"
220172

@@ -245,16 +197,12 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
245197
- `php-pear` (optional, provides pecl)
246198
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
247199

248-
### Cluster PHP packages
200+
### Cluster PHP extensions
249201

250202
=== "Ibexa DXP v4.6"
251203

252204
- `php-redis` or `php-memcached`
253205

254-
=== "Ibexa DXP v4.5"
255-
256-
- `php-redis` or `php-memcached`
257-
258206
=== "Ibexa DXP v3.3"
259207

260208
- `php-redis` or `php-memcached`
@@ -272,11 +220,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
272220
- For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher. Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
273221
- The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions are not supported.
274222

275-
=== "Ibexa DXP v4.5"
276-
277-
- For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher. Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
278-
- The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions are not supported.
279-
280223
=== "Ibexa DXP v3.3"
281224

282225
- For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher. Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
@@ -306,21 +249,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
306249
- Gifsicle
307250
- cwebp
308251

309-
=== "Ibexa DXP v4.5"
310-
311-
- GraphicsMagick
312-
- ImageMagick
313-
- GD
314-
315-
Optionally if you intend to edit [PNG, SVG, GIF or WEBP files in the Image Editor](images.md#image-optimization), or use it with image variations:
316-
317-
- JpegOptim
318-
- Optipng
319-
- Pngquant 2
320-
- SVGO 1
321-
- Gifsicle
322-
- cwebp
323-
324252
=== "Ibexa DXP v3.3"
325253

326254
- GraphicsMagick
@@ -352,14 +280,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
352280

353281
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
354282

355-
=== "Ibexa DXP v4.5"
356-
357-
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
358-
- Redis 4.0+, 5.0 or higher (separate instances for session and cache, both using a `volatile-*` [eviction policy](https://redis.io/docs/reference/eviction/), session instance configured for persistence) or [Memcached](https://memcached.org/) 1.5 or higher
359-
- [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)
360-
361-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
362-
363283
=== "Ibexa DXP v3.3"
364284

365285
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
@@ -382,10 +302,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
382302

383303
- Linux ext4 / XFS
384304

385-
=== "Ibexa DXP v4.5"
386-
387-
- Linux ext4 / XFS
388-
389305
=== "Ibexa DXP v3.3"
390306

391307
- Linux ext4 / XFS
@@ -400,18 +316,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
400316

401317
- Composer: recent 2.7 version
402318

403-
=== "Ibexa DXP v4.5"
404-
405-
- Composer: recent 2.1 version
406-
407-
=== "Ibexa DXP v3.3"
408-
409-
- Composer: recent 2.1 version
410-
411-
=== "eZ Platform v2.5"
412-
413-
- Composer: recent 2.1 version
414-
415319
=== "Ibexa DXP v3.3"
416320

417321
- Composer: recent 2.1 version
@@ -429,13 +333,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
429333

430334
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
431335

432-
=== "Ibexa DXP v4.5"
433-
434-
- `Node.js` 14+, 16+, 18+ (`Node.js` 14+ has reached its End of Life. We strongly recommend using a newer version to ensure you receive security updates.)
435-
- `yarn` 1.15.2+
436-
437-
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release. For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
438-
439336
=== "Ibexa DXP v3.3"
440337

441338
- `Node.js` 14+, 16+, 18+ (`Node.js` 14+ has reached its End of Life. We strongly recommend using a newer version to ensure you receive security updates.)
@@ -461,15 +358,6 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
461358
- Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop *and* tablet
462359
- Apple® Safari® most recent stable version, desktop *and* tablet
463360

464-
=== "Ibexa DXP v4.5"
465-
466-
Ibexa DXP is developed to work with *any* web browser that supports modern standards, on *any* screen resolution suitable for web, running on *any* device. However for the Editorial and Administration User Interfaces you'll need; a minimum of 1366-by-768 screen resolution, a desktop or tablet device, and a recommended/supported browser among the ones found below.
467-
468-
- Mozilla® Firefox® most recent stable version (recommended)
469-
- Google Chrome™ most recent stable version (recommended)
470-
- Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop *and* tablet
471-
- Apple® Safari® most recent stable version, desktop *and* tablet
472-
473361
=== "Ibexa DXP v3.3"
474362

475363
Ibexa DXP is developed to work with *any* web browser that supports modern standards, on *any* screen resolution suitable for web, running on *any* device. However for the Editorial and Administration User Interfaces you'll need; a minimum of 1366-by-768 screen resolution, a desktop or tablet device, and a recommended/supported browser among the ones found below.
@@ -537,54 +425,7 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
537425
We recommend giving the development team working on the project access to the bucket
538426
to ensure work is done in a DevOps way without depending on external teams when changes are needed.
539427

540-
=== "Ibexa Cloud v4.5"
541-
542-
### Cloud hosting with Ibexa Cloud and Platform.sh
543-
544-
In general, Ibexa Cloud supports all features and services of [Platform.sh](https://platform.sh/marketplace/ibexa/) that are compatible and supported by the Ibexa DXP version you use.
545-
546-
For example:
547-
548-
- Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. Ibexa DXP supports Redis version 4.0 or higher, and recommends 5.0. As a result, Redis is supported on Ibexa Cloud in versions 4.0 and 5.0, but 5.0 is recommended.
549-
550-
Features or services supported by Ibexa DXP but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations).
551-
552-
### Ibexa Cloud Setup support matrix
553-
554-
All Ibexa DXP features are supported in accordance with the example above. For example: As Legacy Bridge is not supported with v3, it is not supported on Ibexa Cloud either.
555-
556-
!!! note
557-
558-
As Platform.sh does not support a configuration with multiple PostgreSQL databases,
559-
for Ibexa Cloud / Platform.sh it is impossible to have a DFS table in a separate database.
560-
561-
### Recommended Ibexa Cloud setup
562-
563-
For more details on recommended setup configuration see bundled `.platform.app.yaml` and `.platform/` configuration files.
564-
565-
These files are kept up-to-date with latest recommendations and can be improved through contributions.
566-
567-
### Supported Ibexa Cloud setup
568-
569-
Because of the large range of possible configurations of Ibexa DXP, there are many possibilities beyond what is provided in the default recommended configuration.
570-
571-
Make sure to set aside time and budget for:
572-
573-
- Verifying your requirements and ensuring they are supported by Platform.sh
574-
- Additional time for adaptation and configuration work, and testing by your development team
575-
- Additional consulting/onboarding time with Platform.sh, Ibexa technical services, and/or one of the many partners with prior experience using Platform.sh with Ibexa DXP
576-
577-
The cost and effort of this is not included in Ibexa Cloud subscription and will vary depending on the project.
578-
579-
### Custom integrations
580-
581-
Features supported by Ibexa DXP, but not natively by Platform.sh, can in many cases be used by means of custom integrations with external services.
582-
583-
For example, you can create an integration with S3 by means of setting up your own S3 bucket and configuring the relevant parts of Ibexa DXP.
584-
We recommend giving the development team working on the project access to the bucket
585-
to ensure work is done in a DevOps way without depending on external teams when changes are needed.
586-
587-
=== "Ibexa Cloud v3.3 "
428+
=== "Ibexa Cloud v3.3"
588429

589430
### Cloud hosting with Ibexa Cloud and Platform.sh
590431

0 commit comments

Comments
 (0)