Custom Text/Banner on Web UI

Jayson_Harper · October 21, 2019, 2:18pm

Problem:
Need to include a text banner at the top of the Web UI. I’m able to edit /usr/share/app/views/home_topbar.html.erb to enable a banner on the earlier versions of Foreman still using the topbar menus. This path no longer exists in the newer versions of Foreman using the sidebar menus.

What is the new method of adding a banner to the UI?

Expected outcome:
Banner message at top of Web UI on all pages.

Foreman and Proxy versions:
1.22

Foreman and Proxy plugin versions:

Other relevant data:
[e.g. logs from Foreman and/or the Proxy, modified templates, commands issued, etc]
(for logs, surround with three back-ticks to get proper formatting, e.g.)

logs

tbrisker · October 22, 2019, 1:39pm

You could try editing the base layout and add your banner after this line if you want it only after login or before if you want to show it also on the login page:

github.com

theforeman/foreman/blob/develop/app/views/layouts/base.html.erb#L53


    <%= yield(:inline_javascripts) %>
  </script>


  <%= yield(:head) %>
</head>


<body>
  <!--[if lte IE 9]>
    <%= _('You are using an unsupported browser.') %>
  <![endif]-->
  <% if User.current %>
    <div id="react-app-root"></div>
    <div
      id="rails-app-content"
      class="container-fluid container-pf-nav-pf-vertical nav-pf-persistent-secondary"
    >
    <%# mounting layout after the container to change its width if the navbar is collapsed %>
    <% cache(TopbarSweeper.fragment_name, :skip_digest => true) do %>
      <%= mount_react_app %>
    <% end %>
    <%= yield(:content) %>

but I am afraid you are on your own with regards to making the html/css styling needed to make it look good.

Jayson_Harper · October 22, 2019, 2:23pm

Thank you. I inserted the code as suggested and I’m able to see the banner on the UI.

Is there any way to place the banner above the navbar and make it static to where it doesn’t move when scrolling on the page?

tbrisker · October 22, 2019, 2:25pm

That would likely require adding some css styling to it, you can do that inline (e.g. <div style="position: fixed"> etc.) but you would need to figure out the exact styling needed to make it work properly.

Bryan_Kearney · October 22, 2019, 2:43pm

FYI… adding it to the login page is a setting:

Login page footer text

Jayson_Harper · October 28, 2019, 6:33pm

@tbrisker Thank you! I now have a fixed banner on the top/bottom (header/footer) of the UI. The only problem is that the header is below the top menu/navbar. Is there a way to place the header above the top menu?

nixfu · March 3, 2023, 2:27pm

This would be a really nice feature to have in the admin settings to be able to post a notice to the users about a change, upcoming downtime, etc.