Skip to content

Commit fb8035a

Browse files
authored
fix: installation commands in documentation (#104)
1 parent 0ae89e5 commit fb8035a

3 files changed

Lines changed: 23 additions & 6 deletions

File tree

doc/03_Getting_Started/01_Installation/03_Advanced_Installation_Topics/05_Env_Var_Definitions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,8 @@ final readonly class SolrEnvVarDefinition implements EnvVarDefinitionInterface
180180
Use `--env-definition` to inject additional definitions alongside those defined in the profile,
181181
without modifying the profile itself:
182182

183+
> When running via Docker, prepend `docker compose exec php` to the command below.
184+
183185
```bash
184186
vendor/bin/pimcore-install \
185187
--install-profile='App\Installer\SkeletonProfile' \

doc/03_Getting_Started/01_Installation/03_Advanced_Installation_Topics/06_Post_Install_Commands.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ final class CustomDataMigration implements PostInstallHookInterface
111111
Use `--post-install-commands` to inject additional `PostInstallCommandsProviderInterface`
112112
implementations without modifying the profile:
113113

114+
> When running via Docker, prepend `docker compose exec php` to the commands below.
115+
114116
```bash
115117
vendor/bin/pimcore-install \
116118
--install-profile='App\Installer\SkeletonProfile' \

doc/03_Getting_Started/01_Installation/03_Advanced_Installation_Topics/README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,25 @@ To fully automate the installation process, set all required values as environme
99
and pass the `--no-interaction` flag:
1010

1111
```bash
12-
DATABASE_URL='mysql://pimcore:pimcore@db:3306/pimcore' \
13-
PIMCORE_ADMIN_USER=admin \
14-
PIMCORE_ADMIN_PASSWORD='secure-password' \
15-
docker compose exec php vendor/bin/pimcore-install \
16-
--install-profile='App\Installer\SkeletonProfile' \
17-
--no-interaction
12+
docker compose exec \
13+
-e DATABASE_URL='mysql://pimcore:pimcore@db:3306/pimcore' \
14+
-e PIMCORE_ADMIN_USER=admin \
15+
-e PIMCORE_ADMIN_PASSWORD='secure-password' \
16+
php vendor/bin/pimcore-install \
17+
--install-profile='App\Installer\SkeletonProfile' \
18+
--no-interaction
1819
```
1920

21+
:::info
22+
23+
`docker compose exec` does not forward host-shell environment variables into the
24+
container automatically. Pass each variable explicitly with `-e VAR=value` (or
25+
`-e VAR` to forward a variable already exported in the host shell), or set the
26+
values in your `.env` / `docker-compose.yaml` so they are available to the `php`
27+
service at runtime.
28+
29+
:::
30+
2031
The `--no-interaction` flag suppresses all interactive prompts.
2132
All required values must be provided via environment variables or CLI options.
2233

@@ -102,6 +113,8 @@ and the available extension points for developers:
102113
By default, the installer validates all collected values (e.g., testing the database connection,
103114
pinging OpenSearch). To skip validation during development:
104115

116+
> When running via Docker, prepend `docker compose exec php` to the commands below.
117+
105118
```bash
106119
# Skip all validation
107120
vendor/bin/pimcore-install --install-profile='App\Installer\MyProfile' --skip-validation

0 commit comments

Comments
 (0)