Skip to content

Commit 8f8309e

Browse files
mnocondabrtadriendupuis
committed
[v5] Cherry-pick v5 changes to 4.6 (#2843)
* IBX-10245: Document 5.0 requirements (#2807) * IBX-10245: Document 5.0 requirements --------- Co-authored-by: Marek Nocoń <[email protected]> * IBX-10225: v5.0 release notes and deprecations (#2825) * IBX-10225: v5.0 release notes and deprecations --------- Co-authored-by: Marek Nocoń <[email protected]> * Procedure to update from 4.6 to 5.0 (#2760) --------- Co-authored-by: Marek Nocoń <[email protected]> * Converted links into absolute ones * Update procedure to update from 4.6 to 5.0 (#2844) * update_to_5.0.md: SymfonySetList::SYMFONY_73 * update_to_5.0.md: Use [[= product_name =]] * update_to_5.0.md: Fix Ibexa.EOLWhitespace * Fix broken build by converting the link to absolute * Reverted main page changes * Updated link Co-authored-by: Adrien Dupuis <[email protected]> * Added latest_tag_5_0 --------- Co-authored-by: Tomasz Dąbrowski <[email protected]> Co-authored-by: Adrien Dupuis <[email protected]>
1 parent 8054926 commit 8f8309e

File tree

9 files changed

+2179
-15
lines changed

9 files changed

+2179
-15
lines changed

docs/getting_started/requirements.md

Lines changed: 131 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The following server requirements cover both running the software on-premise and
1616
For running on [Ibexa Cloud](https://www.ibexa.co/products/ibexa-cloud), where recommended configuration and support is provided out of the box, see separate [Ibexa Cloud section](#ibexa-cloud-requirements-and-setup) for further reading on its requirements.
1717

1818
The minimal setup requires PHP, MySQL/MariaDB, Apache/Nginx, Node.js and `yarn`.
19-
Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached, NFS/EFS/S3 and Solr/Elasticsearch in a [clustered setup](clustering.md).
19+
For production setups it's recommended that you use Varnish/Fastly, Redis, NFS/EFS/S3 and Solr/Elasticsearch in a [clustered setup](clustering.md).
2020

2121
!!! caution "Recommended versions"
2222

@@ -26,7 +26,18 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
2626

2727
## Operating system
2828

29-
=== "Ibexa DXP v4.6"
29+
=== "[[= product_name =]] v5.0"
30+
31+
|Name|Version|
32+
|---|---|
33+
|Debian 11 "Bullseye"|11.0-11.7+|
34+
|Ubuntu "Noble Numbat"| 24.04 |
35+
|RHEL / CentOS / CentOS Stream | 8.1-9.5+ |
36+
37+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
38+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
39+
40+
=== "[[= product_name =]] v4.6"
3041

3142
|Name|Version|
3243
|---|---|
@@ -53,7 +64,16 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
5364

5465
## Web server
5566

56-
=== "Ibexa DXP v4.6"
67+
=== "[[= product_name =]] v5.0"
68+
69+
- Nginx 1.27+
70+
- Apache 2.4 (with required modules `mod_rewrite`, `mod_env` and recommended: `mod_setenvif`, `mod_expires`;
71+
event MPM is recommended, if you need to use prefork you also need the `mod_php` module)
72+
73+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
74+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
75+
76+
=== "[[= product_name =]] v4.6"
5777

5878
- Nginx 1.18-1.25+
5979
- Apache 2.4 (with required modules `mod_rewrite`, `mod_env` and recommended: `mod_setenvif`, `mod_expires`;
@@ -69,7 +89,16 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
6989

7090
## DBMS
7191

72-
=== "Ibexa DXP v4.6"
92+
=== "[[= product_name =]] v5.0"
93+
94+
- MariaDB 10.11+
95+
- MySQL 8.4
96+
- PostgreSQL 14
97+
98+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
99+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
100+
101+
=== "[[= product_name =]] v4.6"
73102

74103
- MariaDB 10.3-10.11+
75104
- MySQL 8.0, 8.4
@@ -106,7 +135,22 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
106135

107136
### PHP extensions
108137

109-
=== "Ibexa DXP v4.6"
138+
=== "[[= product_name =]] v5.0"
139+
140+
- `php-cli`
141+
- `php-fpm`
142+
- `php-mysql` (`php-mysqlnd`) or `php-pgsql`
143+
- `php-xml`
144+
- `php-mbstring`
145+
- `php-process` (on RHEL/CentOS)
146+
- `php-intl`
147+
- `php-curl`
148+
- `php-pear` (optional, provides pecl)
149+
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
150+
- `php-sodium`
151+
- `php-bcmath`
152+
153+
=== "[[= product_name =]] v4.6"
110154

111155
- `php-cli`
112156
- `php-fpm`
@@ -139,7 +183,11 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
139183

140184
### Cluster PHP extensions
141185

142-
=== "Ibexa DXP v4.6"
186+
=== "[[= product_name =]] v5.0"
187+
188+
- `php-redis`
189+
190+
=== "[[= product_name =]] v4.6"
143191

144192
- `php-redis` or `php-memcached`
145193

@@ -149,7 +197,12 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
149197

150198
## Search
151199

152-
=== "Ibexa DXP v4.6"
200+
=== "[[= product_name =]] v5.0"
201+
202+
- For content search, Solr 8.11.1 or higher.
203+
Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
204+
205+
=== "[[= product_name =]] v4.6"
153206

154207
- 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.
155208
- The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS. Newer versions are not supported.
@@ -194,7 +247,16 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
194247

195248
## [Clustering](clustering.md)
196249

197-
=== "Ibexa DXP v4.6"
250+
=== "[[= product_name =]] v5.0"
251+
252+
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
253+
- 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)
254+
- [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)
255+
256+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
257+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
258+
259+
=== "[[= product_name =]] v4.6"
198260

199261
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
200262
- Redis 4.0+ or 5.0+ (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) or [Memcached](https://memcached.org/) 1.5 or higher
@@ -222,7 +284,11 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
222284

223285
## Package manager
224286

225-
=== "Ibexa DXP v4.6"
287+
=== "[[= product_name =]] v5.0"
288+
289+
- Composer: recent 2.8 version
290+
291+
=== "[[= product_name =]] v4.6"
226292

227293
- Composer: recent 2.7 version
228294

@@ -232,7 +298,15 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
232298

233299
## Asset manager
234300

235-
=== "Ibexa DXP v4.6"
301+
=== "[[= product_name =]] v5.0"
302+
303+
- `Node.js` 22+
304+
- `yarn` 1.15.2+
305+
306+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
307+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
308+
309+
=== "[[= product_name =]] v4.6"
236310

237311
- `Node.js` 18+, 20+, 22+
238312
- `yarn` 1.15.2+
@@ -268,7 +342,53 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
268342

269343
## [[= product_name_cloud =]] requirements and setup
270344

271-
=== "Ibexa DXP v4.6"
345+
=== "[[= product_name =]] v5.0"
346+
347+
### Cloud hosting with [[= product_name_cloud =]] and Platform.sh
348+
349+
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.
350+
351+
For example:
352+
353+
- Platform.sh provides Redis support for versions 7.2, 7.0, and 6.2. [[= product_name =]] supports Redis version 7.2.
354+
As a result, Redis is supported on [[= product_name_cloud =]] in versions 7.2.
355+
356+
Features or services supported by [[= product_name =]] but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations).
357+
358+
### [[= product_name_cloud =]] Setup support matrix
359+
360+
All [[= product_name =]] features are supported in accordance with the example above.
361+
362+
!!! note
363+
364+
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.
365+
366+
### Recommended [[= product_name_cloud =]] setup
367+
368+
For more details on recommended setup configuration see bundled `.platform.app.yaml` and `.platform/` configuration files.
369+
370+
These files are kept up-to-date with latest recommendations and can be improved through contributions.
371+
372+
### Supported [[= product_name_cloud =]] setup
373+
374+
Because of the large range of possible configurations of [[= product_name =]], there are many possibilities beyond what is provided in the default recommended configuration.
375+
376+
Make sure to set aside time and budget for:
377+
378+
- Verifying your requirements and ensuring they're supported by Platform.sh
379+
- Additional time for adaptation and configuration work, and testing by your development team
380+
- 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 =]]
381+
382+
The cost and effort of this isn't included in [[= product_name_cloud =]] subscription and is vary depending on the project.
383+
384+
### Custom integrations
385+
386+
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.
387+
388+
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 =]].
389+
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.
390+
391+
=== "[[= product_name =]] v4.6"
272392

273393
### Cloud hosting with Ibexa Cloud and Platform.sh
274394

0 commit comments

Comments
 (0)