Skip to content
This repository was archived by the owner on May 3, 2023. It is now read-only.

Commit d3daf07

Browse files
pablothedudepmeulen
authored andcommitted
Update documentation with latest changes
1 parent a563363 commit d3daf07

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

.env.dist

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ APP_SECRET=secret
77
# APP_OPAQUE_ID=
88
# APP_READID_SERVER_FQDN=
99
# APP_WEBHOOK_TOKEN=
10+
# APP_ATTRIBUTES_MAPPING='{}'

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,24 @@ Install
3131
1. Edit the `.env` file with the editor of your choice and:
3232
1. Update the `APP_SECRET` to a value of your liking. See [Symfony docs](https://symfony.com/doc/current/reference/configuration/framework.html#secret) for more details about this secret.
3333
1. Set the `APP_ENV` to 'dev'
34+
1. Set the `APP_ATTRIBUTES_MAPPING` with a json key value pair:
35+
36+
```'{"readIdAttribute1":"samlAttribute1", "readIdAttribute1":"samlAttribute1"}'```
3437

3538
**Copy the parameters.yaml**
3639

3740
`$ cp config/packages/parameters.yaml.dist config/packages/parameters.yaml`
3841

3942
**Bring up Docker**
4043

44+
The scrip below will also install the required Yarn and Composer development dependencies and finally build the Encore web assets.
4145
```
4246
$ ./support/docker/init.sh
4347
```
4448

45-
If everything goes as intended, you can develop in the virtual machine.
49+
If everything goes as intended, you can develop in the container.
4650

47-
The machine should be available at: [127.43.33.34:443](https://127.43.33.34:443). Feel free to add a `hosts` file entry,
51+
The container should be available at: [127.43.33.34:443](https://127.43.33.34:443). Feel free to add a `hosts` file entry,
4852
I used:
4953

5054
[readid.stepup.example.com](https://readid.stepup.example.com)
@@ -99,6 +103,5 @@ Please read: https://github.com/OpenConext/Stepup-Deploy/wiki/Release-Management
99103
Other resources
100104
======================
101105

102-
- [Developer documentation](docs/index.md)
103106
- [Issue tracker](https://www.pivotaltracker.com/n/projects/1163646)
104107
- [License](LICENSE)

support/docker/init.sh

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,14 @@ gid=$(id -g)
55
printf "UID=${uid}\nGID=${gid}\nCOMPOSE_PROJECT_NAME=readid" > .env
66

77
docker-compose up -d
8+
9+
# Install backend dependencies
10+
docker-compose exec -T php-fpm.readid.stepup.example.com bash -c '
11+
composer install -n
12+
'
13+
14+
# Install frontend dependencies
15+
docker-compose exec -T php-fpm.readid.stepup.example.com bash -c '
16+
yarn install --frozen-lockfile
17+
yarn dev
18+
'

0 commit comments

Comments
 (0)