# DDEV and Ibexa Cloud Two ways are available to run an Ibexa Cloud project locally with DDEV: - [by using the `ddev-upsun` and `ddev-ibexa-cloud` add-ons](#with-ibexa-cloud-add-ons) - [like other existing project, without these add-ons](#without-ibexa-cloud-add-ons). Note The following examples use [Ibexa Cloud CLI (`ibexa_cloud`)](https://cli.ibexa.co/). ## With Ibexa Cloud add-ons To configure [`ddev/ddev-upsun` add-on](https://github.com/ddev/ddev-upsun) and [`ddev/ddev-ibexa-cloud` add-on](https://github.com/ddev/ddev-ibexa-cloud), you need a [Upsun API Token](https://fixed.docs.upsun.com/administration/cli/api-tokens.html). The `ddev/ddev-upsun` add-on configures the document root, the PHP version, the database, and the cache pool according to the Ibexa Cloud configuration. About the search engine, the add-on can configure Elasticsearch but can't configure Solr. If you use Solr on Ibexa Cloud and want to add it to your DDEV stack, see [Clustering with DDEV and `ibexa/ddev-solr` add-on](https://doc.ibexa.co/en/latest/infrastructure_and_maintenance/clustering/clustering_with_ddev/#solr). The `ddev/ddev-ibexa-cloud` add-on integrates the `ibexa_cloud` command inside the container, and eases the pull of cloud contents into the local installation. `env:COMPOSER_AUTH` from Upsun can't be used, because JSON commas are incorrectly interpreted by `--web-environment-add`, which sees them as multiple variable separators. But the variable must exist for Upsun `hooks` scripts to work. To use an `auth.json` file for this purpose, see [Using `auth.json`](https://doc.ibexa.co/en/latest/getting_started/install_with_ddev/#using-authjson). The following sequence of commands: 1. Downloads the Ibexa Cloud project from the default environment "production" into a new directory (for example `my-ddev-project`), using the [`ibexa_cloud` command](https://cli.ibexa.co/). (Replace `` with the hash of your own project. See [`ibexa_cloud help get`](https://fixed.docs.upsun.com/administration/cli.html#3-use) for options like selecting another environment). 1. Configures a new DDEV project. 1. Configures the `ddev/ddev-ibexa-cloud` add-on with ``, environment name (for example, `production`), and application name (for example, `app` from `name: app` line in `.platform.app.yaml` file). 1. Configures `ibexa_cloud` command token. See [Create an API token](https://fixed.docs.upsun.com/administration/cli/api-tokens.html#2-create-an-api-token) for more information. 1. Ignores `.ddev/` directory from Git. (Some DDEV config could be committed like in [this documentation](https://ddev.readthedocs.io/en/latest/users/extend/customization-extendibility/#extending-configyaml-with-custom-configyaml-files).) 1. Sets Composer authentication by using an already existing `auth.json` file. 1. Installs the `ddev/ddev-upsun` add-on which prompts for the Upsun API token, project ID and environment name. 1. Changes `maxmemory-policy` from default `allkeys-lfu` to a [value accepted by the `RedisTagAwareAdapter`](https://github.com/symfony/cache/blob/5.4/Adapter/RedisTagAwareAdapter.php#L95). (Check `.ddev/config.upsun.yaml` and adapt if needed. For example, you may have to comment out New Relic.) 1. Installs the `ddev/ddev-ibexa-cloud` add-on. 1. Starts the project. 1. Gets the content from Ibexa Cloud, both database and binary files by using `ddev pull ibexa-cloud` feature from the add-on. 1. Displays information about the project services. 1. Opens the project in a browser. ``` ibexa_cloud project:get my-ddev-project && cd my-ddev-project ddev config --project-type=php --php-version 8.3 --web-environment-add COMPOSER_AUTH='',DATABASE_URL=mysql://db:db@db:3306/db ddev config --web-environment-add IBEXA_PROJECT=,IBEXA_ENVIRONMENT=production,IBEXA_APP=app ddev config --web-environment-add IBEXA_CLI_TOKEN= echo '.ddev/' >> .gitignore mkdir -p .ddev/homeadditions/.composer && cp /auth.json .ddev/homeadditions/.composer ddev add-on get ddev/ddev-upsun sed -i 's/maxmemory-policy allkeys-lfu/maxmemory-policy volatile-lfu/' .ddev/redis/redis.conf ddev add-on get ddev/ddev-ibexa-cloud ddev start ddev pull ibexa-cloud -y ddev describe ddev launch ``` Note The Upsun API token is set at user profile level, therefore it's stored globally under current user root as `PLATFORMSH_CLI_TOKEN` in `~/.ddev/global_config.yaml`. ## Without Ibexa Cloud add-ons The following example adapts the [manual method to run an already existing project](https://doc.ibexa.co/en/latest/getting_started/install_with_ddev/#run-an-already-existing-project) to the Upsun case: The following sequence of commands: 1. Downloads the Ibexa Cloud Upsun project from the default environment "production" into a new directory, using the [Ibexa Cloud CLI](https://cli.ibexa.co/). (Replace `` with the hash of your own project. See [`ibexa_cloud help get`](https://fixed.docs.upsun.com/administration/cli.html#3-use) for options like selecting another environment). 1. Configures a new DDEV project. 1. Ignores `.ddev/` directory from Git. (Some DDEV config could be committed like in [this documentation](https://ddev.readthedocs.io/en/latest/users/extend/customization-extendibility/#extending-configyaml-with-custom-configyaml-files).) 1. Starts the DDEV project. 1. Sets Composer authentication. 1. [Gets the database content from Upsun](https://fixed.docs.upsun.com/add-services/mysql.html#exporting-data). 1. [Imports this database content into DDEV project's database](https://ddev.readthedocs.io/en/latest/users/usage/database-management/#database-imports). 1. [Downloads the Upsun public/var locally](https://fixed.docs.upsun.com/development/file-transfer.html#transfer-a-file-from-a-mount) to have the content binary files. 1. Install the dependencies and run post-install scripts. 1. Displays information about the project services. 1. Opens the DDEV project in a browser. ``` ibexa_cloud project:get my-ddev-project && cd my-ddev-project ddev config --project-type=php --php-version 8.3 --docroot=public --web-environment-add DATABASE_URL=mysql://db:db@db:3306/db echo '.ddev/' >> .gitignore ddev start ddev composer config --global http-basic.updates.ibexa.co ibexa_cloud db:dump --gzip --file=production.sql.gz ddev import-db --file=production.sql.gz && rm production.sql.gz ibexa_cloud mount:download --mount public/var --target public/var ddev composer install ddev describe ddev launch ``` From there, services can be added to get closer to Ibexa Cloud architecture. `.platform/services.yaml` indicates the services used. For more information, see [Clustering with DDEV](https://doc.ibexa.co/en/latest/infrastructure_and_maintenance/clustering/clustering_with_ddev/index.md).