docs: restructure docs (#14421)

Closes #13434 Supersedes #14182 --------- Co-authored-by: Ethan <39577870+ethanndickson@users.noreply.github.com> Co-authored-by: Ethan Dickson <ethan@coder.com> Co-authored-by: Ben Potter <ben@coder.com> Co-authored-by: Stephen Kirby <58410745+stirby@users.noreply.github.com> Co-authored-by: Stephen Kirby <me@skirby.dev> Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
2026-09-24 15:04:27 +08:00 · 2024-10-05 10:52:04 -05:00
parent 288df75686
commit 419eba5fb6
298 changed files with 5009 additions and 3889 deletions
@@ -0,0 +1,95 @@
+# Appearance (enterprise) (premium)
+
+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/setup/appearance/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 on the sign in
+page and in the top left corner of the dashboard. The default is the Coder logo.
+
+## Announcement Banners
+
+![announcement banner](../../images/admin/setup/appearance/announcement_banner_settings.png)
+
+Announcement Banners let admins post important messages to all site users. Only
+Site Owners may set the announcement banners.
+
+Example: Use multiple announcement banners for concurrent deployment-wide
+updates, such as maintenance or new feature rollout.
+
+![Multiple announcements](../../images/admin/setup/appearance/multiple-banners.PNG)
+
+Example: Adhere to government network classification requirements and notify
+users of which network their Coder deployment is on.
+
+![service banner secret](../../images/admin/setup/appearance/service-banner-secret.png)
+
+## OIDC Login Button Customization
+
+[Use environment variables to customize](../users/oidc-auth.md#oidc-login-customization)
+the text and icon on the OIDC button on the Sign In page.
+
+## Support Links
+
+Support links let admins adjust the user dropdown menu to include links
+referring to internal company resources. The menu section replaces the original
+menu positions: documentation, report a bug to GitHub, or join the Discord
+server.
+
+![support links](../../images/admin/setup/appearance/support-links.png)
+
+### Icons
+
+The link icons are optional, and can be set to any url or
+[builtin icon](../templates/extending-templates/icons.md#bundled-icons),
+additionally `bug`, `chat`, and `docs` are available as three special icons.
+
+### Configuration
+
+#### Kubernetes
+
+To configure support links in your Coder Kubernetes deployment, update your Helm
+chart values as follows:
+
+```yaml
+coder:
+  env:
+    - name: CODER_SUPPORT_LINKS
+      value: >
+        [{"name": "Hello GitHub", "target": "https://github.com/coder/coder",
+        "icon": "bug"},
+         {"name": "Hello Slack", "target":
+        "https://codercom.slack.com/archives/C014JH42DBJ", "icon":
+        "/icon/slack.svg"},
+         {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon":
+        "/icon/discord.svg"},
+         {"name": "Hello Foobar", "target": "https://foo.com/bar", "icon":
+        "/emojis/1f3e1.png"}]
+```
+
+#### System package
+
+if running as a system service, set an environment variable
+`CODER_SUPPORT_LINKS` in `/etc/coder.d/coder.env` as follows,
+
+```env
+CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
+```
+
+For CLI, use,
+
+```shell
+export CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
+coder-server
+```