Skip to content

Commit cf8e433

Browse files
author
Rob Tjalma
committed
Added documentation
Signed-off-by: Rob Tjalma <[email protected]>
1 parent 311ee4c commit cf8e433

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,22 @@ Containing tools / configurations for deploying CoMPAS services.
1414
For demo purposes, a [demo Keycloak configuration](docker/keycloak/keycloak_compas_realm.json) is created which can be imported when
1515
running a Keycloak instance.
1616

17-
The following Keylcoak attributes have been added:
17+
The following Keycloak attributes have been added:
1818
- **CoMPAS Realm**: A separate CoMPAS realm containing all CoMPAS attributes like Groups, Client and Roles.
19-
- **CoMPAS Demo Role**: A separate CoMPAS role which can be assigned to users.
19+
- **OpenSCD client**: A client has been made for interacting with OpenSCD.
20+
- **SCL Data Service client**: A client has been made for interacting with the SCL Data Service.
21+
- **CRUD roles for the SCL Data Service**: Create, Read, Update and Delete roles have been added to the SCL Data Service client.
22+
When interacting with the SCL Data Service, a JWT token needs to have certain roles before interaction is possible. These roles are assigned to certain users (see below).
2023
- **CoMPAS Group**: A CoMPAS demo group has been added.
21-
- **A Demo User**: A Demo user. Username: 'user', password: 'user'.
24+
- **A Demo User**: A Demo user without specific roles.
25+
- Username: 'user'
26+
- Password: 'user'.
27+
- **A SCL Data Editor**: A user with the roles 'Create', 'Read', 'Update' and 'Delete'. This way, it has read and write access to the SCL Data Service.
28+
- Username: scl-data-editor
29+
- Password: editor
30+
- **A SCL Data Reader**: A user with the role 'Read'. This way, it only has reading access to the SCL Data Service.
31+
- Username: scl-data-reader
32+
- Password: reader
2233

2334
## Docker Compose
2435
There is a pre configured [Docker Compose](docker/docker-compose.yml) file, which starts all the given CoMPAS services.

0 commit comments

Comments
 (0)