docs/content/admin/user-management/customizing-user-messages-for-your-enterprise.md

title	redirect_from	intro	versions
Customizing user messages for your enterprise	[/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]	You can create custom messages that users will see on {% data variables.product.product_location %}.	[{enterprise-server *} {github-ae *}]

About user messages

There are several types of user messages.

• Messages that appear on the {% if enterpriseServerVersions contains currentVersion %}sign in or {% endif %}sign out page{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}
• Mandatory messages, which appear once in a pop-up window that must be dismissed{% endif %}{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}
• Announcement banners, which appear at the top of every page{% endif %}

{% if enterpriseServerVersions contains currentVersion %} {% note %}

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 %}.

{% endnote %}

You can use Markdown to format your message. For more information, see "About writing and formatting on {% data variables.product.prodname_dotcom %}."

Creating a custom sign in message

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} 5. {% if currentVersion ver_gt "enterprise-server@2.22" %}To the right of{% else %}Under{% endif %} "Sign in page", click Add message or Edit message. 6. Under Sign in message, type the message you'd like users to see. {% if currentVersion ver_gt "enterprise-server@2.22" %} {% data reusables.enterprise_site_admin_settings.message-preview-save %}{% else %} {% data reusables.enterprise_site_admin_settings.click-preview %} 8. Review the rendered message. {% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %} {% endif %}

Creating a custom sign out message

{% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} 5. {% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}To the right of{% else %}Under{% endif %} "Sign out page", click Add message or Edit message. 6. Under Sign out message, type the message you'd like users to see. {% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} {% data reusables.enterprise_site_admin_settings.message-preview-save %}{% else %} {% data reusables.enterprise_site_admin_settings.click-preview %} 8. Review the rendered message. {% data reusables.enterprise_site_admin_settings.save-changes %}{% endif %}

{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}

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 the user can use {% data variables.product.product_location %}. Mandatory messages have a variety of uses.

• Providing onboarding information for new employees
• Telling users how to get help with {% data variables.product.product_location %}
• Ensuring that all users read your terms of service for using {% data variables.product.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 "Audited actions."

{% 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 message.
2. Under "Mandatory message", in the text box, type your message. {% data reusables.enterprise_site_admin_settings.message-preview-save %}

{% endif %}

{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}

Creating a global announcement banner

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

{% if currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.22" %} You can also set an announcement banner{% if enterpriseServerVersions contains currentVersion %} in the administrative shell using a command line utility or{% endif %} using the API. For more information, see {% if enterpriseServerVersions contains currentVersion %}"Command-line utilities" and {% endif %}"{% data variables.product.prodname_enterprise %} administration." {% else %}

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

{% endif %}

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

1. {% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}To the right of{% else %}Under{% endif %} "Announcement", click Add announcement.
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. {% data reusables.enterprise_site_admin_settings.message-preview-save %} {% endif %}