Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 14 additions & 40 deletions docs/getting_started/install_ibexa_dxp.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,61 +114,35 @@ This operation is performed only once, when you install [[= product_name =]] for

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

!!! note "Using PHP 8.3 (recommended)"
=== "[[= product_name_headless =]]"

=== "[[= product_name_headless =]]"

``` bash
composer create-project ibexa/headless-skeleton .
```

=== "[[= product_name_exp =]]"

``` bash
composer create-project ibexa/experience-skeleton .
```

=== "[[= product_name_com =]]"

``` bash
composer create-project ibexa/commerce-skeleton .
```

??? note "Using PHP 8.2 or older"

If you're using PHP 8.2 or any older version, use a different set of commands:

=== "[[= product_name_headless =]]"
``` bash
composer create-project ibexa/headless-skeleton .
```

``` bash
composer create-project ibexa/headless-skeleton --no-install .
composer update
```
=== "[[= product_name_exp =]]"

=== "[[= product_name_exp =]]"
``` bash
composer create-project ibexa/experience-skeleton .
```

``` bash
composer create-project ibexa/experience-skeleton --no-install .
composer update
```
=== "[[= product_name_com =]]"

=== "[[= product_name_com =]]"
``` bash
composer create-project ibexa/commerce-skeleton .
```

``` bash
composer create-project ibexa/commerce-skeleton --no-install .
composer update
```

!!! tip "Authentication token"

<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`).

!!! tip

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`):
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`):

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

!!! note "Platform.sh"
Expand Down
159 changes: 159 additions & 0 deletions docs/getting_started/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,

## Operating system

=== "[[= product_name =]] v5.0"

|Name|Version|
|---|---|
|Debian 10 "Buster" |10.0-10.13+|
|Debian 11 "Bullseye"|11.0-11.7+|
|Ubuntu "Focal Fossa" | 20.04 |
|Ubuntu "Jammy Jellyfish"| 22.04 |
|Ubuntu "Noble Numbat"| 24.04 |
|RHEL / CentOS / CentOS Stream | 8.1-9.5+ |

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.

=== "[[= product_name =]] v4.6"

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

## Web server

=== "[[= product_name =]] v5.0"

- Nginx 1.18-1.25+
- Apache 2.4 (with required modules `mod_rewrite`, `mod_env` and recommended: `mod_setenvif`, `mod_expires`;
event MPM is recommended, if you need to use prefork you also need the `mod_php` module)

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.

=== "[[= product_name =]] v4.6"

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

## DBMS

=== "[[= product_name =]] v5.0"

- MariaDB 10.3-10.11+
- MySQL 8.0
- PostgreSQL 14

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.

=== "[[= product_name =]] v4.6"

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

## PHP

=== "[[= product_name =]] v5.0"

- 8.3

=== "[[= product_name =]] v4.6"

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

### PHP extensions

=== "[[= product_name =]] v5.0"

- `php-cli`
- `php-fpm`
- `php-mysql` (`php-mysqlnd`) or `php-pgsql`
- `php-xml`
- `php-mbstring`
- `php-json`
- `php-process` (on RHEL/CentOS)
- `php-intl`
- `php-curl`
- `php-pear` (optional, provides pecl)
- `php-gd` or `php-imagick` (via pecl on RHEL/CentOS)
- `php-sodium`
- `php-bcmath`

=== "[[= product_name =]] v4.6"

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

### Cluster PHP extensions

=== "[[= product_name =]] v5.0"

- `php-redis` or `php-memcached`

=== "[[= product_name =]] v4.6"

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

## Search

=== "[[= product_name =]] v5.0"

- 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.
- The above solutions require Oracle Java/Open JDK. The minimum requirement is 8 LTS, recommended 11 LTS.
Newer versions aren't supported.

=== "[[= product_name =]] v4.6"

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

## Graphic Handler

=== "[[= product_name =]] v5.0"

- GraphicsMagick
- ImageMagick
- GD

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:

- JpegOptim
- Optipng
- Pngquant 2
- SVGO 1
- Gifsicle
- cwebp

=== "[[= product_name =]] v4.6"

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

## [Clustering](clustering.md)

=== "[[= product_name =]] v5.0"

- Linux NFS or S3/EFS (for IO, aka binary files stored in content repository, not supported with legacy)
- 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
- [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)

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.

=== "[[= product_name =]] v4.6"

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

## Filesystem

=== "[[= product_name =]] v5.0"

- Linux ext4 / XFS

=== "[[= product_name =]] v4.6"

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

## Package manager

=== "[[= product_name =]] v5.0"

- Composer: recent 2.7 version

=== "[[= product_name =]] v4.6"

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

## Asset manager

=== "[[= product_name =]] v5.0"

- `Node.js` 18+
- `yarn` 1.15.2+

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.

=== "[[= product_name =]] v4.6"

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

## Browser

=== "[[= product_name =]] v5.0"

[[= 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.
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.

- Mozilla® Firefox® most recent stable version (recommended)
- Google Chrome™ most recent stable version (recommended)
- Chromium™ based browsers such as Microsoft® Edge® and Opera®, most recent stable version, desktop *and* tablet
- Apple® Safari® most recent stable version, desktop *and* tablet

=== "[[= product_name =]] v4.6"

[[= 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.
Expand All @@ -287,6 +400,52 @@ Recommendation for production setups is to use Varnish/Fastly, Redis/Memcached,

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

=== "[[= product_name =]] v5.0"

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

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.

For example:

- 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.
As a result, Redis is supported on [[= product_name_cloud =]] in versions 4.0 and 5.0, but 5.0 is recommended.

Features or services supported by [[= product_name =]] but not covered by Platform.sh may be possible by means of a [custom integration](#custom-integrations).

### [[= product_name_cloud =]] Setup support matrix

All [[= product_name =]] features are supported in accordance with the example above.

!!! note

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.

### Recommended [[= product_name_cloud =]] setup

For more details on recommended setup configuration see bundled `.platform.app.yaml` and `.platform/` configuration files.

These files are kept up-to-date with latest recommendations and can be improved through contributions.

### Supported [[= product_name_cloud =]] setup

Because of the large range of possible configurations of [[= product_name =]], there are many possibilities beyond what is provided in the default recommended configuration.

Make sure to set aside time and budget for:

- Verifying your requirements and ensuring they're supported by Platform.sh
- Additional time for adaptation and configuration work, and testing by your development team
- 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 =]]

The cost and effort of this isn't included in [[= product_name_cloud =]] subscription and is vary depending on the project.

### Custom integrations

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.

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 =]].
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.

=== "[[= product_name =]] v4.6"

### Cloud hosting with [[= product_name_cloud =]] and Platform.sh
Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -948,8 +948,9 @@ extra:
latest_tag_4_4: '4.4.4'
latest_tag_4_5: '4.5.7'
latest_tag_4_6: '4.6.19'
latest_tag_5_0: '5.0.0'

symfony_doc: 'https://symfony.com/doc/5.x'
symfony_doc: 'https://symfony.com/doc/7.2'
user_doc: 'https://doc.ibexa.co/projects/userguide/en/5.0'
connect_doc: 'https://doc.ibexa.co/projects/connect/en/latest'

Expand Down
Loading