synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +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

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"
```
## 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):

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
[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

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.
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.
![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
[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
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.

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
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

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
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)
### 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**

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):
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

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.

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
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

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
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.

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

@ -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