mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-09-24 16:30:27 +08:00
Remove OpenID auth from docs
Follow-up on https://github.com/galaxyproject/galaxy/pull/7028 .
This commit is contained in:
@@ -5,7 +5,6 @@ Galaxy supports the following authentication mechanisms:
|
||||
* [Galaxy Database](#galaxy-database) - Galaxy-specific login using e-mail address and password (the default);
|
||||
* [OIDC and OAuth2.0](#OIDC-and-OAuth2.0) - Login to Galaxy using your Google account, without having to create a Galaxy user;
|
||||
* [Authentication Framework](#authentication-framework) - A plugin-driven framework supporting LDAP/Active Directory and PAM;
|
||||
* [OpenID](#openid) - authentication with Galaxy as a relying party;
|
||||
* [Proxy Authentication](#proxy_authentication) - HTTP [remote user](http://httpd.apache.org/docs/current/mod/mod_cgi.html#env) provided by any front-end Web server.
|
||||
|
||||
## Galaxy Database
|
||||
@@ -38,16 +37,6 @@ To configure one or more authentication plugins, simply copy ``config/auth_conf.
|
||||
The provided sample configuration file has numerous commented out examples and serves as the most up-to-date source
|
||||
of documentation on configuring these plugins.
|
||||
|
||||
## OpenID
|
||||
|
||||
[OpenID](https://en.wikipedia.org/wiki/OpenID) is becoming less popular and probably shouldn't be used the primary mechanism
|
||||
for authentication in Galaxy but it is an available option.
|
||||
|
||||
Enabling OpenID requires you to edit Galaxy's configuration file and set `enable_openid` to `true`. This file is
|
||||
likely located in `config/galaxy.yml` and can be created by copying Galaxy's sample `config/galaxy.yml.sample`.
|
||||
|
||||
Enabling this option enables OpenID and causes the OpenID form to be displayed on the login screen.
|
||||
|
||||
## Remote User Authentication
|
||||
|
||||
If Galaxy is deployed with either nginx or Apache serving as a front-end proxy for Galaxy requests, they can be configured
|
||||
|
||||
@@ -75,8 +75,6 @@ Additional configuration files and their purposes are:
|
||||
used by users to control runtime parameters such as memory allocations, cluster selection, and so forth.
|
||||
- ``object_store_conf.xml``: Configures more advanced storage paradigms for Galaxy datasets, including layout across
|
||||
multiple filesystems, or in object storage systems such as Swift or Amazon S3.
|
||||
- ``openid_conf.xml``: Controls which OpenID (if enabled) providers should be presented as options to the user on the
|
||||
login form.
|
||||
- ``swarm_manager_conf.yml``: Configures the experimental Docker Swarm manager.
|
||||
- ``tool_destinations.yml``: Configures dynamic tool destinations, which allow for mapping tools to job destinations
|
||||
based on certain runtime job properties, such as the user submitting it, input sizes, and so forth.
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
galaxy\.openid package
|
||||
======================
|
||||
|
||||
.. automodule:: galaxy.openid
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
galaxy\.openid\.providers module
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: galaxy.openid.providers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
@@ -25,7 +25,6 @@ Subpackages
|
||||
galaxy.managers
|
||||
galaxy.model
|
||||
galaxy.objectstore
|
||||
galaxy.openid
|
||||
galaxy.quota
|
||||
galaxy.security
|
||||
galaxy.tools
|
||||
|
||||
@@ -33,14 +33,6 @@ galaxy\.web\.framework\.decorators module
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
galaxy\.web\.framework\.openid\_manager module
|
||||
----------------------------------------------
|
||||
|
||||
.. automodule:: galaxy.web.framework.openid_manager
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
galaxy\.web\.framework\.webapp module
|
||||
-------------------------------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user