Skip to content

UI: Add option to enable Project field on login to directly login to project view #515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added source/_static/images/ui-login-project-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions source/adminguide/ui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ the default username is password.

Domain -> If you are a root User, leave this field blank.

.. note::

Since 4.21 it is possible to login to a specific Project view by enabling the 'displayProjectFieldOnLogin' setting on config.json (which is disabled by default). Please refer to: :ref:`enable-login-to-project-view`.

If you are a User in the sub-domains, enter the full path to the domain,
excluding the root domain.

Expand Down Expand Up @@ -583,6 +587,23 @@ For the UI to work with different servers, it is necessary to configure the Ngin

|ui-multiple-server-management.png|

.. _enable-login-to-project-view:

Enable Login to Project View
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

User can use the file /etc/cloudstack/management/config.json to enable the Project field displayed on Login by the setting:

============================= =================================================================
Property Description
============================= =================================================================
displayProjectFieldOnLogin Disabled by default. When enabled, login directly to Project view
============================= =================================================================

When the Project field is set and the Project exists, the user is directly directed to the Project view instead of the Default View.

|ui-login-project-view.png|

Known Limitations
~~~~~~~~~~~~~~~~~

Expand All @@ -601,3 +622,6 @@ The following features are no longer supported or available in the UI but are st

.. |ui-multiple-server-management.png| image:: /_static/images/ui-multiple-server-management.png
:alt: Custom plugin shown in UI with navigation

.. |ui-login-project-view.png| image:: /_static/images/ui-login-project-view.png
:alt: Enabling the Project field on login