Skip to content

Commit

Permalink
Update dev/openmage/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
colinmollenhour committed Apr 22, 2023
1 parent 54e9a77 commit c71585a
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions dev/openmage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,20 @@ on the containers used in this setup, but here are some quick tips:
- The `cli` service contains many useful tools like `composer`, `magerun`, `modman`, `mageconfigsync` and more.
- XDebug is enabled using `remote_connect_back=1` with `idekey=phpstorm`. Customize this in `.env` if needed as described below.

Here are some common commands you may wish to try:
Here are some common commands you may wish to try (from the `dev/openmage` directory):

```
$ docker-compose run --rm -u $(id -u):$(id -g) cli composer require {some-module}
$ docker-compose run --rm -u $(id -u):$(id -g) cli composer show
$ docker-compose run --rm -u $(id -u):$(id -g) cli bash
$ docker-compose run --rm cli magerun sys:check
$ docker-compose run --rm cli magerun cache:clean
$ docker-compose run --rm cli magerun db:console
$ docker-compose exec mysql mysql
```

- *The cli container runs as `www-data` by default so use `-u $(id -u):$(id -g)` with composer so that the container will create/modify files with your user permissions to avoid file permission errors in your IDE.*
- *Always use `run --rm` with the cli container to avoid creating lots of orphan containers.*

Environment Variables
---

Expand Down

0 comments on commit c71585a

Please sign in to comment.