From 730b931b871d447d9bc4ebe465a0e68bacf48baa Mon Sep 17 00:00:00 2001 From: vjalili Date: Mon, 19 Mar 2018 17:45:16 -0700 Subject: [PATCH] OIDC config in galaxy.yml.sample is now set via config_schema. --- config/galaxy.yml.sample | 10 ++++--- doc/source/admin/galaxy_options.rst | 30 +++++++++++++++++++++ lib/galaxy/webapps/galaxy/config_schema.yml | 21 +++++++++++++++ 3 files changed, 58 insertions(+), 3 deletions(-) diff --git a/config/galaxy.yml.sample b/config/galaxy.yml.sample index ab02e7dda3d..09a46400a92 100644 --- a/config/galaxy.yml.sample +++ b/config/galaxy.yml.sample @@ -1380,9 +1380,13 @@ galaxy: #openid_consumer_cache_path: database/openid_consumer_cache # Enables and disables OpenID Connect (OIDC) support. - #enable_oidc = True - #oidc_config_file = config/oidc_config.xml - #oidc_backends_config_file = config/oidc_backends_config.xml + #enable_oidc: false + + # Sets the path to OIDC configuration file. + #oidc_config_file: config/oidc_config.xml + + # Sets the path to OIDC backends configuration file. + #oidc_backends_config_file: config/oidc_backends_config.xml # XML config file that allows the use of different authentication # providers (e.g. LDAP) instead or in addition to local authentication diff --git a/doc/source/admin/galaxy_options.rst b/doc/source/admin/galaxy_options.rst index efe3b610d7e..9bfc5bef80c 100644 --- a/doc/source/admin/galaxy_options.rst +++ b/doc/source/admin/galaxy_options.rst @@ -2891,6 +2891,36 @@ :Type: str +~~~~~~~~~~~~~~~ +``enable_oidc`` +~~~~~~~~~~~~~~~ + +:Description: + Enables and disables OpenID Connect (OIDC) support. +:Default: ``false`` +:Type: bool + + +~~~~~~~~~~~~~~~~~~~~ +``oidc_config_file`` +~~~~~~~~~~~~~~~~~~~~ + +:Description: + Sets the path to OIDC configuration file. +:Default: ``config/oidc_config.xml`` +:Type: str + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``oidc_backends_config_file`` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +:Description: + Sets the path to OIDC backends configuration file. +:Default: ``config/oidc_backends_config.xml`` +:Type: str + + ~~~~~~~~~~~~~~~~~~~~ ``auth_config_file`` ~~~~~~~~~~~~~~~~~~~~ diff --git a/lib/galaxy/webapps/galaxy/config_schema.yml b/lib/galaxy/webapps/galaxy/config_schema.yml index e38430d682d..3e4b7595a6d 100644 --- a/lib/galaxy/webapps/galaxy/config_schema.yml +++ b/lib/galaxy/webapps/galaxy/config_schema.yml @@ -2147,6 +2147,27 @@ mapping: desc: | If OpenID is enabled, consumer cache directory to use. + enable_oidc: + type: bool + default: false + required: false + desc: | + Enables and disables OpenID Connect (OIDC) support. + + oidc_config_file: + type: str + default: config/oidc_config.xml + required: false + desc: | + Sets the path to OIDC configuration file. + + oidc_backends_config_file: + type: str + default: config/oidc_backends_config.xml + required: false + desc: | + Sets the path to OIDC backends configuration file. + auth_config_file: type: str default: config/auth_conf.xml