diff --git a/docs/admin/appearance.md b/docs/admin/appearance.md index f80ffc8c1b..f34a108572 100644 --- a/docs/admin/appearance.md +++ b/docs/admin/appearance.md @@ -1,4 +1,43 @@ -# Appearance +# Appearance (enterprise) + +Customize the look of your Coder deployment to meet your enterprise +requirements. + +You can access the Appearance settings by navigating to +`Deployment > Appearance`. + +![application name and logo url](../images/admin/application-name-logo-url.png) + +## Application Name + +Specify a custom application name to be displayed on the login page. The default +is Coder. + +## Logo URL + +Specify a custom URL for your enterprise's logo to be displayed in the top left +corner of the dashboard. The default is the Coder logo. + +## Service Banner + +![service banner](../images/admin/service-banner-config.png) + +A Service Banner lets admins post important messages to all site users. Only +Site Owners may set the service banner. + +Example: Notify users of scheduled maintenance of the Coder deployment. + +![service banner maintenance](../images/admin/service-banner-maintenance.png) + +Example: Adhere to government network classification requirements and notify +users of which network their Coder deployment is on. + +![service banner secret](../images/admin/service-banner-secret.png) + +## OIDC Login Button Customization + +[Use environment variables to customize](../auth#oidc-login-customization) the +text and icon on the OIDC button on the Sign In page. ## Support Links @@ -24,20 +63,10 @@ supportLinks: icon: "chat" ``` -## Icons +### Icons The link icons are optional, and limited to: `bug`, `chat`, and `docs`. -## Service Banners (enterprise) - -Service Banners let admins post important messages to all site users. Only Site -Owners may set the service banner. - -![service banners](../images/admin/service-banners.png) - -You can access the Service Banner settings by navigating to -`Deployment > Service Banners`. - ## Up next - [Enterprise](../enterprise.md) diff --git a/docs/images/admin/application-name-logo-url.png b/docs/images/admin/application-name-logo-url.png new file mode 100644 index 0000000000..012a696a05 Binary files /dev/null and b/docs/images/admin/application-name-logo-url.png differ diff --git a/docs/images/admin/service-banner-config.png b/docs/images/admin/service-banner-config.png new file mode 100644 index 0000000000..410fea472c Binary files /dev/null and b/docs/images/admin/service-banner-config.png differ diff --git a/docs/images/admin/service-banner-maintenance.png b/docs/images/admin/service-banner-maintenance.png new file mode 100644 index 0000000000..94d879f084 Binary files /dev/null and b/docs/images/admin/service-banner-maintenance.png differ diff --git a/docs/images/admin/service-banner-secret.png b/docs/images/admin/service-banner-secret.png new file mode 100644 index 0000000000..0713819a8d Binary files /dev/null and b/docs/images/admin/service-banner-secret.png differ diff --git a/docs/images/admin/service-banners.png b/docs/images/admin/service-banners.png deleted file mode 100644 index 51f73233c5..0000000000 Binary files a/docs/images/admin/service-banners.png and /dev/null differ diff --git a/docs/images/admin/support-links.png b/docs/images/admin/support-links.png index b3acf35307..5eafa0f50f 100644 Binary files a/docs/images/admin/support-links.png and b/docs/images/admin/support-links.png differ