mirror of https://github.com/YunoHost-Apps/dex_ynh.git synced 2024-09-03 18:26:22 +02:00

Federated OpenID Connect Provider package for YunoHost

Find a file

yunohost-bot 7a122dec20 Auto-update README		2022-10-12 06:34:08 +00:00
.github	Let's try the CI	2022-04-22 23:19:11 +07:00
conf	Upgrade to v2.35.3	2022-10-12 06:34:02 +00:00
doc	Remove .DS_Store	2022-06-11 13:53:16 +07:00
scripts	v2.35.0	2022-10-04 17:36:03 +07:00
sources	Initial commit	2022-03-23 15:15:13 +07:00
.gitignore	Remove .DS_Store	2022-06-11 13:53:16 +07:00
check_process	Update check_process	2022-03-24 14:42:59 +07:00
config_panel.toml.example	Initial commit	2022-03-23 15:15:13 +07:00
LICENSE	First commit	2022-03-23 16:11:19 +07:00
manifest.json	Upgrade to v2.35.3	2022-10-12 06:34:02 +00:00
README.md	Auto-update README	2022-10-12 06:34:08 +00:00
README_fr.md	Auto-update README	2022-10-12 06:34:08 +00:00

README.md

Dex for YunoHost

Lire ce readme en français.

This package allows you to install Dex quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

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

Fully working OpenID Connect authentification flow
Interfaced with Yunohost's LDAP server

Shipped version: 2.35.3~ynh1

Screenshots

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

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

Official app website: https://dexidp.io
Official admin documentation: https://dexidp.io/docs/
Upstream app code repository: https://github.com/dexidp/dex
YunoHost documentation for this app: https://yunohost.org/app_dex
Report a bug: https://github.com/YunoHost-Apps/dex_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/dex_ynh/tree/testing --debug
or
sudo yunohost app upgrade dex -u https://github.com/YunoHost-Apps/dex_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps