Skip to content

Commit 3e05d75

Browse files
authored
Merge pull request #82 from OpenConext/feature/clarify-intitial-setup-instructions
Clarify initial setup instructions in README
2 parents da6f2b3 + 477635b commit 3e05d75

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

core/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,23 @@ This repo contains a docker compose and some configuration to get you started wi
88
## Getting started
99

1010
### The first time
11-
If you are doing this for the first time, first start the environment and then seed it:
11+
On first run, the `engine` service requires the database to be initialised before it can become healthy.
12+
Start the environment in one terminal, then run the init script in a second terminal.
1213

13-
1. Start the environment:
14+
**Terminal 1** — start the environment (this will block while waiting for all services to become healthy):
1415
```
15-
./start-dev-env.sh
16+
./start-dev-env.sh engine:/path/to/OpenConext-engineblock
1617
```
1718

18-
2. Once all containers are up, seed the environment:
19+
**Terminal 2** — once you see mariadb and engine starting in terminal 1, seed the environment (the script waits internally until they are ready before proceeding):
1920
```
2021
./scripts/init.sh
2122
```
2223

24+
After init completes, terminal 1 will finish and the environment is ready.
25+
2326
### After initialisation
24-
To start the environment again after the initial setup:
27+
To start the environment again after the initial setup, a single terminal is sufficient — engine will become healthy on its own because the database is already initialised:
2528

2629
```
2730
./start-dev-env.sh

core/stop-dev-env.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
# Use docker compose to start the environment but with the modified override file(s)
44
echo -e "Stopping the dev environment with the following command:\n"
55

6-
command='docker compose --profile "*" -f docker-compose.yml down'
6+
command='docker compose --profile oidc --profile extras --profile invite --profile php --profile dashboard --profile sbs -f docker-compose.yml down'
77
echo "$command"
88
exec $command

0 commit comments

Comments
 (0)