You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/adminguide/ui.rst
+83-1Lines changed: 83 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,10 @@ the default username is password.
45
45
46
46
Domain -> If you are a root User, leave this field blank.
47
47
48
+
.. note::
49
+
50
+
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`.
51
+
48
52
If you are a User in the sub-domains, enter the full path to the domain,
49
53
excluding the root domain.
50
54
@@ -508,7 +512,64 @@ For displaying a custom HTML in the plugin, HTML file can be stored in the Cloud
508
512
|ui-custom-plugin.png|
509
513
510
514
511
-
Instance Image Selction Customisation
515
+
Announcement Banner
516
+
===================
517
+
518
+
Admin can configure an **announcement banner** in `config.json` to display alerts or messages to all users.
519
+
This banner is useful for communicating important notices such as performance issues, scheduled maintenance, or general announcements.
520
+
To enable and customize the banner, use the `announcementBanner` section in the config.json file.
521
+
522
+
This section supports the following properties:
523
+
524
+
**Configuration Example**
525
+
526
+
.. parsed-literal::
527
+
528
+
"announcementBanner": {
529
+
"enabled": true,
530
+
"showIcon": true,
531
+
"closable": true,
532
+
"persistDismissal": true,
533
+
"type": "warning",
534
+
"message": "<strong>Performance Notice:</strong> We're experiencing high load. Some operations may be slower than usual.",
535
+
"startDate": "2025-06-01T00:00:00Z",
536
+
"endDate": "2025-07-16T00:00:00Z"
537
+
}
538
+
539
+
**Banner Display Example**
540
+
541
+
Based on the configuration above, the following banner is shown in the user interface:
- **enabled**: Enables or disables the announcement banner (`true` or `false`).
552
+
- **showIcon**: Displays an icon alongside the message. The icon corresponds to the banner `type`.
553
+
- **closable**: Allows users to close the banner.
554
+
- **persistDismissal**: Remembers the user's dismissal of the banner, so it doesn't reappear.
555
+
- **type**: Specifies the type of banner. Supported values are:
556
+
557
+
- `info`
558
+
- `warning`
559
+
- `error`
560
+
- `success`
561
+
562
+
- **message**: The HTML-formatted content displayed in the banner.
563
+
- **startDate** / **endDate**: Define the visibility window for the banner using ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`).
564
+
565
+
.. note::
566
+
567
+
- The `message` property supports basic HTML, allowing styled content such as `<strong>` tags for emphasis.
568
+
- Banner's background color changes based on `type` property value. White color is used for banner if `type` is not defined or has invalid value.
569
+
- Multi-line message is supported, however recommendation is to limit it to 2 lines. Content may overlap banner for more than 2 lines.
570
+
571
+
572
+
Instance Image Selection Customisation
512
573
-------------------------------------
513
574
514
575
In the UI, there are several forms where the user needs to select an image (template/ISO) for an instance, such as deploying an instance, reinstalling an instance, creating a VNF appliance, etc. The image selection interface for these forms can be selected by the operator based on preference by specifying properties in the UI configuration file (config.json).
@@ -523,6 +584,7 @@ The *legacy* interface will display images based on templatefilter/isofilter, i.
523
584
524
585
|ui-legacy-image-selection.png|
525
586
587
+
526
588
Advanced UI Customisation
527
589
~~~~~~~~~~~~~~~~~~~~~~~~~
528
590
@@ -602,6 +664,23 @@ For the UI to work with different servers, it is necessary to configure the Ngin
602
664
603
665
|ui-multiple-server-management.png|
604
666
667
+
.. _enable-login-to-project-view:
668
+
669
+
Enable Login to Project View
670
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
671
+
672
+
User can use the file /etc/cloudstack/management/config.json to enable the Project field displayed on Login by the setting:
0 commit comments