F OpenNebula/one#5522: Add custom logo guide (#2909)

Signed-off-by: Victor Hansson <vhansson@opennebula.io>
OpenNebula · May 8, 2024 · 71e2f8b · 71e2f8b
1 parent 70971a2
commit 71e2f8b
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 0 deletions.
diff --git a/source/images/fireedge_drawer_linux_logo.png b/source/images/fireedge_drawer_linux_logo.png
diff --git a/source/images/fireedge_drawer_linux_logo.png_original b/source/images/fireedge_drawer_linux_logo.png_original
diff --git a/source/images/fireedge_login_linux_logo.png b/source/images/fireedge_login_linux_logo.png
diff --git a/source/images/fireedge_login_linux_logo.png_original b/source/images/fireedge_login_linux_logo.png_original
diff --git a/source/installation_and_configuration/opennebula_services/fireedge.rst b/source/installation_and_configuration/opennebula_services/fireedge.rst
@@ -167,6 +167,41 @@ If you need to execute the FireEdge with SSL Certificate, in the following path:
 
 .. _fireedge_configuration_for_sunstone:
 
+Tuning and Extending
+====================
+
+.. _fireedge_branding:
+
+Branding FireEdge
+-----------------
+
+You can add your logo to the login, main, favicon and loading screens by updating the ``logo:`` attribute as follows:
+
+- The login screen is defined in the ``/etc/one/fireedge/sunstone/sunstone-views.yaml``.
+- The logo of the main UI screen is defined for each view.
+
+The logo image must be copied to ``/usr/lib/one/fireedge/src/client/assets/images/logos``.
+
+The following example shows how you can change the logo to a generic linux one (included by default in all FireEdge installations):
+
+.. code-block:: yaml
+
+    ---
+    logo: linux.png
+
+    groups:
+        oneadmin:
+            - admin
+            - user
+    default:
+        - user
+
+.. note::
+
+   The logo can be updated without having to restart the FireEdge server!
+
+|fireedge_sunstone_linux_login_logo| |fireedge_sunstone_linux_drawer_logo|
+
 Configure Sunstone for VMRC and Guacamole
 --------------------------------------------------------------------------------
 
@@ -265,3 +300,8 @@ If another service is using the port, you can change FireEdge configuration (``/
 
 .. |oneprovision_dashboard| image:: /images/oneprovision_dashboard.png
 .. |fireedge_sunstone_dashboard| image:: /images/fireedge_sunstone_dashboard.png
+
+.. |fireedge_sunstone_linux_login_logo| image:: /images/fireedge_login_linux_logo.png
+   :width: 45%
+.. |fireedge_sunstone_linux_drawer_logo| image:: /images/fireedge_drawer_linux_logo.png
+   :width: 45%