synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-09 11:45:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: move premium and enterprise badges from heading to info in admonition (#15774)

Browse Source 
closes https://github.com/coder/coder.com/issues/666


[preview](https://coder.com/docs/@666-unheading-premium/user-guides/workspace-scheduling#autostop-requirement)

---------

Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com>
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Edward Angert
2024-12-17 13:20:01 -05:00
committed by GitHub
parent badebc79cb
commit 21cc6f77fe
19 changed files with 196 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.vscode/markdown.code-snippets vendored
View File

@ -20,6 +20,14 @@
"body": "![${TM_SELECTED_TEXT:${1:alt}}](${2:url})$0", "body": "![${TM_SELECTED_TEXT:${1:alt}}](${2:url})$0",
"description": "image" "description": "image"
}, },
"premium-feature": {
"prefix": "#premium-feature",
"body": [
"<blockquote class=\"info\">\n",
"${1:feature} ${2|is,are|} an Enterprise and Premium feature. [Learn more](https://coder.com/pricing#compare-plans).\n",
"</blockquote>"
]
},
"tabs": { "tabs": {
"prefix": "#tabs", "prefix": "#tabs",
"body": [ "body": [

15
docs/admin/external-auth.md
View File

@ -179,11 +179,16 @@ Optionally, you can request custom scopes:
CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key" CODER_EXTERNAL_AUTH_0_SCOPES="repo:read repo:write write:gpg_key"
``` ```
## Multiple External Providers (enterprise) (premium) ## Multiple External Providers
Multiple providers are an Enterprise feature. <blockquote class="info">
[Learn more](https://coder.com/pricing#compare-plans). Below is an example
configuration with multiple providers. Multiple providers is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Below is an example configuration with multiple providers:
```env ```env
# Provider 1) github.com # Provider 1) github.com
@ -204,7 +209,7 @@ CODER_EXTERNAL_AUTH_1_TOKEN_URL="https://github.example.com/login/oauth/access_t
CODER_EXTERNAL_AUTH_1_VALIDATE_URL="https://github.example.com/api/v3/user" CODER_EXTERNAL_AUTH_1_VALIDATE_URL="https://github.example.com/api/v3/user"
``` ```
To support regex matching for paths (e.g. github\.com/org), you'll need to add To support regex matching for paths (e.g. `github\.com/org`), you'll need to add
this to the this to the
[Coder agent startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script): [Coder agent startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script):

2
docs/admin/infrastructure/validated-architectures/index.md
View File

@ -343,7 +343,7 @@ could affect workspace users experience once the platform is live.
versions into Coder from git. For example, on GitHub, you can use the versions into Coder from git. For example, on GitHub, you can use the
[Setup Coder](https://github.com/marketplace/actions/setup-coder) action. [Setup Coder](https://github.com/marketplace/actions/setup-coder) action.
1. Evaluate enabling 1. Evaluate enabling
[automatic template updates](../../templates/managing-templates/index.md#template-update-policies-enterprise-premium) [automatic template updates](../../templates/managing-templates/index.md#template-update-policies)
upon workspace startup. upon workspace startup.
### Observability ### Observability

14
docs/admin/monitoring/notifications/index.md
View File

@ -78,9 +78,8 @@ can only be delivered to one method, and this method is configured globally with
will be disabled. will be disabled.
Premium customers can configure which method to use for each of the supported Premium customers can configure which method to use for each of the supported
[Events](#workspace-events); see the [Events](#workspace-events); see the [Preferences](#delivery-preferences)
[Preferences](#delivery-preferences-enterprise-premium) section below for more section below for more details.
details.
## SMTP (Email) ## SMTP (Email)
@ -232,7 +231,14 @@ notification is indicated on the right hand side of this table.
![User Notification Preferences](../../../images/admin/monitoring/notifications/user-notification-preferences.png) ![User Notification Preferences](../../../images/admin/monitoring/notifications/user-notification-preferences.png)
## Delivery Preferences (enterprise) (premium) ## Delivery Preferences
<blockquote class="info">
Delivery preferences is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Administrators can configure which delivery methods are used for each different Administrators can configure which delivery methods are used for each different
[event type](#event-types). [event type](#event-types).

18
docs/admin/networking/index.md
View File

@ -176,7 +176,14 @@ coder server, so they can only be geo-distributed with High Availability mode in
our Premium Edition. [Reach out to Sales](https://coder.com/contact) to learn our Premium Edition. [Reach out to Sales](https://coder.com/contact) to learn
more. more.
## Browser-only connections (enterprise) (premium) ## Browser-only connections
<blockquote class="info">
Browser-only connections is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Some Coder deployments require that all access is through the browser to comply Some Coder deployments require that all access is through the browser to comply
with security policies. In these cases, pass the `--browser-only` flag to with security policies. In these cases, pass the `--browser-only` flag to
@ -186,7 +193,14 @@ With browser-only connections, developers can only connect to their workspaces
via the web terminal and via the web terminal and
[web IDEs](../../user-guides/workspace-access/web-ides.md). [web IDEs](../../user-guides/workspace-access/web-ides.md).
### Workspace Proxies (enterprise) (premium) ### Workspace Proxies
<blockquote class="info">
Workspace proxies are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Workspace proxies are a Coder Enterprise feature that allows you to provide Workspace proxies are a Coder Enterprise feature that allows you to provide
low-latency browser experiences for geo-distributed teams. low-latency browser experiences for geo-distributed teams.

9
docs/admin/networking/port-forwarding.md
View File

@ -129,7 +129,14 @@ resource uses a different method of authentication and **is not impacted by the
template's maximum sharing level**, nor the level of a shared port that points template's maximum sharing level**, nor the level of a shared port that points
to the app. to the app.
### Configure maximum port sharing level (enterprise) (premium) ### Configure maximum port sharing level
<blockquote class="info">
Configuring port sharing level is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Premium-licensed template admins can control the maximum port sharing level for Premium-licensed template admins can control the maximum port sharing level for
workspaces under a given template in the template settings. By default, the workspaces under a given template in the template settings. By default, the

9
docs/admin/setup/appearance.md
View File

@ -1,4 +1,11 @@
# Appearance (enterprise) (premium) # Appearance
<blockquote class="info">
Customizing Coder's appearance is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Customize the look of your Coder deployment to meet your enterprise Customize the look of your Coder deployment to meet your enterprise
requirements. requirements.

9
docs/admin/templates/managing-templates/index.md
View File

@ -58,7 +58,14 @@ infrastructure, software, or security patches. Learn more about
![Updating a template](../../../images/templates/update.png) ![Updating a template](../../../images/templates/update.png)
### Template update policies (enterprise) (premium) ### Template update policies
<blockquote class="info">
Template update policies are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Licensed template admins may want workspaces to always remain on the latest Licensed template admins may want workspaces to always remain on the latest
version of their parent template. To do so, enable **Template Update Policies** version of their parent template. To do so, enable **Template Update Policies**

50
docs/admin/templates/managing-templates/schedule.md
View File

@ -12,9 +12,8 @@ Template [admins](../../users/index.md) may define these default values:
- [**Default autostop**](../../../user-guides/workspace-scheduling.md#autostop): - [**Default autostop**](../../../user-guides/workspace-scheduling.md#autostop):
How long a workspace runs without user activity before Coder automatically How long a workspace runs without user activity before Coder automatically
stops it. stops it.
- [**Autostop requirement**](#autostop-requirement-enterprise-premium): Enforce - [**Autostop requirement**](#autostop-requirement): Enforce mandatory workspace
mandatory workspace restarts to apply template updates regardless of user restarts to apply template updates regardless of user activity.
activity.
- **Activity bump**: The duration of inactivity that must pass before a - **Activity bump**: The duration of inactivity that must pass before a
workspace is automatically stopped. workspace is automatically stopped.
- **Dormancy**: This allows automatic deletion of unused workspaces to reduce - **Dormancy**: This allows automatic deletion of unused workspaces to reduce
@ -27,13 +26,27 @@ allow users to define their own autostart and autostop schedules. Admins can
restrict the days of the week a workspace should automatically start to help restrict the days of the week a workspace should automatically start to help
manage infrastructure costs. manage infrastructure costs.
## Failure cleanup (enterprise) (premium) ## Failure cleanup
<blockquote class="info">
Failure cleanup is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Failure cleanup defines how long a workspace is permitted to remain in the Failure cleanup defines how long a workspace is permitted to remain in the
failed state prior to being automatically stopped. Failure cleanup is only failed state prior to being automatically stopped. Failure cleanup is only
available for licensed customers. available for licensed customers.
## Dormancy threshold (enterprise) (premium) ## Dormancy threshold
<blockquote class="info">
Dormancy threshold is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Dormancy Threshold defines how long Coder allows a workspace to remain inactive Dormancy Threshold defines how long Coder allows a workspace to remain inactive
before being moved into a dormant state. A workspace's inactivity is determined before being moved into a dormant state. A workspace's inactivity is determined
@ -43,13 +56,27 @@ the user before being accessible. Coder stops workspaces during their transition
to the dormant state if they are detected to be running. Dormancy Threshold is to the dormant state if they are detected to be running. Dormancy Threshold is
only available for licensed customers. only available for licensed customers.
## Dormancy auto-deletion (enterprise) (premium) ## Dormancy auto-deletion
<blockquote class="info">
Dormancy auto-deletion is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Dormancy Auto-Deletion allows a template admin to dictate how long a workspace Dormancy Auto-Deletion allows a template admin to dictate how long a workspace
is permitted to remain dormant before it is automatically deleted. Dormancy is permitted to remain dormant before it is automatically deleted. Dormancy
Auto-Deletion is only available for licensed customers. Auto-Deletion is only available for licensed customers.
## Autostop requirement (enterprise) (premium) ## Autostop requirement
<blockquote class="info">
Autostop requirement is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Autostop requirement is a template setting that determines how often workspaces Autostop requirement is a template setting that determines how often workspaces
using the template must automatically stop. Autostop requirement ignores any using the template must automatically stop. Autostop requirement ignores any
@ -79,7 +106,14 @@ Autostop requirement is disabled when the template is using the deprecated max
lifetime feature. Templates can choose to use a max lifetime or an autostop lifetime feature. Templates can choose to use a max lifetime or an autostop
requirement during the deprecation period, but only one can be used at a time. requirement during the deprecation period, but only one can be used at a time.
## User quiet hours (enterprise) (premium) ## User quiet hours
<blockquote class="info">
User quiet hours are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
User quiet hours can be configured in the user's schedule settings page. User quiet hours can be configured in the user's schedule settings page.
Workspaces on templates with an autostop requirement will only be forcibly Workspaces on templates with an autostop requirement will only be forcibly

9
docs/admin/templates/template-permissions.md
View File

@ -1,4 +1,11 @@
# Permissions (enterprise) (premium) # Permissions
<blockquote class="info">
Template permissions are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Licensed Coder administrators can control who can use and modify the template. Licensed Coder administrators can control who can use and modify the template.

9
docs/admin/users/groups-roles.md
View File

@ -31,7 +31,14 @@ Roles determine which actions users can take within the platform.
A user may have one or more roles. All users have an implicit Member role that A user may have one or more roles. All users have an implicit Member role that
may use personal workspaces. may use personal workspaces.
## Custom Roles (Premium) (Beta) ## Custom Roles
<blockquote class="info">
Custom roles are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Starting in v2.16.0, Premium Coder deployments can configure custom roles on the Starting in v2.16.0, Premium Coder deployments can configure custom roles on the
[Organization](./organizations.md) level. You can create and assign custom roles [Organization](./organizations.md) level. You can create and assign custom roles

27
docs/admin/users/idp-sync.md
View File

@ -1,4 +1,11 @@
# IDP Sync (enterprise) (premium) # IDP Sync
<blockquote class="info">
IDP sync is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
If your OpenID Connect provider supports group claims, you can configure Coder If your OpenID Connect provider supports group claims, you can configure Coder
to synchronize groups in your auth provider to groups within Coder. To enable to synchronize groups in your auth provider to groups within Coder. To enable
@ -205,7 +212,14 @@ Users who are not in a matching group will see the following error:
<Image height="412px" src="../../images/admin/group-allowlist.png" alt="Unauthorized group error" align="center" /> <Image height="412px" src="../../images/admin/group-allowlist.png" alt="Unauthorized group error" align="center" />
## Role sync (enterprise) (premium) ## Role sync
<blockquote class="info">
Role sync is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
If your OpenID Connect provider supports roles claims, you can configure Coder If your OpenID Connect provider supports roles claims, you can configure Coder
to synchronize roles in your auth provider to roles within Coder. to synchronize roles in your auth provider to roles within Coder.
@ -337,7 +351,14 @@ Visit the Coder UI to confirm these changes:
</div> </div>
## Organization Sync (Premium) ## Organization Sync
<blockquote class="info">
Organization sync is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
If your OpenID Connect provider supports groups/role claims, you can configure If your OpenID Connect provider supports groups/role claims, you can configure
Coder to synchronize claims in your auth provider to organizations within Coder. Coder to synchronize claims in your auth provider to organizations within Coder.

9
docs/admin/users/oidc-auth.md
View File

@ -130,7 +130,14 @@ your Coder deployment:
CODER_DISABLE_PASSWORD_AUTH=true CODER_DISABLE_PASSWORD_AUTH=true
``` ```
## SCIM (enterprise) (premium) ## SCIM
<blockquote class="info">
SCIM is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Coder supports user provisioning and deprovisioning via SCIM 2.0 with header Coder supports user provisioning and deprovisioning via SCIM 2.0 with header
authentication. Upon deactivation, users are authentication. Upon deactivation, users are

2
docs/user-guides/workspace-access/vscode.md
View File

@ -16,7 +16,7 @@ extension, authenticates with Coder, and connects to the workspace.
![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true) ![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)
> The `VS Code Desktop` button can be hidden by enabling > The `VS Code Desktop` button can be hidden by enabling
> [Browser-only connections](../../admin/networking/index.md#browser-only-connections-enterprise-premium). > [Browser-only connections](../../admin/networking/index.md#browser-only-connections).
### Manual Installation ### Manual Installation

9
docs/user-guides/workspace-management.md
View File

@ -88,7 +88,14 @@ manually updated the workspace.
![Automatic Updates](../images/workspace-automatic-updates.png) ![Automatic Updates](../images/workspace-automatic-updates.png)
## Bulk operations (enterprise) (premium) ## Bulk operations
<blockquote class="info">
Bulk operations are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Licensed admins may apply bulk operations (update, delete, start, stop) in the Licensed admins may apply bulk operations (update, delete, start, stop) in the
**Workspaces** tab. Select the workspaces you'd like to modify with the **Workspaces** tab. Select the workspaces you'd like to modify with the

27
docs/user-guides/workspace-scheduling.md
View File

@ -49,7 +49,14 @@ Workspaces will automatically shut down after a period of inactivity. This can
be configured at the template level, but is visible in the autostop description be configured at the template level, but is visible in the autostop description
for your workspace. for your workspace.
## Autostop requirement (enterprise) (premium) ## Autostop requirement
<blockquote class="info">
Autostop requirement is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Licensed template admins may enforce a required stop for workspaces to apply Licensed template admins may enforce a required stop for workspaces to apply
updates or undergo maintenance. These stops ignore any active connections or updates or undergo maintenance. These stops ignore any active connections or
@ -61,7 +68,14 @@ and specified quiet hours (see below).
> Admins: See the template schedule settings for more information on configuring > Admins: See the template schedule settings for more information on configuring
> Autostop Requirement. > Autostop Requirement.
### User quiet hours (enterprise) (premium) ### User quiet hours
<blockquote class="info">
User quiet hours are an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
User quiet hours can be configured in the user's schedule settings page. User quiet hours can be configured in the user's schedule settings page.
Workspaces on templates with an autostop requirement will only be forcibly Workspaces on templates with an autostop requirement will only be forcibly
@ -99,7 +113,14 @@ Let's say that both are set to 5 hours. When either your workspace autostarts or
you sign in, you will have confidence that the only condition for shutdown is 5 you sign in, you will have confidence that the only condition for shutdown is 5
hours of inactivity. hours of inactivity.
## Dormancy (enterprise) (premium) ## Dormancy
<blockquote class="info">
Dormancy is an Enterprise and Premium feature.
[Learn more](https://coder.com/pricing#compare-plans).
</blockquote>
Dormancy automatically deletes workspaces which remain unused for long Dormancy automatically deletes workspaces which remain unused for long
durations. Template admins configure an inactivity period after which your durations. Template admins configure an inactivity period after which your

4
enterprise/coderd/scim.go
View File

@ -69,7 +69,7 @@ func (api *API) scimServiceProviderConfig(rw http.ResponseWriter, _ *http.Reques
enc.SetEscapeHTML(true) enc.SetEscapeHTML(true)
_ = enc.Encode(scim.ServiceProviderConfig{ _ = enc.Encode(scim.ServiceProviderConfig{
Schemas: []string{"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"}, Schemas: []string{"urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"},
DocURI: "https://coder.com/docs/admin/users/oidc-auth#scim-enterprise-premium", DocURI: "https://coder.com/docs/admin/users/oidc-auth#scim",
Patch: scim.Supported{ Patch: scim.Supported{
Supported: true, Supported: true,
}, },
@ -93,7 +93,7 @@ func (api *API) scimServiceProviderConfig(rw http.ResponseWriter, _ *http.Reques
Type: "oauthbearertoken", Type: "oauthbearertoken",
Name: "HTTP Header Authentication", Name: "HTTP Header Authentication",
Description: "Authentication scheme using the Authorization header with the shared token", Description: "Authentication scheme using the Authorization header with the shared token",
DocURI: "https://coder.com/docs/admin/users/oidc-auth#scim-enterprise-premium", DocURI: "https://coder.com/docs/admin/users/oidc-auth#scim",
}, },
}, },
Meta: scim.ServiceProviderMeta{ Meta: scim.ServiceProviderMeta{

4
site/src/pages/DeploymentSettingsPage/SecuritySettingsPage/SecuritySettingsPageView.tsx
View File

@ -51,9 +51,7 @@ export const SecuritySettingsPageView: FC<SecuritySettingsPageViewProps> = ({
title="Browser Only Connections" title="Browser Only Connections"
secondary secondary
description="Block all workspace access via SSH, port forward, and other non-browser connections." description="Block all workspace access via SSH, port forward, and other non-browser connections."
docsHref={docs( docsHref={docs("/admin/networking#browser-only-connections")}
"/admin/networking#browser-only-connections-enterprise-premium",
)}
/> />
<Badges> <Badges>

2
site/src/pages/TemplateVersionEditorPage/PublishTemplateVersionDialog.tsx
View File

@ -133,7 +133,7 @@ export const PublishTemplateVersionDialog: FC<
<HelpTooltipLinksGroup> <HelpTooltipLinksGroup>
<HelpTooltipLink <HelpTooltipLink
href={docs( href={docs(
"/admin/templates/managing-templates#template-update-policies-enterprise-premium", "/admin/templates/managing-templates#template-update-policies",
)} )}
> >
{Language.activeVersionHelpBody} {Language.activeVersionHelpBody}