YunoHost-Apps/dex_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/dex_ynh.git synced 2024-09-03 18:26:22 +02:00
Code Issues Activity Actions
Federated OpenID Connect Provider package for YunoHost
71 commits 4 branches 0 tags 960 KiB
Shell 100%
Find a file
Limezy 7694f43e63 Updating to 2.31.1~ynh2
2022-04-04 18:05:36 +07:00
.github Initial commit 2022-03-23 15:15:13 +07:00
conf Update nginx.conf 2022-03-27 21:35:36 +07:00
doc Updating to 2.31.1~ynh2 2022-04-04 18:05:36 +07:00
scripts improving go 2022-04-03 13:31:33 +02:00
sources Initial commit 2022-03-23 15:15:13 +07:00
.gitignore Initial commit 2022-03-23 15:15:13 +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 Updating to 2.31.1~ynh2 2022-04-04 18:05:36 +07:00
README.md Auto-update README 2022-03-31 13:52:40 +00:00
README_fr.md Auto-update README 2022-03-31 13:52:40 +00:00

README.md

Dex for YunoHost

Integration level
Install Dex with 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.31.1~ynh1

Screenshots

Disclaimers / important information

Known limitations :

  • 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

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