Skip to content

Commit e2ce31a

Browse files
committed
[v5] Changes to requirements and installation procedure
1 parent 05bade9 commit e2ce31a

File tree

3 files changed

+174
-40
lines changed

3 files changed

+174
-40
lines changed

docs/getting_started/install_ibexa_dxp.md

Lines changed: 13 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -114,58 +114,32 @@ This operation is performed only once, when you install [[= product_name =]] for
114114

115115
To use Composer to instantly create a project in the current folder with all the dependencies, run the following command:
116116

117-
!!! note "Using PHP 8.3 (recommended)"
117+
=== "[[= product_name_headless =]]"
118118

119-
=== "[[= product_name_headless =]]"
120-
121-
``` bash
122-
composer create-project ibexa/headless-skeleton .
123-
```
124-
125-
=== "[[= product_name_exp =]]"
126-
127-
``` bash
128-
composer create-project ibexa/experience-skeleton .
129-
```
130-
131-
=== "[[= product_name_com =]]"
132-
133-
``` bash
134-
composer create-project ibexa/commerce-skeleton .
135-
```
136-
137-
??? note "Using PHP 8.2 or older"
138-
139-
If you're using PHP 8.2 or any older version, use a different set of commands:
140-
141-
=== "[[= product_name_headless =]]"
119+
``` bash
120+
composer create-project ibexa/headless-skeleton .
121+
```
142122

143-
``` bash
144-
composer create-project ibexa/headless-skeleton --no-install .
145-
composer update
146-
```
123+
=== "[[= product_name_exp =]]"
147124

148-
=== "[[= product_name_exp =]]"
125+
``` bash
126+
composer create-project ibexa/experience-skeleton .
127+
```
149128

150-
``` bash
151-
composer create-project ibexa/experience-skeleton --no-install .
152-
composer update
153-
```
129+
=== "[[= product_name_com =]]"
154130

155-
=== "[[= product_name_com =]]"
131+
``` bash
132+
composer create-project ibexa/commerce-skeleton .
133+
```
156134

157-
``` bash
158-
composer create-project ibexa/commerce-skeleton --no-install .
159-
composer update
160-
```
161135

162136
!!! tip "Authentication token"
163137

164138
<a id="authentication-token"></a>If you added credentials to the `COMPOSER_AUTH` variable, at this point add this variable to `auth.json` (for example, by running `echo $COMPOSER_AUTH > auth.json`).
165139

166140
!!! tip
167141

168-
You can set [different version constraints](https://getcomposer.org/doc/articles/versions.md), for example, specific tag (`[[= latest_tag_4_6 =]]`), version range (`~4.6.10`), or stability (`^4.6@rc`):
142+
You can set [different version constraints](https://getcomposer.org/doc/articles/versions.md), for example, specific tag (`[[= latest_tag_5_0 =]]`), version range (`~5.0.1`), or stability (`^5.0@rc`):
169143

170144
``` bash
171145
composer create-project ibexa/experience-skeleton:[[= latest_tag_4_6 =]] .

docs/getting_started/requirements.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
3030

3131
## Operating system
3232

33+
=== "[[= product_name =]] v5.0"
34+
35+
|Name|Version|
36+
|---|---|
37+
|Debian 10 "Buster" |10.0-10.13+|
38+
|Debian 11 "Bullseye"|11.0-11.7+|
39+
|Ubuntu "Focal Fossa" | 20.04 |
40+
|Ubuntu "Jammy Jellyfish"| 22.04 |
41+
|Ubuntu "Noble Numbat"| 24.04 |
42+
|RHEL / CentOS / CentOS Stream | 8.1-9.5+ |
43+
44+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
45+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
46+
3347
=== "[[= product_name =]] v4.6"
3448

3549
|Name|Version|
@@ -59,6 +73,15 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
5973

6074
## Web server
6175

76+
=== "[[= product_name =]] v5.0"
77+
78+
- Nginx 1.18-1.25+
79+
- Apache 2.4 (with required modules `mod_rewrite`, `mod_env` and recommended: `mod_setenvif`, `mod_expires`;
80+
event MPM is recommended, if you need to use prefork you also need the `mod_php` module)
81+
82+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
83+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
84+
6285
=== "[[= product_name =]] v4.6"
6386

6487
- Nginx 1.18-1.25+
@@ -76,6 +99,15 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
7699

77100
## DBMS
78101

102+
=== "[[= product_name =]] v5.0"
103+
104+
- MariaDB 10.3-10.11+
105+
- MySQL 8.0
106+
- PostgreSQL 14
107+
108+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
109+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
110+
79111
=== "[[= product_name =]] v4.6"
80112

81113
- MariaDB 10.3-10.11+
@@ -96,6 +128,10 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
96128

97129
## PHP
98130

131+
=== "[[= product_name =]] v5.0"
132+
133+
- 8.3
134+
99135
=== "[[= product_name =]] v4.6"
100136

101137
- 8.3
@@ -115,6 +151,22 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
115151

116152
### PHP extensions
117153

154+
=== "[[= product_name =]] v5.0"
155+
156+
- `php-cli`
157+
- `php-fpm`
158+
- `php-mysql` (`php-mysqlnd`) or `php-pgsql`
159+
- `php-xml`
160+
- `php-mbstring`
161+
- `php-json`
162+
- `php-process` (on RHEL/CentOS)
163+
- `php-intl`
164+
- `php-curl`
165+
- `php-pear` (optional, provides pecl)
166+
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
167+
- `php-sodium`
168+
- `php-bcmath`
169+
118170
=== "[[= product_name =]] v4.6"
119171

120172
- `php-cli`
@@ -148,6 +200,10 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
148200

149201
### Cluster PHP extensions
150202

203+
=== "[[= product_name =]] v5.0"
204+
205+
- `php-redis` or `php-memcached`
206+
151207
=== "[[= product_name =]] v4.6"
152208

153209
- `php-redis` or `php-memcached`
@@ -158,6 +214,13 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
158214

159215
## Search
160216

217+
=== "[[= product_name =]] v5.0"
218+
219+
- For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher.
220+
Alternatively, Elasticsearch 7.16.2 or higher 7.x version.
221+
- The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS.
222+
Newer versions aren't supported.
223+
161224
=== "[[= product_name =]] v4.6"
162225

163226
- For content search, Solr 7.7 LTS or Solr 8, recommended 8.11.1 or higher.
@@ -174,6 +237,21 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
174237

175238
## Graphic Handler
176239

240+
=== "[[= product_name =]] v5.0"
241+
242+
- GraphicsMagick
243+
- ImageMagick
244+
- GD
245+
246+
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:
247+
248+
- JpegOptim
249+
- Optipng
250+
- Pngquant 2
251+
- SVGO 1
252+
- Gifsicle
253+
- cwebp
254+
177255
=== "[[= product_name =]] v4.6"
178256

179257
- GraphicsMagick
@@ -206,6 +284,15 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
206284

207285
## [Clustering](clustering.md)
208286

287+
=== "[[= product_name =]] v5.0"
288+
289+
- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
290+
- Redis 4.0+, 5.0 or higher (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
291+
- [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)
292+
293+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
294+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
295+
209296
=== "[[= product_name =]] v4.6"
210297

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

227314
## Filesystem
228315

316+
=== "[[= product_name =]] v5.0"
317+
318+
- Linux ext4 / XFS
319+
229320
=== "[[= product_name =]] v4.6"
230321

231322
- Linux ext4 / XFS
@@ -236,6 +327,10 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
236327

237328
## Package manager
238329

330+
=== "[[= product_name =]] v5.0"
331+
332+
- Composer: recent 2.7 version
333+
239334
=== "[[= product_name =]] v4.6"
240335

241336
- Composer: recent 2.7 version
@@ -246,6 +341,14 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
246341

247342
## Asset manager
248343

344+
=== "[[= product_name =]] v5.0"
345+
346+
- `Node.js` 18+
347+
- `yarn` 1.15.2+
348+
349+
If you see a "+" next to the product version, it indicates a recommended version or higher within the same major release.
350+
For example, "1.18+" means any 1.x version equal to or higher than 1.18, but not 2.x.
351+
249352
=== "[[= product_name =]] v4.6"
250353

251354
- `Node.js` 18+
@@ -265,6 +368,16 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
265368

266369
## Browser
267370

371+
=== "[[= product_name =]] v5.0"
372+
373+
[[= product_name =]] is developed to work with *any* web browser that supports modern standards, on *any* screen resolution suitable for web, running on *any* device.
374+
However for the Editorial and Administration User Interfaces you need: a minimum of 1366-by-768 screen resolution, a desktop or tablet device, and a recommended/supported browser among the ones found below.
375+
376+
- Mozilla® Firefox® most recent stable version (recommended)
377+
- Google Chrome™ most recent stable version (recommended)
378+
- Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop *and* tablet
379+
- Apple® Safari® most recent stable version, desktop *and* tablet
380+
268381
=== "[[= product_name =]] v4.6"
269382

270383
[[= product_name =]] is developed to work with *any* web browser that supports modern standards, on *any* screen resolution suitable for web, running on *any* device.
@@ -287,6 +400,52 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,
287400

288401
## [[= product_name_cloud =]] requirements and setup
289402

403+
=== "[[= product_name =]] v5.0"
404+
405+
### Cloud hosting with [[= product_name_cloud =]] and Platform.sh
406+
407+
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.
408+
409+
For example:
410+
411+
- Platform.sh provides Redis support for versions 3.2, 4.0 and 5.0. [[= product_name =]] supports Redis version 4.0 or higher, and recommends 5.0.
412+
As a result, Redis is supported on [[= product_name_cloud =]] in versions 4.0 and 5.0, but 5.0 is recommended.
413+
414+
Features or services supported by [[= product_name =]] but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations).
415+
416+
### [[= product_name_cloud =]] Setup support matrix
417+
418+
All [[= product_name =]] features are supported in accordance with the example above.
419+
420+
!!! note
421+
422+
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.
423+
424+
### Recommended [[= product_name_cloud =]] setup
425+
426+
For more details on recommended setup configuration see bundled `.platform.app.yaml` and `.platform/` configuration files.
427+
428+
These files are kept up-to-date with latest recommendations and can be improved through contributions.
429+
430+
### Supported [[= product_name_cloud =]] setup
431+
432+
Because of the large range of possible configurations of [[= product_name =]], there are many possibilities beyond what is provided in the default recommended configuration.
433+
434+
Make sure to set aside time and budget for:
435+
436+
- Verifying your requirements and ensuring they're supported by Platform.sh
437+
- Additional time for adaptation and configuration work, and testing by your development team
438+
- 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 =]]
439+
440+
The cost and effort of this isn't included in [[= product_name_cloud =]] subscription and is vary depending on the project.
441+
442+
### Custom integrations
443+
444+
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.
445+
446+
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 =]].
447+
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.
448+
290449
=== "[[= product_name =]] v4.6"
291450

292451
### Cloud hosting with [[= product_name_cloud =]] and Platform.sh

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -948,8 +948,9 @@ extra:
948948
latest_tag_4_4: '4.4.4'
949949
latest_tag_4_5: '4.5.7'
950950
latest_tag_4_6: '4.6.19'
951+
latest_tag_5_0: '5.0.0'
951952

952-
symfony_doc: 'https://symfony.com/doc/5.x'
953+
symfony_doc: 'https://symfony.com/doc/7.2'
953954
user_doc: 'https://doc.ibexa.co/projects/userguide/en/5.0'
954955
connect_doc: 'https://doc.ibexa.co/projects/connect/en/latest'
955956

0 commit comments

Comments
 (0)