eclipse-edc / IdentityHub

IdentityHub
Apache License 2.0
19 stars 25 forks source link

More accessible Quick Start Documentation #486

Open fvolz opened 2 days ago

fvolz commented 2 days ago

Feature More accessible Quick Start Documentation

The Quick Start documentation lists java -Dweb.http.presentation.port=10001 \ -Dweb.http.presentation.path="/api/presentation" \ -Dweb.http.port=8181 \ -Dweb.http.path="/api" \ -Dweb.http.identity.port=8182 \ -Dweb.http.identity.path="/api/identity" \ -Dedc.ih.api.superuser.key="c3VwZXItdXNlcgo=c3VwZXItc2VjcmV0Cg==" \ -jar launcher/identityhub/build/libs/identity-hub.jar

but this commands leads to a edc.api.accounts.key not set error for me.

Super user creation was removed in https://github.com/eclipse-edc/IdentityHub/pull/275 and the documentation https://github.com/eclipse-edc/IdentityHub/blob/main/docs/developer/architecture/identity-api.security.md could be updated so that it is clearer that it is no longer built-in, specifically this sentence "Thus, as per default behaviour, the built-in super-user role is granted access to all resources of all participant contexts." It would also be nice to explain the creation process either manually or with the superuser-seed extension.

The edc.ih.api.superuser.key value in the command above is misleading because the format should be base64(spId)+"."+base64(randomString)

This one works for me with the super user extension https://github.com/eclipse-edc/MinimumViableDataspace/tree/main/extensions/superuser-seed Quick start command: java -Dweb.http.presentation.port=10001 -Dweb.http.presentation.path="/api/presentation" -Dweb.http.port=8181 -Dweb.http.path="/api" -Dweb.http.identity.port=8182 -Dweb.http.identity.path="/api/identity" -Dedc.ih.api.superuser.key="c3VwZXItdXNlcg==.c3VwZXItc2VjcmV0Cg==" -Dedc.api.accounts.key="password" -jar launcher/identityhub/build/libs/identity-hub.jar

github-actions[bot] commented 2 days ago

Thanks for your contribution :fire: We will take a look asap :rocket: