Skip to content

Commit 32b6fe7

Browse files
committed
ddev_and_ibexa_cloud.md: Updates & fixes after review
1 parent 2883da0 commit 32b6fe7

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/ibexa_cloud/ddev_and_ibexa_cloud.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,37 @@ description: Use DDEV to run an Ibexa Cloud project locally.
66

77
Two ways are available to run an [[= product_name_cloud =]] project locally with DDEV:
88

9-
- [by using the Platform.sh's `ddev-platformsh` and `ddev-ibexa-cloud` add-ons](#with-the-ddev-platformsh-and-ddev-ibexa-cloud-add-ons)
10-
- [like other existing project, without this add-on](#without-the-ibexa-cloud-add-on).
9+
- [by using the `ddev-platformsh` and `ddev-ibexa-cloud` add-ons](#with-ibexa-cloud-add-ons)
10+
- [like other existing project, without these add-ons](#without-ibexa-cloud-add-ons).
1111

1212
!!! note
1313

1414
The following examples use [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.co/).
1515

16-
## With the `ddev-platformsh` and `ddev-ibexa-cloud` add-ons
16+
## With Ibexa Cloud add-ons
1717

1818
To configure [`ddev/ddev-platformsh` add-on](https://github.com/ddev/ddev-platformsh) and [`ddev/ddev-ibexa-cloud` add-on](https://github.com/ddev/ddev-ibexa-cloud), you need a [Platform.sh API Token](https://docs.platform.sh/administration/cli/api-tokens.html).
1919

2020
The `ddev/ddev-platformsh` add-on configures the document root, the PHP version, the database, and the cache pool according to the [[= product_name_cloud =]] configuration.
2121
About the search engine, the add-on can configure Elasticsearch but can't configure Solr.
2222
If you use Solr on [[= product_name_cloud =]] and want to add it to your DDEV stack, see [Clustering with DDEV and `ibexa/ddev-solr` add-on](clustering_with_ddev.md#solr).
2323

24-
The `ddev/ddev-ibexa-cloud` add-on integrate the `ibexa_cloud` command,
24+
The `ddev/ddev-ibexa-cloud` add-on integrates the `ibexa_cloud` command inside the container,
2525
and eases the pull of cloud contents into the local installation.
2626

2727
`env:COMPOSER_AUTH` from Platform.sh can't be used, because JSON commas are incorrectly interpreted by `--web-environment-add`, which sees them as multiple variable separators.
2828
But the variable must exist for Platform.sh `hooks` scripts to work.
2929
To use an `auth.json` file for this purpose, see [Using `auth.json`](install_with_ddev.md#using-authjson).
3030

31-
You must remove Node.js and NVM installations as they're already included in DDEV.
32-
3331
The following sequence of commands:
3432

3533
1. Downloads the [[= product_name_cloud =]] project from the default environment "production"
3634
into a new directory (for example `my-ddev-project`), using the [`ibexa_cloud` command](https://cli.ibexa.co/).
3735
(Replace `<project-ID>` with the hash of your own project.
3836
See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment).
3937
1. Configures a new DDEV project.
40-
1. Configures the `ddev/ddev-ibexa-cloud` add-on with `<project-ID>` and environment name (for example, `production`).
38+
1. Configures the `ddev/ddev-ibexa-cloud` add-on with `<project-ID>`, environment name (for example, `production`),
39+
and application name (for example, `app` from `name: app` line in `.platform.app.yaml` file).
4140
1. Configures `ibexa_cloud` command token. See [Create an API token](https://docs.platform.sh/administration/cli/api-tokens.html#2-create-an-api-token) for more information.
4241
1. Ignores `.ddev/` directory from Git.
4342
(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).)
@@ -60,7 +59,7 @@ echo '.ddev/' >> .gitignore
6059
mkdir -p .ddev/homeadditions/.composer && cp <path-to-an>/auth.json .ddev/homeadditions/.composer
6160
ddev add-on get ddev/ddev-platformsh
6261
sed -i 's/maxmemory-policy allkeys-lfu/maxmemory-policy volatile-lfu/' .ddev/redis/redis.conf
63-
ddev add-on get ddev/ddev-ibexa-cloud
62+
ddev add-on get ddev/ddev-ibexa-cloud
6463
ddev start
6564
ddev pull ibexa-cloud -y
6665
ddev describe
@@ -71,13 +70,13 @@ ddev launch
7170

7271
The Platform.sh 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`.
7372

74-
## Without the Ibexa Cloud add-on
73+
## Without Ibexa Cloud add-ons
7574

7675
The following example adapts the [manual method to run an already existing project](install_with_ddev.md#run-an-already-existing-project) to the Platform.sh case:
7776

7877
The following sequence of commands:
7978

80-
1. Downloads the [[= product_name_cloud =]] Platform.sh project from the default environment "production" into a new directory, based on the [Platform.sh CLI alias `ibexa_cloud` defined in introduction](#ibexa-cloud-and-ddev).
79+
1. Downloads the [[= product_name_cloud =]] Platform.sh project from the default environment "production" into a new directory, using the [[[= product_name_cloud =]] CLI](https://cli.ibexa.co/).
8180
(Replace `<project-ID>` with the hash of your own project. See [`ibexa_cloud help get`](https://docs.platform.sh/administration/cli.html#3-use) for options like selecting another environment).
8281
1. Configures a new DDEV project.
8382
1. Ignores `.ddev/` directory from Git.

0 commit comments

Comments
 (0)