mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
docs: move premium and enterprise badges from heading to info in admonition (#15774)
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
GitHub
8
.vscode/markdown.code-snippets
vendored
8
.vscode/markdown.code-snippets
vendored
@ -20,6 +20,14 @@
|
||||
"body": "$0",
|
||||
"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": {
|
||||
"prefix": "#tabs",
|
||||
"body": [
|
||||
|
||||
@ -179,11 +179,16 @@ Optionally, you can request custom scopes:
|
||||
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.
|
||||
[Learn more](https://coder.com/pricing#compare-plans). Below is an example
|
||||
configuration with multiple providers.
|
||||
<blockquote class="info">
|
||||
|
||||
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
|
||||
# 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"
|
||||
```
|
||||
|
||||
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
|
||||
[Coder agent startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script):
|
||||
|
||||
|
||||
@ -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
|
||||
[Setup Coder](https://github.com/marketplace/actions/setup-coder) action.
|
||||
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.
|
||||
|
||||
### Observability
|
||||
|
||||
@ -78,9 +78,8 @@ can only be delivered to one method, and this method is configured globally with
|
||||
will be disabled.
|
||||
|
||||
Premium customers can configure which method to use for each of the supported
|
||||
[Events](#workspace-events); see the
|
||||
[Preferences](#delivery-preferences-enterprise-premium) section below for more
|
||||
details.
|
||||
[Events](#workspace-events); see the [Preferences](#delivery-preferences)
|
||||
section below for more details.
|
||||
|
||||
## SMTP (Email)
|
||||
|
||||
@ -232,7 +231,14 @@ notification is indicated on the right hand side of this table.
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
[event type](#event-types).
|
||||
|
||||
@ -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
|
||||
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
|
||||
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
|
||||
[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
|
||||
low-latency browser experiences for geo-distributed teams.
|
||||
|
||||
@ -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
|
||||
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
|
||||
workspaces under a given template in the template settings. By default, the
|
||||
|
||||
@ -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
|
||||
requirements.
|
||||
|
||||
@ -58,7 +58,14 @@ infrastructure, software, or security patches. Learn more about
|
||||
|
||||
|
||||
|
||||
### 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
|
||||
version of their parent template. To do so, enable **Template Update Policies**
|
||||
|
||||
@ -12,9 +12,8 @@ Template [admins](../../users/index.md) may define these default values:
|
||||
- [**Default autostop**](../../../user-guides/workspace-scheduling.md#autostop):
|
||||
How long a workspace runs without user activity before Coder automatically
|
||||
stops it.
|
||||
- [**Autostop requirement**](#autostop-requirement-enterprise-premium): Enforce
|
||||
mandatory workspace restarts to apply template updates regardless of user
|
||||
activity.
|
||||
- [**Autostop requirement**](#autostop-requirement): Enforce mandatory workspace
|
||||
restarts to apply template updates regardless of user activity.
|
||||
- **Activity bump**: The duration of inactivity that must pass before a
|
||||
workspace is automatically stopped.
|
||||
- **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
|
||||
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
|
||||
failed state prior to being automatically stopped. Failure cleanup is only
|
||||
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
|
||||
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
|
||||
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
|
||||
is permitted to remain dormant before it is automatically deleted. Dormancy
|
||||
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
|
||||
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
|
||||
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.
|
||||
Workspaces on templates with an autostop requirement will only be forcibly
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
@ -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
|
||||
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
|
||||
[Organization](./organizations.md) level. You can create and assign custom roles
|
||||
|
||||
@ -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
|
||||
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" />
|
||||
|
||||
## 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
|
||||
to synchronize roles in your auth provider to roles within Coder.
|
||||
@ -337,7 +351,14 @@ Visit the Coder UI to confirm these changes:
|
||||
|
||||
</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
|
||||
Coder to synchronize claims in your auth provider to organizations within Coder.
|
||||
|
||||
@ -130,7 +130,14 @@ your Coder deployment:
|
||||
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
|
||||
authentication. Upon deactivation, users are
|
||||
|
||||
@ -16,7 +16,7 @@ extension, authenticates with Coder, and connects to the workspace.
|
||||
|
||||
|
||||
> 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
|
||||
|
||||
|
||||
@ -88,7 +88,14 @@ manually updated the workspace.
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
**Workspaces** tab. Select the workspaces you'd like to modify with the
|
||||
|
||||
@ -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
|
||||
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
|
||||
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
|
||||
> 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.
|
||||
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
|
||||
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
|
||||
durations. Template admins configure an inactivity period after which your
|
||||
|
||||
@ -69,7 +69,7 @@ func (api *API) scimServiceProviderConfig(rw http.ResponseWriter, _ *http.Reques
|
||||
enc.SetEscapeHTML(true)
|
||||
_ = enc.Encode(scim.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{
|
||||
Supported: true,
|
||||
},
|
||||
@ -93,7 +93,7 @@ func (api *API) scimServiceProviderConfig(rw http.ResponseWriter, _ *http.Reques
|
||||
Type: "oauthbearertoken",
|
||||
Name: "HTTP Header Authentication",
|
||||
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{
|
||||
|
||||
@ -51,9 +51,7 @@ export const SecuritySettingsPageView: FC<SecuritySettingsPageViewProps> = ({
|
||||
title="Browser Only Connections"
|
||||
secondary
|
||||
description="Block all workspace access via SSH, port forward, and other non-browser connections."
|
||||
docsHref={docs(
|
||||
"/admin/networking#browser-only-connections-enterprise-premium",
|
||||
)}
|
||||
docsHref={docs("/admin/networking#browser-only-connections")}
|
||||
/>
|
||||
|
||||
<Badges>
|
||||
|
||||
@ -133,7 +133,7 @@ export const PublishTemplateVersionDialog: FC<
|
||||
<HelpTooltipLinksGroup>
|
||||
<HelpTooltipLink
|
||||
href={docs(
|
||||
"/admin/templates/managing-templates#template-update-policies-enterprise-premium",
|
||||
"/admin/templates/managing-templates#template-update-policies",
|
||||
)}
|
||||
>
|
||||
{Language.activeVersionHelpBody}
|
||||
|
||||
Reference in New Issue
Block a user