Skip to content
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

Allow users to set custom global banners in the UI #6584

Closed
wwsean08 opened this issue Apr 12, 2019 · 11 comments
Closed

Allow users to set custom global banners in the UI #6584

wwsean08 opened this issue Apr 12, 2019 · 11 comments

Comments

@wwsean08
Copy link

wwsean08 commented Apr 12, 2019

Is your feature request related to a problem? Please describe.
As an administrator in the middle of beta testing vault internally I would like to be able to setup a banner on the UI for all people that use it to tell them explicitly this is a beta setup and may go away or change. Below is a screenshot of an example of what I was thinking:

Screen Shot 2019-04-12 at 3 03 58 PM

Describe the solution you'd like
When users add an entry to sys/config/ui/banner with the value text="Text I want to display" then that text will be displayed. Also potentially adding the ability to see it before logging in with a tune parameter like the auth policies of listing_visibility=unauth.

Describe alternatives you've considered
Can't really think of an alternative

Explain any additional use-cases
This could also be useful to display warnings about any planned maintenance coming up or any known issues that are currently being tracked.

Additional context
Add any other context or screenshots about the feature request here.

@meirish meirish added the ui label Apr 13, 2019
@meirish
Copy link
Contributor

meirish commented Apr 16, 2019

We don't have anything like this currently, but if you wanted to build Vault to use in these deployments, you can set UI_AUTH_WELCOME at build time - https://github.com/hashicorp/vault/blob/master/ui/config/environment.js#L77. This gets picked up by the UI and showed when the user is authenticating - it was added for use on our demo site https://demo.vaultproject.io - the blue message in the lower left is driven by this.

@wwsean08
Copy link
Author

I saw that while trying to get this working @meirish, i have the backend working for this enhancement request (based on what I specified) though i'm having trouble figuring out how to get the value to display via the UI as I'm normally a back end developer and don't really know javascript or ember.js. I do have a spot for it in the template and the styling done (theoretically) just trying to figure out how to get the value to actually display.

@tlin20151
Copy link

I have a requirement to add/customize a banner (in addition to a footer)similar to @wwsean08 's UI. Do we have any progress on this ticket?

Additionally, is there a way to add and customize a disclaimer or message on the login screen?

@bastelfreak
Copy link

Hi people. I also would like to display data collection notice before/after the login in the web ui. Is that somehow possible without repackaging vault?

@xunto
Copy link

xunto commented Dec 2, 2021

I want to share our desired use case.

We want to have a separate vault for our staging. The problem is we are afraid somebody may mistake production vault for staging one, so we would want to make them somehow visually different.

So having a banner that says "This is staging vault." would work, good alternative would be changing styles but there is no such option either.

@tcjolie
Copy link

tcjolie commented Jun 21, 2022

Hello - in addition to the use case mentioned by xunto above (clearly calling out stg vs. prod) - we'd like to display a banner as mentioned by others. In our case, it would be really great to prompt our users regarding a shift in login process. We're sending emails and slack notifications, but we all know people often do not read these and having the information as a banner would allow us to avoid confusion for sure.

@aphorise
Copy link
Contributor

aphorise commented Sep 1, 2022

Sorry for the ignorance folks - but is it not possible to clone the repo - and specifically hacking your own UI logo / build as per build steps already available?

I suspect the UI Vault may never provide any customisation as far as banners or other such requirements as that's not its focus nor can other things (style, xss, etc) be guaranteed in those user configurable settings.

@wwsean08 since you originally requested this can you clarity how this is still applicable for your and why a DIY approach may not be possible?

@mikenomitch
Copy link

Adding a reference to Nomad's PR that implements this in case it helps anybody (internal or external) when implementing this in Vault - hashicorp/nomad#10813

@xunto
Copy link

xunto commented Mar 4, 2023

Sorry for the ignorance folks - but is it not possible to clone the repo - and specifically hacking your own UI logo / build as per build steps already available?

It is possible but we don't want to have to maintain a new fork, update it, etc Especially for such a minor thing.

@finnstech
Copy link
Contributor

We are working on this for an upcoming release of Vault. Stay tuned!

@hellobontempo
Copy link
Contributor

This feature has been released as of 1.16.0-rc1 #23945

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

10 participants