diff --git a/README.md b/README.md index a619e4c..8761604 100644 --- a/README.md +++ b/README.md @@ -35,15 +35,21 @@ This Yunohost package will install Dex and setup a canonical OpenID Connect prov ## Disclaimers / important information -* Known limitations : - * Only tested on x86 architectures - * Dex only allows you to setup one OpenID Connect app at a time - * However, it's a working multi-instance app, so you can install it more than once - * Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider +### Known limitations : -* To be used carefully : - * Changing URL will work but will require some settings change in the app using Dex as an OIDC provider - * Going to the URL will only let you see a "This is where Dex is installed." message + * Can't be installed yet using the web UI. You have to use the CLI +``` +sudo yunohost app install https://github.com/Yunohost-Apps/dex_ynh +``` + * Only tested on x86 architectures + * Dex only allows you to setup one OpenID Connect app at a time + * However, it's a working multi-instance app, so you can install it more than once + * Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider + +### To be used carefully : + + * Changing URL will work but will require some settings change in the app using Dex as an OIDC provider + * Going to the URL will only let you see a "This is where Dex is installed." message ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index 8f7c805..9ccb4db 100644 --- a/README_fr.md +++ b/README_fr.md @@ -31,15 +31,21 @@ This Yunohost package will install Dex and setup a canonical OpenID Connect prov ## Avertissements / informations importantes -* Known limitations : - * Only tested on x86 architectures - * Dex only allows you to setup one OpenID Connect app at a time - * However, it's a working multi-instance app, so you can install it more than once - * Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider +### Known limitations : -* To be used carefully : - * Changing URL will work but will require some settings change in the app using Dex as an OIDC provider - * Going to the URL will only let you see a "This is where Dex is installed." message + * Can't be installed yet using the web UI. You have to use the CLI +``` +sudo yunohost app install https://github.com/Yunohost-Apps/dex_ynh +``` + * Only tested on x86 architectures + * Dex only allows you to setup one OpenID Connect app at a time + * However, it's a working multi-instance app, so you can install it more than once + * Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider + +### To be used carefully : + + * Changing URL will work but will require some settings change in the app using Dex as an OIDC provider + * Going to the URL will only let you see a "This is where Dex is installed." message ## Documentations et ressources diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index efbecab..b15f8f6 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,9 +1,15 @@ -* Known limitations : - * Only tested on x86 architectures - * Dex only allows you to setup one OpenID Connect app at a time - * However, it's a working multi-instance app, so you can install it more than once - * Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider +### Known limitations : -* To be used carefully : - * Changing URL will work but will require some settings change in the app using Dex as an OIDC provider - * Going to the URL will only let you see a "This is where Dex is installed." message + * Can't be installed yet using the web UI. You have to use the CLI +``` +sudo yunohost app install https://github.com/Yunohost-Apps/dex_ynh +``` + * Only tested on x86 architectures + * Dex only allows you to setup one OpenID Connect app at a time + * However, it's a working multi-instance app, so you can install it more than once + * Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider + +### To be used carefully : + + * Changing URL will work but will require some settings change in the app using Dex as an OIDC provider + * Going to the URL will only let you see a "This is where Dex is installed." message