mirror of
https://github.com/YunoHost-Apps/dex_ynh.git
synced 2024-09-03 18:26:22 +02:00
Auto-update README
This commit is contained in:
parent
4d53fba00f
commit
c8f0ee1ca9
2 changed files with 22 additions and 34 deletions
28
README.md
28
README.md
|
@ -15,15 +15,13 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
Dex is an identity service that uses OpenID Connect to drive authentication for other apps.
|
||||||
|
This Yunohost package will install Dex and setup a canonical OpenID Connect provider for your Yunohost instance, based on the LDAP user base, that can then be used as an authentification server for other Yunohost apps.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
- Fully working OpenID Connect authentification flow
|
||||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
- Interfaced with Yunohost's LDAP server
|
||||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
|
||||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
|
||||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
|
||||||
|
|
||||||
|
|
||||||
**Shipped version:** 2.31.1~ynh1
|
**Shipped version:** 2.31.1~ynh1
|
||||||
|
@ -37,18 +35,14 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
||||||
|
|
||||||
## Disclaimers / important information
|
## Disclaimers / important information
|
||||||
|
|
||||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
* Known limitations :
|
||||||
* requiring a full dedicated domain ?
|
* Only tested on x86 architectures
|
||||||
* architectures not supported ?
|
* Dex only allows you to setup one OpenID Connect app at a time
|
||||||
* not-working single-sign on or LDAP integration ?
|
* However, it's a working multi-instance app, so you can install it more than once
|
||||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
* Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider
|
||||||
* etc...
|
|
||||||
|
|
||||||
* Other infos that people should be aware of, such as:
|
* To be used carefully :
|
||||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
* Changing URL will work but will require some settings change in the app using Dex as an OIDC provider
|
||||||
* how to configure / administrate the application if it ain't obvious
|
|
||||||
* upgrade process / specificities / things to be aware of ?
|
|
||||||
* security considerations ?
|
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
|
|
28
README_fr.md
28
README_fr.md
|
@ -11,15 +11,13 @@ Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour
|
||||||
|
|
||||||
## Vue d'ensemble
|
## Vue d'ensemble
|
||||||
|
|
||||||
Some long and extensive description of what the app is and does, lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
Dex is an identity service that uses OpenID Connect to drive authentication for other apps.
|
||||||
|
This Yunohost package will install Dex and setup a canonical OpenID Connect provider for your Yunohost instance, based on the LDAP user base, that can then be used as an authentification server for other Yunohost apps.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- Ut enim ad minim veniam, quis nostrud exercitation ullamco ;
|
- Fully working OpenID Connect authentification flow
|
||||||
- Laboris nisi ut aliquip ex ea commodo consequat ;
|
- Interfaced with Yunohost's LDAP server
|
||||||
- Duis aute irure dolor in reprehenderit in voluptate ;
|
|
||||||
- Velit esse cillum dolore eu fugiat nulla pariatur ;
|
|
||||||
- Excepteur sint occaecat cupidatat non proident, sunt in culpa."
|
|
||||||
|
|
||||||
|
|
||||||
**Version incluse :** 2.31.1~ynh1
|
**Version incluse :** 2.31.1~ynh1
|
||||||
|
@ -33,18 +31,14 @@ Some long and extensive description of what the app is and does, lorem ipsum dol
|
||||||
|
|
||||||
## Avertissements / informations importantes
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
* Known limitations :
|
||||||
* requiring a full dedicated domain ?
|
* Only tested on x86 architectures
|
||||||
* architectures not supported ?
|
* Dex only allows you to setup one OpenID Connect app at a time
|
||||||
* not-working single-sign on or LDAP integration ?
|
* However, it's a working multi-instance app, so you can install it more than once
|
||||||
* the app requires an important amount of RAM / disk / .. to install or to work properly
|
* Dex is only an OIDC provider, and user management will depend on the app using it as an OIDC provider
|
||||||
* etc...
|
|
||||||
|
|
||||||
* Other infos that people should be aware of, such as:
|
* To be used carefully :
|
||||||
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
* Changing URL will work but will require some settings change in the app using Dex as an OIDC provider
|
||||||
* how to configure / administrate the application if it ain't obvious
|
|
||||||
* upgrade process / specificities / things to be aware of ?
|
|
||||||
* security considerations ?
|
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue