description
Install Ibexa DXP on a Linux system and prepare your installation for production.

Install Ibexa DXP

!!! note

Installation for production is only supported on Linux.

To install [[= product_name =]] for development on macOS or Windows, see the [installation guide for macOS and Windows](install_on_mac_os_and_windows.md).

!!! note "Installing [[= product_name_oss =]]"

This installation guide shows in details how to install [[= product_name =]] for users who have a subscription agreement with [[= product_name_base =]].
If you want to install [[= product_name_oss =]], you don't need authentication tokens or an account on updates.ibexa.co, but must adapt the steps shown here to the product edition and the `ibexa/oss-skeleton` repository.

Prepare work environment

To install [[= product_name =]] you need a stack with your operating system, MySQL or MariaDB, and PHP.

You can install it by following your favorite tutorial, for example: Install LAMP stack on Ubuntu.

Additional requirements:

Node.js and Yarn for asset management
git for version control

For production, you need to configure an HTTP server, Apache or nginx (Apache is used as an example below).

Before getting started, make sure you review other requirements to see the systems that is supported and used for testing.

Get Composer

Install a recent stable version of Composer, the PHP command line dependency manager. Use the package manager for your Linux distribution. For example, on Ubuntu:

apt-get install composer

To verify that you have the most recent stable version of Composer, you can run:

composer -V

!!! tip "Install Composer locally"

If you want to install Composer inside your project root directory only, follow the instructions for [installing Composer in the current directory](https://getcomposer.org/download/).

If you do so, you must replace `composer` with `php -d memory_limit=-1 composer.phar` in all commands below.

Install [[= product_name =]]

Set up authentication tokens

[[= product_name =]] subscribers have access to commercial packages at updates.ibexa.co. The site is password-protected. You must set up authentication tokens to access the site.

Log in to your service portal on support.ibexa.co, go to your Service Portal, and look for the following on the Maintenance and Support agreement details screen:

Select Create token (this requires the Portal administrator access level).
Fill in a label describing the use of the token. This allows you to revoke access later.
Save the password, you aren't able to access it again.

!!! tip "Save the authentication token in auth.json to avoid re-typing it"

Composer asks whether you want to save the token every time you perform an update.
If you prefer, you can decline and create an `auth.json` file globally in [`COMPOSER_HOME`](https://getcomposer.org/doc/03-cli.md#composer-home) directory for machine-wide use:

``` bash
composer config --global http-basic.updates.ibexa.co <installation-key> <token-password>
```

To store your credentials per project, add the credentials to the `COMPOSER_AUTH` variable:

``` bash
export COMPOSER_AUTH='{"http-basic":{"updates.ibexa.co": {"username": "<your-key>", "password": "<your-password>"}}}'
```

You then need to [add the contents of this variable to `auth.json`](#authentication-token).

!!! tip "Different tokens for different projects on a single host"

If you configure several projects on one machine, make sure that you set different tokens for each of the projects in their respective `auth.json` files.

After this, when running Composer to get updates, you're asked for a username and password. Use:

as username - your Installation key found on the Maintenance and Support agreement details page in the service portal
as password - the token password you retrieved in step 3 above

!!! note "Authentication token validation delay"

You can encounter some delay between creating the token and being able to use it in Composer.
It might take up to 15 minutes.

!!! caution "Support agreement expiry"

If your Support agreement expires, your authentication token(s) will no longer work.
They will become active again if the agreement is renewed, but this process may take up to 24 hours.
_(If the agreement is renewed before the expiry date, there will be no disruption of service.)_

If Composer asks for your GitHub token, you must log in to your GitHub account and generate a new token (edit your profile and go to Developer settings > Personal access tokens > Generate new token with default settings). This operation is performed only once, when you install [[= product_name =]] for the first time.

Create project

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

    ``` 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 --no-install .
    composer update
    ```

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

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

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

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

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

!!! note "Platform.sh"

If you're deploying your installation on [Platform.sh](https://docs.platform.sh/guides/ibexa/deploy.html), run the following command:

``` bash
composer ibexa:setup --platformsh
```

This command provides the necessary configuration for using Platform.sh.

Add project to version control

It's recommended to add your project to version control. Initiate your project repository:

git init; git add . > /dev/null; git commit -m "init" > /dev/null

Change installation parameters

At this point configure your database via the DATABASE_URL in the .env file, depending of the database you're using:

DATABASE_URL=mysql://user:password@host:port/database_name.

or

DATABASE_URL=postgresql://user:password@host:port/database_name.

!!! tip "Encoding database password"

The password entered in `DATABASE_URL` must either be URL encoded, or not contain any special characters that would require URL encoding.

For more information, see [Encoding database password](troubleshooting.md#encoding-database-password).

Add entropy to improve cryptographic randomness

Choose a [secret]([[= symfony_doc =]]/reference/configuration/framework.html#secret) and provide it in the APP_SECRET parameter in .env. It should be a random string, made up of at least 32 characters, numbers, and symbols. It's used by Symfony when generating [CSRF tokens]([[= symfony_doc =]]/security/csrf.html), [encrypting cookies]([[= symfony_doc =]]/security/remember_me.html), and for creating signed URIs when using [ESI (Edge Side Includes)]([[= symfony_doc =]]/http_cache/esi.html).

!!! caution

The app secret is crucial to the security of your installation.
Be careful about how you generate it, and how you store it.
Here's one way to generate a 64 characters long, secure random string as your secret, from command line:

``` bash
php -r "print bin2hex(random_bytes(32));"
```

Don't commit the secret to version control systems, or share it with anyone who doesn't strictly need it.
If you have any suspicion that the secret may have been exposed, replace it with a new one.
The same goes for other secrets, like database password, Varnish invalidate token, JWT passphrase, and more.

After changing the app secret, make sure that you clear the application cache and log out all the users.

For more information, see [Symfony documentation]([[= symfony_doc =]]/reference/configuration/framework.html#secret).

It's recommended to store the database credentials in your `.env.local` file and not commit it to the Version Control System.

In DATABASE_VERSION you can also configure the database server version (for a MariaDB database, prefix the value with mariadb-).

!!! tip "Using PostgreSQL"

If you want an installation with PostgreSQL instead of MySQL or MariaDB, refer to [Using PostgreSQL](databases.md#using-postgresql).

Install and configure a search engine

You may choose to replace the default search engine with either Solr or Elasticsearch.

=== "Solr"

Follow [How to set up Solr search engine](install_solr.md) to install Solr.

=== "Elasticsearch"

Do the following steps to enable Elasticsearch:

1. [Download and install Elasticsearch](install_elasticsearch.md)
2. [Verify that the Elasticsearch instance is up](install_elasticsearch.md#verify-the-instance)
3. [Set the default search engine](install_elasticsearch.md#set-the-default-search-engine)
4. [Configure the search engine](configure_elasticsearch.md)
5. [Push the templates](install_elasticsearch.md#push-the-templates)

Configure the following parameter in the `.env` file:

```
ELASTICSEARCH_DSN=http://localhost:9200
```

Create a database

Install [[= product_name =]] and create a database with:

php bin/console ibexa:install
php bin/console ibexa:graphql:generate-schema

Before executing the command make sure that the database user has sufficient permissions.

Run post-installation script

Run the post-installation script with the following command:

composer run post-install-cmd

Use PHPs built-in server

For development you can use the built-in PHP server.

php -S 127.0.0.1:8000 -t public

Your PHP web server is accessible at http://127.0.0.1:8000

You can also use Symfony CLI:

symfony serve

Prepare installation for development

Consider adding the Symfony DebugBundle which fixes memory outage when dumping objects with circular references. The DebugBundle contains the [VarDumper]([[= symfony_doc =]]/components/var_dumper.html) and [its Twig integration]([[= symfony_doc =]]/components/var_dumper.html#debugbundle-and-twig-integration).

composer require --dev symfony/debug-bundle

For detailed information about request treatment, you can also install [Symfony Profiler]([[= symfony_doc =]]/profiler.html):

composer require --dev symfony/profiler-pack

To get both features in one go use:

composer require --dev symfony/debug-pack

Configure an HTTP server

To use [[= product_name =]] with an HTTP server, you need to set up directory permissions and prepare a virtual host.

Set up permissions

For development needs, the web user can be made the owner of all your files (for example with the www-data web user):

chown -R www-data:www-data <your installation directory>

Directories var and public/var must be writable by CLI and the web server user. Future files and directories created by these two users need to inherit those permissions.

!!! caution

For security reasons, in production, the web server cannot have write access to other directories than `var`.
Skip the step above and follow the link below for production needs instead.

You must also make sure that the web server cannot interpret the files in the `var` directory through PHP.
To do so, follow the instructions on [setting up a virtual host below](#set-up-virtual-host).

To set up permissions for production, it's recommended to use an ACL (Access Control List). See [Setting up or Fixing File Permissions]([[= symfony_doc =]]/setup/file_permissions.html) in Symfony documentation for information on how to do it on different systems.

Set up virtual host

Prepare a virtual host configuration for your site.

=== "Apache"

You can copy [the example vhost file](https://raw.githubusercontent.com/ibexa/post-install/main/resources/templates/apache2/vhost.template)
to `/etc/apache2/sites-available` as a `.conf` file and modify it to fit your project.

Specify `/<your installation directory>/public` as the `DocumentRoot` and `Directory`, or ensure `BASEDIR` is set in the environment.
Uncomment the line that starts with `#if [APP_ENV]` and set the value to `prod` or `dev`, depending on the environment that you're configuring, or ensure `APP_ENV` is set in the environment.

```
SetEnvIf Request_URI ".*" APP_ENV=prod
```

When the virtual host file is ready, enable the virtual host and disable the default:

``` bash
a2ensite ibexa
a2dissite 000-default.conf
```

Finally, restart the Apache server.
The command may vary depending on your Linux distribution.
For example, on Ubuntu use:

``` bash
service apache2 restart
```

=== "nginx"

You can use [this example vhost file](https://raw.githubusercontent.com/ibexa/post-install/main/resources/templates/nginx/vhost.template) and modify it to fit your project. You also need the `ibexa_params.d` files that should reside in a subdirectory below where the main file is, [as is shown here](https://github.com/ibexa/post-install/tree/main/resources/templates/nginx).


Specify `/<your installation directory>/public` as the `root`, or ensure `BASEDIR` is set in the environment.
Ensure `APP_ENV` is set to `prod` or `dev` in the environment, depending on the environment that you're configuring, and uncomment the line that starts with `#if[APP_ENV`.

When the virtual host file is ready, enable the virtual host and disable the default.
Finally, restart the nginx server.
The command may vary depending on your Linux distribution.

Open your project in the browser by visiting the domain address, for example http://localhost:8080. You should see the welcome page.

Post-installation steps

!!! note "Security checklist"

See the [Security checklist](security_checklist.md) for a list of security-related issues you should take care of before going live with a project.

Enable Date-based Publisher

To enable delayed publishing of Content using the Date-based Publisher, you must set up cron to run the bin/console ibexa:scheduled:run command periodically.

For example, to check for publishing every minute, add the following script:

echo '* * * * * cd [path-to-ibexa-dxp]; php bin/console ibexa:cron:run --quiet --env=prod' > ibexa_cron.txt

For 5-minute intervals:

echo '*/5 * * * * cd [path-to-ibexa-dxp]; php bin/console ibexa:cron:run --quiet --env=prod' > ibexa_cron.txt

Next, append the new cron to user's crontab without destroying existing crons. Assuming the web server user data is www-data:

crontab -u www-data -l | cat - ibexa_cron.txt | crontab -u www-data -

Finally, remove the temporary file:

rm ibexa_cron.txt

Enable the Link manager

To make use of the Link Manager.

[[= product_name_cloud =]]

If you want to host your application on [[= product_name_cloud =]], follow the Ibexa Cloud procedure.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

install_ibexa_dxp.md

install_ibexa_dxp.md

Install Ibexa DXP

Prepare work environment

Get Composer

Install [[= product_name =]]

Set up authentication tokens

Create project

Add project to version control

Change installation parameters

Add entropy to improve cryptographic randomness

Install and configure a search engine

Create a database

Run post-installation script

Use PHPs built-in server

Prepare installation for development

Configure an HTTP server

Set up permissions

Set up virtual host

Post-installation steps

Enable Date-based Publisher

Enable the Link manager

[[= product_name_cloud =]]

Files

install_ibexa_dxp.md

Latest commit

History

install_ibexa_dxp.md

File metadata and controls

Install Ibexa DXP

Prepare work environment

Get Composer

Install [[= product_name =]]

Set up authentication tokens

Create project

Add project to version control

Change installation parameters

Add entropy to improve cryptographic randomness

Install and configure a search engine

Create a database

Run post-installation script

Use PHPs built-in server

Prepare installation for development

Configure an HTTP server

Set up permissions

Set up virtual host

Post-installation steps

Enable Date-based Publisher

Enable the Link manager

[[= product_name_cloud =]]