Skip to content

Commit

Permalink
Core: Update readme with start-dev-env instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
quartje committed Apr 8, 2024
1 parent fc5ada8 commit bf185d5
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,15 @@ If you want to start all services, you can use extras. A profile can be started
docker compose up -d --profile extras
```

# Starting a PHP project in development mode (only lifecycle, profile and engineblock)

You can mount your local directory inside a development container which contains the correct node and composer versions for your project. To do so use the script start-dev-env.sh. You can use this script to mount multiple directories in multiple containers, basically allowing you to start multiple containers in dev mode.

To mount the code in just one container:
`start-dev-env.sh profile:../../OpenConext-profile`
The recommended way is to use absolute paths and the script requires the name of the service and local code path to be separated by a `:`.

To mount the code in multiple containers:
`start-dev-env.sh profile:../../OpenConext-profile userlifecycle:../../OpenConext-user-lifecycle`
You can add as many services+local code paths that you need.
The recommended way is to use absolute paths and the script requires the name of the service and local code path to be separated by a `:`, for each service.
2 changes: 1 addition & 1 deletion core/engine/docker-compose.override.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
services:
profile:
engine:
image: ghcr.io/openconext/openconext-basecontainers/${ENGINE_PHP_IMAGE:-php72-apache2-node14-composer2:latest}
volumes:
- ${ENGINE_CODE_PATH}:/var/www/html
Expand Down
2 changes: 1 addition & 1 deletion core/userlifecycle/docker-compose.override.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
services:
profile:
userlifecycle:
image: ghcr.io/openconext/openconext-basecontainers/${USERLIFECYCLE_PHP_IMAGE:-php72-apache2-node14-composer2:latest}
volumes:
- ${USERLIFECYCLE_CODE_PATH}:/var/www/html
Expand Down

0 comments on commit bf185d5

Please sign in to comment.