customizing-user-messages-for-your-enterprise.md

title	shortTitle	redirect_from	intro	versions	type	topics
Customizing user messages for your enterprise	Customizing user messages	/enterprise/admin/user-management/creating-a-custom-sign-in-message /enterprise/admin/user-management/customizing-user-messages-on-your-instance /admin/user-management/customizing-user-messages-on-your-instance /admin/user-management/customizing-user-messages-for-your-enterprise /admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise	You can create custom messages that users will see on {% data variables.product.github %}.	ghec ghes * *	how_to	Enterprise Maintenance

About user messages

{% ifversion ghec %} You can create global announcement banners, which appear at the top of every page.

{% data reusables.enterprise.user-messages-markdown %} {% else %}

There are several types of user messages.

• Messages that appear on the {% ifversion ghes %}sign in or {% endif %}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

{% endif %}

{% ifversion ghes %}

Note

If you are using SAML for authentication, the sign in page is presented by your identity provider and is not customizable via {% data variables.product.prodname_ghe_server %}.

{% data reusables.enterprise.user-messages-markdown %}

Creating a custom sign in message

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %}

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

   

2. Under Sign in message, type the message you'd like users to see. {% data reusables.enterprise_site_admin_settings.message-preview-save %}

{% endif %}

{% ifversion ghes %}

Creating a custom sign out message

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %}

1. {% ifversion ghes %}To the right of{% else %}Under{% endif %} "Sign out page", click Add message or Edit message.

   

2. Under Sign out message, type the message you'd like users to see. {% ifversion ghes %} {% data reusables.enterprise_site_admin_settings.message-preview-save %}{% else %} {% data reusables.enterprise_site_admin_settings.click-preview %}

3. Review the rendered message. {% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %}{% endif %}

{% ifversion ghes %}

Creating a mandatory message

You can create a mandatory message that {% data variables.product.product_name %} 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 using {% data variables.location.product_location %}.

Mandatory messages have a variety of uses.

• Providing onboarding information for new employees
• Telling users how to get help with {% data variables.location.product_location %}
• Ensuring that all users read your terms of service for using {% data variables.location.product_location %}

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 "AUTOTITLE."

{% ifversion display-mandatory-message-again %} {% else %}

Note

If you change the mandatory message for {% data variables.location.product_location %}, users who have already acknowledged the message will not see the new message.

{% endif %}

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %}

1. To the right of "Mandatory message", click Add mandatory message.
2. Under "Mandatory message", in the text box, type your message. {%- ifversion display-mandatory-message-again %}
3. Optionally, select Show updated message to all users even if they dismissed the previous one. {% endif %} {% data reusables.enterprise_site_admin_settings.message-preview-save %}

{% endif %}

Creating a global announcement banner

You can set a global announcement banner to be displayed to all users at the top of every page{% ifversion ghec %} within your enterprise, including every page in every organization owned by the enterprise{% endif %}.

{% ifversion custom-banner-messages %} You can also create announcement banners at the organization level. For more information, see "AUTOTITLE."{% endif %}

{% ifversion ghes %} You can also set an announcement banner{% ifversion ghes %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% ifversion ghes %}"AUTOTITLE" and {% endif %}"AUTOTITLE." {% endif %}

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %}{% ifversion custom-banner-messages %}{% else %}

1. To the right of "Announcement", click Add announcement.{% endif %}

2. Under "Announcement", in the text field, type the announcement you want displayed in a banner.

3. Optionally, under "Expires on", select the calendar drop-down menu and click an expiration date. {% ifversion ghe-announce-dismiss %}

   [!NOTE] Announcements must either have an expiration date, be user dismissible, or both.

   {% endif %} {%- ifversion ghe-announce-dismiss %}

4. Optionally, to allow each user to dismiss the announcement, select User dismissible. {%- endif %}{% ifversion custom-banner-messages %}

5. Optionally, to allow each user to dismiss the announcement, select Allow users to dismiss the announcement. {%- endif %} {% data reusables.enterprise_site_admin_settings.message-preview-save %}