Customizing user messages for your enterprise

You can create custom messages that users will see on your GitHub Enterprise Server instance.

In this article

About user messages

There are several types of user messages.

  • Messages that appear on the sign in or sign out page
  • Mandatory messages, which appear once in a pop-up window that must be dismissed
  • Announcement banners, which appear at the top of every page

Note: If you are using SAML for authentication, the sign in page is presented by your identity provider and is not customizable via GitHub Enterprise Server.

You can use Markdown to format your message. For more information, see "About writing and formatting on GitHub."

Creating a custom sign in message

  1. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings. "Enterprise settings" in drop-down menu for profile photo on GitHub Enterprise Server

  2. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  3. Under Settings, click Messages. Messages tab in the enterprise settings sidebar

  4. To the right of "Sign in page", click Add message or Edit message. Add message button

  5. Under Sign in message, type the message you'd like users to see. Sign in message

  6. Optionally, to preview your message, click Preview. Preview message button

  7. Click Save changes. Save changes button

Creating a custom sign out message

  1. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings. "Enterprise settings" in drop-down menu for profile photo on GitHub Enterprise Server

  2. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  3. Under Settings, click Messages. Messages tab in the enterprise settings sidebar

  4. To the right of "Sign out page", click Add message or Edit message. Add message button

  5. Under Sign out message, type the message you'd like users to see. Sign two_factor_auth_header message

  6. Optionally, to preview your message, click Preview. Preview message button

  7. Click Save changes. Save changes button

Creating a mandatory message

You can create a mandatory message that GitHub Enterprise Server will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use your GitHub Enterprise Server instance.

Mandatory messages have a variety of uses.

  • Providing onboarding information for new employees
  • Telling users how to get help with your GitHub Enterprise Server instance
  • Ensuring that all users read your terms of service for using your GitHub Enterprise Server instance

If you include Markdown checkboxes in the message, all checkboxes must be selected before the user can dismiss the message. For example, if you include your terms of service in the mandatory message, you can require that each user selects a checkbox to confirm the user has read the terms.

Each time a user sees a mandatory message, an audit log event is created. The event includes the version of the message that the user saw. For more information see "Audited actions."

Note: If you change the mandatory message for your GitHub Enterprise Server instance, users who have already acknowledged the message will not see the new message.

  1. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings. "Enterprise settings" in drop-down menu for profile photo on GitHub Enterprise Server

  2. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  3. Under Settings, click Messages. Messages tab in the enterprise settings sidebar

  4. To the right of "Mandatory message", click Add message. Add message button

  5. Under "Mandatory message", in the text box, type your message. Add message button

  6. Optionally, to preview your message, click Preview. Preview message button

  7. Click Save changes. Save changes button

Creating a global announcement banner

You can set a global announcement banner to be displayed to all users at the top of every page.

You can also set an announcement banner in the administrative shell using a command line utility or using the API. For more information, see "Command-line utilities" and "GitHub Enterprise administration."

  1. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings. "Enterprise settings" in drop-down menu for profile photo on GitHub Enterprise Server

  2. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  3. Under Settings, click Messages. Messages tab in the enterprise settings sidebar

  4. To the right of "Announcement", click Add announcement. Add announcement button

  5. Under "Announcement", in the text field, type the announcement you want displayed in a banner. Text field to enter announcement

  6. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date. Calendar drop-down menu to choose expiration date

  7. Optionally, to preview your message, click Preview. Preview message button

  8. Click Save changes. Save changes button

Did this doc help you?Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.