1
0
mirror of synced 2025-12-23 11:54:18 -05:00
Files
docs/content/admin/user-management/customizing-user-messages-on-your-instance.md
Jason Etcovitch caaee7a124 Update all files to use {% data %} (#15253)
* Add back changes from prior to purge

* Manually fix some invalid Liquid

* Updoot render-content

* Improve test messages to show correct output

* Run el scripto

* Pass the remaining test
2020-09-29 16:01:04 -04:00

73 lines
4.3 KiB
Markdown

---
title: Customizing user messages on your instance
redirect_from:
- /enterprise/admin/user-management/creating-a-custom-sign-in-message/
- /enterprise/admin/user-management/customizing-user-messages-on-your-instance
intro: 'You can create custom messages that users will see on the sign in and sign out pages{% if currentVersion ver_gt "enterprise-server@2.21" %} or in an announcement banner at the top of every page{% endif %}.'
versions:
enterprise-server: '*'
---
You can use Markdown to format your message. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/articles/about-writing-and-formatting-on-github/)."
{% 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 %}
### Creating a custom sign in message
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.business %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
5. Under "Sign in page", click **Add message** or **Edit message**.
![Edit message button](/assets/images/enterprise/site-admin-settings/edit-message.png)
6. Under **Sign in message**, type the message you'd like users to see.
![Sign in message](/assets/images/enterprise/site-admin-settings/sign-in-message.png)
{% data reusables.enterprise_site_admin_settings.click-preview %}
![Preview button](/assets/images/enterprise/site-admin-settings/sign-in-message-preview-button.png)
8. Review the rendered message.
![Sign in message rendered](/assets/images/enterprise/site-admin-settings/sign-in-message-rendered.png)
{% data reusables.enterprise_site_admin_settings.save-changes %}
### Creating a custom sign out message
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.business %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
5. Under "Sign out page", click **Add message** or **Edit message**.
![Add message button](/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png)
6. Under **Sign out message**, type the message you'd like users to see.
![Sign two_factor_auth_header message](/assets/images/enterprise/site-admin-settings/sign-out-message.png)
{% data reusables.enterprise_site_admin_settings.click-preview %}
![Preview button](/assets/images/enterprise/site-admin-settings/sign-out-message-preview-button.png)
8. Review the rendered message.
![Sign out message rendered](/assets/images/enterprise/site-admin-settings/sign-out-message-rendered.png)
{% data reusables.enterprise_site_admin_settings.save-changes %}
{% if currentVersion ver_gt "enterprise-server@2.21" %}
### 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. For more information, see "[Command-line utilities](/enterprise/admin/configuration/command-line-utilities#ghe-announce)."
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.business %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.messages-tab %}
1. Under "Announcement", click **Add announcement**.
![Add announcement button](/assets/images/enterprise/site-admin-settings/add-announcement-button.png)
1. Under "Announcement", in the text field, type the announcement you want displayed in a banner.
![Text field to enter announcement](/assets/images/enterprise/site-admin-settings/announcement-text-field.png)
1. Optionally, under "Expires on", use the calendar drop-down menu, and select an expiration date.
![Calendar drop-down menu to choose expiration date](/assets/images/enterprise/site-admin-settings/expiration-drop-down.png)
1. Optionally, to see what the banner will look like, click **Preview**.
![Preview button](/assets/images/enterprise/site-admin-settings/preview-announcement-button.png)
1. Click **Save changes**.
![Save changes button](/assets/images/enterprise/site-admin-settings/save-announcement-button.png)
{% endif %}