mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore: update documentation links to the new format (#13797)
This commit is contained in:
Muhammad Atif Ali
+1
-1
@@ -321,7 +321,7 @@ OIDC provider will be added to the `myCoderGroupName` group in Coder.
|
||||
### Group allowlist
|
||||
|
||||
You can limit which groups from your identity provider can log in to Coder with
|
||||
[CODER_OIDC_ALLOWED_GROUPS](https://coder.com/docs/v2/latest/cli/server#--oidc-allowed-groups).
|
||||
[CODER_OIDC_ALLOWED_GROUPS](https://coder.com/docs/cli/server#--oidc-allowed-groups).
|
||||
Users who are not in a matching group will see the following error:
|
||||
|
||||
|
||||
|
||||
@@ -184,8 +184,7 @@ CODER_EXTERNAL_AUTH_0_REGEX=github\.company\.org
|
||||
|
||||
### JFrog Artifactory
|
||||
|
||||
See
|
||||
[this](https://coder.com/docs/v2/latest/guides/artifactory-integration#jfrog-oauth)
|
||||
See [this](https://coder.com/docs/guides/artifactory-integration#jfrog-oauth)
|
||||
guide on instructions on how to set up for JFrog Artifactory.
|
||||
|
||||
### Custom scopes
|
||||
|
||||
@@ -357,8 +357,8 @@ project-oriented [features](https://containers.dev/features) without requiring
|
||||
platform administrators to push altered Docker images.
|
||||
|
||||
Learn more about
|
||||
[Dev containers support](https://coder.com/docs/v2/latest/templates/dev-containers)
|
||||
in Coder.
|
||||
[Dev containers support](https://coder.com/docs/templates/dev-containers) in
|
||||
Coder.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
- The `coder stat` fetches workspace utilization metrics, even from within a
|
||||
container. Our example templates have been updated to use this to show CPU,
|
||||
memory, disk via
|
||||
[agent metadata](https://coder.com/docs/v2/latest/templates/agent-metadata)
|
||||
[agent metadata](https://coder.com/docs/templates/agent-metadata)
|
||||
(#8005)
|
||||
- Helm: `coder.command` can specify a different command for the Coder pod
|
||||
(#8116)
|
||||
@@ -20,7 +20,7 @@
|
||||
- Healthcheck endpoint has a database section: `/api/v2/debug/health`
|
||||
- Force DERP connections in CLI with `--disable-direct` flag (#8131)
|
||||
- Disable all direct connections for a Coder deployment with
|
||||
[--block-direct-connections](https://coder.com/docs/v2/latest/cli/server#--block-direct-connections)
|
||||
[--block-direct-connections](https://coder.com/docs/cli/server#--block-direct-connections)
|
||||
(#7936)
|
||||
- Search for workspaces based on last activity (#2658)
|
||||
```text
|
||||
@@ -83,6 +83,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
### Important changes
|
||||
|
||||
- [Managed variables](https://coder.com/docs/v2/latest/templates/parameters#terraform-template-wide-variables)
|
||||
- [Managed variables](https://coder.com/docs/templates/parameters#terraform-template-wide-variables)
|
||||
are enabled by default. The following block within templates is obsolete and
|
||||
can be removed from your templates:
|
||||
|
||||
@@ -16,13 +16,13 @@
|
||||
> previously necessary to activate this additional feature.
|
||||
|
||||
- Our scale test CLI is
|
||||
[experimental](https://coder.com/docs/v2/latest/contributing/feature-stages#experimental-features)
|
||||
[experimental](https://coder.com/docs/contributing/feature-stages#experimental-features)
|
||||
to allow for rapid iteration. You can still interact with it via
|
||||
`coder exp scaletest` (#8339)
|
||||
|
||||
### Features
|
||||
|
||||
- [coder dotfiles](https://coder.com/docs/v2/latest/cli/dotfiles) can checkout a
|
||||
- [coder dotfiles](https://coder.com/docs/cli/dotfiles) can checkout a
|
||||
specific branch
|
||||
|
||||
### Bug fixes
|
||||
@@ -49,6 +49,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
### Features
|
||||
|
||||
- [Devcontainer templates](https://coder.com/docs/v2/latest/templates/dev-containers)
|
||||
- [Devcontainer templates](https://coder.com/docs/templates/dev-containers)
|
||||
for Coder (#8256)
|
||||
- The dashboard will warn users when a workspace is unhealthy (#8422)
|
||||
- Audit logs `resource_target` search query allows you to search by resource
|
||||
@@ -31,6 +31,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
Agent logs can be pushed after a workspace has started (#8528)
|
||||
|
||||
> ⚠️ **Warning:** You will need to
|
||||
> [update](https://coder.com/docs/v2/latest/install) your local Coder CLI v0.27
|
||||
> [update](https://coder.com/docs/install) your local Coder CLI v0.27
|
||||
> to connect via `coder ssh`.
|
||||
|
||||
### Features
|
||||
@@ -24,7 +24,7 @@ Agent logs can be pushed after a workspace has started (#8528)
|
||||
- Template version messages (#8435)
|
||||
<img width="428" alt="252772262-087f1338-f1e2-49fb-81f2-358070a46484" src="https://github.com/coder/coder/assets/22407953/5f6e5e47-e61b-41f1-92fe-f624e92f8bd3">
|
||||
- TTL and max TTL validation increased to 30 days (#8258)
|
||||
- [Self-hosted docs](https://coder.com/docs/v2/latest/install/offline#offline-docs):
|
||||
- [Self-hosted docs](https://coder.com/docs/install/offline#offline-docs):
|
||||
Host your own copy of Coder's documentation in your own environment (#8527)
|
||||
(#8601)
|
||||
- Add custom coder bin path for `config-ssh` (#8425)
|
||||
@@ -57,7 +57,7 @@ Agent logs can be pushed after a workspace has started (#8528)
|
||||
Agent logs can be pushed after a workspace has started (#8528)
|
||||
|
||||
> ⚠️ **Warning:** You will need to
|
||||
> [update](https://coder.com/docs/v2/latest/install) your local Coder CLI v0.27
|
||||
> [update](https://coder.com/docs/install) your local Coder CLI v0.27
|
||||
> to connect via `coder ssh`.
|
||||
|
||||
### Features
|
||||
@@ -76,7 +76,7 @@ Agent logs can be pushed after a workspace has started (#8528)
|
||||
- Template version messages (#8435)
|
||||
<img width="428" alt="252772262-087f1338-f1e2-49fb-81f2-358070a46484" src="https://github.com/coder/coder/assets/22407953/5f6e5e47-e61b-41f1-92fe-f624e92f8bd3">
|
||||
- TTL and max TTL validation increased to 30 days (#8258)
|
||||
- [Self-hosted docs](https://coder.com/docs/v2/latest/install/offline#offline-docs):
|
||||
- [Self-hosted docs](https://coder.com/docs/install/offline#offline-docs):
|
||||
Host your own copy of Coder's documentation in your own environment (#8527)
|
||||
(#8601)
|
||||
- Add custom coder bin path for `config-ssh` (#8425)
|
||||
@@ -115,8 +115,8 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
- Custom API use cases (custom agent logs, CI/CD pipelines) (#8445)
|
||||
@@ -132,6 +132,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -21,6 +21,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -15,6 +15,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
+10
-10
@@ -7,10 +7,10 @@ we have outgrown development (v0.x) releases:
|
||||
[happily support](https://coder.com/docs/admin/scaling/scale-utility#recent-scale-tests) 1000+ users
|
||||
and workspace connections
|
||||
- We have a full suite of
|
||||
[paid features](https://coder.com/docs/v2/latest/enterprise) and enterprise
|
||||
[paid features](https://coder.com/docs/enterprise) and enterprise
|
||||
customers deployed in production
|
||||
- Users depend on our CLI to
|
||||
[automate Coder](https://coder.com/docs/v2/latest/admin/automation) in Ci/Cd
|
||||
[automate Coder](https://coder.com/docs/admin/automation) in Ci/Cd
|
||||
pipelines and templates
|
||||
|
||||
Why not v1.0? At the time of writing, our legacy product is currently on v1.34.
|
||||
@@ -39,7 +39,7 @@ ben@coder.com!
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
- RBAC: The default [Member role](https://coder.com/docs/v2/latest/admin/users)
|
||||
- RBAC: The default [Member role](https://coder.com/docs/admin/users)
|
||||
can no longer see a list of all users in a Coder deployment. The Template
|
||||
Admin role and above can still use the `Users` page in dashboard and query
|
||||
users via the API (#8650) (@Emyrk)
|
||||
@@ -52,7 +52,7 @@ ben@coder.com!
|
||||
[Kubernetes example template](https://github.com/coder/coder/tree/main/examples/templates/kubernetes)
|
||||
uses a `kubernetes_deployment` instead of `kubernetes_pod` since it works
|
||||
best with
|
||||
[log streaming](https://coder.com/docs/v2/latest/platforms/kubernetes/deployment-logs)
|
||||
[log streaming](https://coder.com/docs/platforms/kubernetes/deployment-logs)
|
||||
in Coder.
|
||||
|
||||
### Features
|
||||
@@ -60,11 +60,11 @@ ben@coder.com!
|
||||
- Template insights: Admins can see daily active users, user latency, and
|
||||
popular IDEs (#8722) (@BrunoQuaresma)
|
||||
|
||||
- [Kubernetes log streaming](https://coder.com/docs/v2/latest/platforms/kubernetes/deployment-logs):
|
||||
- [Kubernetes log streaming](https://coder.com/docs/platforms/kubernetes/deployment-logs):
|
||||
Stream Kubernetes event logs to the Coder agent logs to reveal Kuernetes-level
|
||||
issues such as ResourceQuota limitations, invalid images, etc.
|
||||
|
||||
- [OIDC Role Sync](https://coder.com/docs/v2/latest/admin/auth#group-sync-enterprise)
|
||||
- [OIDC Role Sync](https://coder.com/docs/admin/auth#group-sync-enterprise)
|
||||
(Enterprise): Sync roles from your OIDC provider to Coder roles (e.g.
|
||||
`Template Admin`) (#8595) (@Emyrk)
|
||||
- Users can convert their accounts from username/password authentication to SSO
|
||||
@@ -82,14 +82,14 @@ ben@coder.com!
|
||||
- CLI: Added `--var` shorthand for `--variable` in
|
||||
`coder templates <create/push>` CLI (#8710) (@ammario)
|
||||
- Sever logs: Added fine-grained
|
||||
[filtering](https://coder.com/docs/v2/latest/cli/server#-l---log-filter) with
|
||||
[filtering](https://coder.com/docs/cli/server#-l---log-filter) with
|
||||
Regex (#8748) (@ammario)
|
||||
- d3991fac2 feat(coderd): add parameter insights to template insights (#8656)
|
||||
(@mafredri)
|
||||
- Agent metadata: In cases where Coder does not receive metadata in time, we
|
||||
render the previous "stale" value. Stale values are grey versus the typical
|
||||
green color. (#8745) (@BrunoQuaresma)
|
||||
- [Open in Coder](https://coder.com/docs/v2/latest/templates/open-in-coder):
|
||||
- [Open in Coder](https://coder.com/docs/templates/open-in-coder):
|
||||
Generate a link that automatically creates a workspace on behalf of the user,
|
||||
skipping the "Create Workspace" form (#8651) (@BrunoQuaresma)
|
||||
-
|
||||
@@ -147,6 +147,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
|
||||
### Features
|
||||
|
||||
- [External provisioners](https://coder.com/docs/v2/latest/admin/provisioners)
|
||||
- [External provisioners](https://coder.com/docs/admin/provisioners)
|
||||
updates
|
||||
- Added
|
||||
[PSK authentication](https://coder.com/docs/v2/latest/admin/provisioners#authentication)
|
||||
[PSK authentication](https://coder.com/docs/admin/provisioners#authentication)
|
||||
method (#8877) (@spikecurtis)
|
||||
- Provisioner daemons can be deployed
|
||||
[via Helm](https://github.com/coder/coder/tree/main/helm/provisioner)
|
||||
@@ -13,10 +13,10 @@
|
||||
- Added login type (OIDC, GitHub, or built-in, or none) to users page (#8912)
|
||||
(@Emyrk)
|
||||
- Groups can be
|
||||
[automatically created](https://coder.com/docs/v2/latest/admin/auth#user-not-being-assigned--group-does-not-exist)
|
||||
[automatically created](https://coder.com/docs/admin/auth#user-not-being-assigned--group-does-not-exist)
|
||||
from OIDC group sync (#8884) (@Emyrk)
|
||||
- Parameter values can be specified via the
|
||||
[command line](https://coder.com/docs/v2/latest/cli/create#--parameter) during
|
||||
[command line](https://coder.com/docs/cli/create#--parameter) during
|
||||
workspace creation/updates (#8898) (@mtojek)
|
||||
- Added date range picker for the template insights page (#8976)
|
||||
(@BrunoQuaresma)
|
||||
@@ -56,6 +56,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -13,11 +13,11 @@
|
||||
- You can manually add OIDC or GitHub users (#9000) (@Emyrk)
|
||||
|
||||
> Use this with the
|
||||
> [CODER_OIDC_ALLOW_SIGNUPS](https://coder.com/docs/v2/latest/cli/server#--oidc-allow-signups)
|
||||
> [CODER_OIDC_ALLOW_SIGNUPS](https://coder.com/docs/cli/server#--oidc-allow-signups)
|
||||
> flag to manually onboard users before opening the floodgates to every user
|
||||
> in your identity provider!
|
||||
- CLI: The
|
||||
[--header-command](https://coder.com/docs/v2/latest/cli#--header-command) flag
|
||||
[--header-command](https://coder.com/docs/cli#--header-command) flag
|
||||
can leverage external services to provide dynamic headers to authenticate to a
|
||||
Coder deployment behind an application proxy or VPN (#9059) (@code-asher)
|
||||
- OIDC: Add support for Azure OIDC PKI auth instead of client secret (#9054)
|
||||
@@ -27,10 +27,10 @@
|
||||
(@spikecurtis)
|
||||
- Add support for NodePort service type (#8993) (@ffais)
|
||||
- Published
|
||||
[external provisioner chart](https://coder.com/docs/v2/latest/admin/provisioners#example-running-an-external-provisioner-with-helm)
|
||||
[external provisioner chart](https://coder.com/docs/admin/provisioners#example-running-an-external-provisioner-with-helm)
|
||||
to release and docs (#9050) (@spikecurtis)
|
||||
- Exposed everyone group through UI. You can now set
|
||||
[quotas](https://coder.com/docs/v2/latest/admin/quotas) for the `Everyone`
|
||||
[quotas](https://coder.com/docs/admin/quotas) for the `Everyone`
|
||||
group. (#9117) (@sreya)
|
||||
- Workspace build errors are shown as a tooltip (#9029) (@BrunoQuaresma)
|
||||
- Add build log history to the build log page (#9150) (@BrunoQuaresma)
|
||||
@@ -71,6 +71,6 @@
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -8,12 +8,12 @@
|
||||
> You can use `last_used_before` and `last_used_after` in the workspaces
|
||||
> search with [RFC3339Nano](https://www.rfc-editor.org/rfc/rfc3339) datetime
|
||||
- Add `daily_cost`` to `coder ls` to show
|
||||
[quota](https://coder.com/docs/v2/latest/admin/quotas) consumption (#9200)
|
||||
[quota](https://coder.com/docs/admin/quotas) consumption (#9200)
|
||||
(@ammario)
|
||||
- Added `coder_app` usage to template insights (#9138) (@mafredri)
|
||||
|
||||
- Added documentation for
|
||||
[workspace process logging](http://localhost:3000/docs/v2/latest/templates/process-logging).
|
||||
[workspace process logging](http://localhost:3000/docs/templates/process-logging).
|
||||
This enterprise feature can be used to log all system-level processes in
|
||||
workspaces. (#9002) (@deansheather)
|
||||
|
||||
@@ -44,6 +44,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -27,6 +27,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
### Documentation
|
||||
|
||||
- Explain
|
||||
[incompatibility in parameter options](https://coder.com/docs/v2/latest/templates/parameters#incompatibility-in-parameter-options-for-workspace-builds)
|
||||
[incompatibility in parameter options](https://coder.com/docs/templates/parameters#incompatibility-in-parameter-options-for-workspace-builds)
|
||||
for workspace builds (#9297) (@mtojek)
|
||||
|
||||
Compare:
|
||||
@@ -26,6 +26,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -36,6 +36,6 @@ Compare:
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
|
||||
- You can install Coder with
|
||||
[Homebrew](https://formulae.brew.sh/formula/coder#default) (#9414) (@aslilac).
|
||||
Our [install script](https://coder.com/docs/v2/latest/install#install-coder) will
|
||||
Our [install script](https://coder.com/docs/install#install-coder) will
|
||||
also use Homebrew, if present on your machine.
|
||||
- You can show/hide specific
|
||||
[display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps)
|
||||
@@ -52,7 +52,7 @@
|
||||
### Documentation
|
||||
|
||||
- Add
|
||||
[JetBrains Gateway Offline Mode](https://coder.com/docs/v2/latest/ides/gateway#jetbrains-gateway-in-an-offline-environment)
|
||||
[JetBrains Gateway Offline Mode](https://coder.com/docs/ides/gateway#jetbrains-gateway-in-an-offline-environment)
|
||||
config steps (#9388) (@ericpaulsen)
|
||||
- Describe
|
||||
[dynamic options and locals for parameters](https://github.com/coder/coder/tree/main/examples/parameters-dynamic-options)
|
||||
@@ -68,6 +68,6 @@
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or
|
||||
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or
|
||||
[upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
|
||||
release asset below.
|
||||
|
||||
@@ -127,4 +127,4 @@ Compare: [`v2.9.0...v2.10.0`](https://github.com/coder/coder/compare/v2.9.0...v2
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -73,4 +73,4 @@ Compare: [`v2.1.5...v2.2.0`](https://github.com/coder/coder/compare/v2.1.5...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
- Users are now warned when renaming workspaces (#10023) (@aslilac)
|
||||
- Add reverse tunnelling SSH support for unix sockets (#9976) (@monika-canva)
|
||||
- Admins can set a custom application name and logo on the log in screen (#9902) (@mtojek)
|
||||
> This is an [Enterprise feature](https://coder.com/docs/v2/latest/enterprise).
|
||||
> This is an [Enterprise feature](https://coder.com/docs/enterprise).
|
||||
- Add support for weekly active data on template insights (#9997) (@BrunoQuaresma)
|
||||
|
||||
- Add weekly user activity on template insights page (#10013) (@BrunoQuaresma)
|
||||
@@ -23,7 +23,7 @@
|
||||
- Add checks for preventing HSL colors from entering React state (#9893) (@Parkreiner)
|
||||
- Fix TestCreateValidateRichParameters/ValidateString (#9928) (@mtojek)
|
||||
- Pass `OnSubscribe` to HA MultiAgent (#9947) (@coadler)
|
||||
> This fixes a memory leak if you are running Coder in [HA](https://coder.com/docs/v2/latest/admin/high-availability).
|
||||
> This fixes a memory leak if you are running Coder in [HA](https://coder.com/docs/admin/high-availability).
|
||||
- Remove exp scaletest from slim binary (#9934) (@johnstcn)
|
||||
- Fetch workspace agent scripts and log sources using system auth ctx (#10043) (@johnstcn)
|
||||
- Fix typo in pgDump (#10033) (@johnstcn)
|
||||
@@ -47,4 +47,4 @@ Compare: [`v2.2.0...v2.2.1`](https://github.com/coder/coder/compare/v2.2.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -8,8 +8,8 @@
|
||||
|
||||
- Add "Create Workspace" button to the workspaces page (#10011) (@Parkreiner)
|
||||
<img src="https://user-images.githubusercontent.com/22407953/274334225-427095e4-d047-4cd6-80e7-744fa05ac3bf.png" alt="create workspace" width="600" />
|
||||
- Add support for [database encryption for user tokens](https://coder.com/docs/v2/latest/admin/encryption#database-encryption).
|
||||
> This is an [Enterprise feature](https://coder.com/docs/v2/latest/enterprise).
|
||||
- Add support for [database encryption for user tokens](https://coder.com/docs/admin/encryption#database-encryption).
|
||||
> This is an [Enterprise feature](https://coder.com/docs/enterprise).
|
||||
- Show descriptions for parameter options (#10068) (@aslilac)
|
||||
<img src="https://user-images.githubusercontent.com/418348/272730560-6a9a9c45-5493-4344-94b8-2892d3e9347f.png" width="500" alt="parameter descriptions" />
|
||||
- Allow reading the agent token from a file (#10080) (@kylecarbs)
|
||||
@@ -94,4 +94,4 @@ Compare: [`v2.2.1...v2.3.0`](https://github.com/coder/coder/compare/v2.2.1...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -46,4 +46,4 @@ Compare: [`v2.3.0...v2.3.1`](https://github.com/coder/coder/compare/v2.3.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -34,4 +34,4 @@ Compare: [`v2.3.1...v2.3.2`](https://github.com/coder/coder/compare/v2.3.1...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -40,4 +40,4 @@ Compare: [`v2.3.2...v2.3.3`](https://github.com/coder/coder/compare/v2.3.2...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -131,4 +131,4 @@ Compare: [`v2.3.3...v2.4.0`](https://github.com/coder/coder/compare/v2.3.3...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
- Templates can now be deprecated in "template settings" to warn new users and prevent new workspaces from being created (#10745) (@Emyrk)
|
||||
|
||||
> This is an [Enterprise feature](https://coder.com/docs/v2/latest/enterprise).
|
||||
> This is an [Enterprise feature](https://coder.com/docs/enterprise).
|
||||
- Add user/settings page for managing external auth (#10945) (@Emyrk)
|
||||
|
||||
- Allow auditors to read template insights (#10860) (@johnstcn)
|
||||
@@ -16,7 +16,7 @@
|
||||
- Dormant workspaces now appear in the default workspaces list (#11053) (@sreya)
|
||||
- Include server agent API version in buildinfo (#11057) (@spikecurtis)
|
||||
- Restart stopped workspaces on `coder ssh` command (#11050) (@Emyrk)
|
||||
- You can now specify an [allowlist for OIDC Groups](https://coder.com/docs/v2/latest/admin/auth#group-allowlist) (#11070) (@Emyrk)
|
||||
- You can now specify an [allowlist for OIDC Groups](https://coder.com/docs/admin/auth#group-allowlist) (#11070) (@Emyrk)
|
||||
- Display 'Deprecated' warning for agents using old API version (#11058) (@spikecurtis)
|
||||
- Add support for `coder_env` resource to set environment variables within a workspace (#11102) (@mafredri)
|
||||
- Handle session signals (#10842) (@mafredri)
|
||||
@@ -113,4 +113,4 @@ Compare: [`v2.4.0...v2.5.0`](https://github.com/coder/coder/compare/v2.4.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -29,4 +29,4 @@ Compare: [`v2.5.0...v2.5.1`](https://github.com/coder/coder/compare/v2.5.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -2,13 +2,13 @@
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
- Renaming workspaces is disabled by default to data loss. This can be re-enabled via a [server flag](https://coder.com/docs/v2/latest/cli/server#--allow-workspace-renames) (#11189) (@f0ssel)
|
||||
- Renaming workspaces is disabled by default to data loss. This can be re-enabled via a [server flag](https://coder.com/docs/cli/server#--allow-workspace-renames) (#11189) (@f0ssel)
|
||||
|
||||
### Features
|
||||
|
||||
- Allow templates to specify max_ttl or autostop_requirement (#10920) (@deansheather)
|
||||
- Add server flag to disable user custom quiet hours (#11124) (@deansheather)
|
||||
- Move [workspace proxies](https://coder.com/docs/v2/latest/admin/workspace-proxies) to GA (#11285) (@Emyrk)
|
||||
- Move [workspace proxies](https://coder.com/docs/admin/workspace-proxies) to GA (#11285) (@Emyrk)
|
||||
- Add light theme (preview) (#11266) (@aslilac)
|
||||
|
||||
- Enable CSRF token header (#11283) (@Emyrk)
|
||||
@@ -40,4 +40,4 @@ Compare: [`v2.5.1...v2.6.0`](https://github.com/coder/coder/compare/v2.5.1...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -17,4 +17,4 @@ Compare: [`v2.6.0...v2.6.1`](https://github.com/coder/coder/compare/v2.6.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -30,11 +30,11 @@ are backwards-compatible and have been tested significantly with the goal of imp
|
||||
- Display application name over sign in form instead of `Sign In` (#11500) (@f0ssel)
|
||||
- 🧹 Workspace Cleanup: Coder can flag or even auto-delete workspaces that are not in use (#11427) (@sreya)
|
||||
|
||||
> Template admins can manage the cleanup policy in template settings. This is an [Enterprise feature](https://coder.com/docs/v2/latest/enterprise)
|
||||
> Template admins can manage the cleanup policy in template settings. This is an [Enterprise feature](https://coder.com/docs/enterprise)
|
||||
- Add a character counter for fields with length limits (#11558) (@aslilac)
|
||||
- Add markdown support for template deprecation messages (#11562) (@aslilac)
|
||||
- Add support for loading template variables from tfvars files (#11549) (@mtojek)
|
||||
- Expose support links as [env variables](https://coder.com/docs/v2/latest/cli/server#--support-links) (#11697) (@mtojek)
|
||||
- Expose support links as [env variables](https://coder.com/docs/cli/server#--support-links) (#11697) (@mtojek)
|
||||
- Allow custom icons in the "support links" navbar (#11629) (@mtojek)
|
||||
|
||||
- Add additional fields to first time setup trial flow (#11533) (@coadler)
|
||||
@@ -136,4 +136,4 @@ Compare: [`v2.6.0...v2.7.0`](https://github.com/coder/coder/compare/v2.6.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -14,4 +14,4 @@ Compare: [`v2.7.0...v2.7.1`](https://github.com/coder/coder/compare/v2.7.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -12,4 +12,4 @@ Compare: [`v2.7.1...v2.7.2`](https://github.com/coder/coder/compare/v2.7.0...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -17,4 +17,4 @@ Compare: [`v2.7.2...v2.7.3`](https://github.com/coder/coder/compare/v2.7.2...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -104,4 +104,4 @@ Compare: [`v2.7.2...v2.7.3`](https://github.com/coder/coder/compare/v2.7.2...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -12,4 +12,4 @@ Compare: [`v2.8.1...v2.8.2`](https://github.com/coder/coder/compare/v2.8.1...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -17,4 +17,4 @@ Compare: [`v2.8.3...v2.8.4`](https://github.com/coder/coder/compare/v2.8.3...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
@@ -61,7 +61,7 @@
|
||||
|
||||
### Experimental features
|
||||
|
||||
The following features are hidden or disabled by default as we don't guarantee stability. Learn more about experiments in [our documentation](https://coder.com/docs/v2/latest/contributing/feature-stages#experimental-features).
|
||||
The following features are hidden or disabled by default as we don't guarantee stability. Learn more about experiments in [our documentation](https://coder.com/docs/contributing/feature-stages#experimental-features).
|
||||
|
||||
- The `coder support` command generates a ZIP with deployment information, agent logs, and server config values for troubleshooting purposes. We will publish documentation on how it works (and un-hide the feature) in a future release (#12328) (@johnstcn)
|
||||
- Port sharing: Allow users to share ports running in their workspace with other Coder users (#11939) (#12119) (#12383) (@deansheather) (@f0ssel)
|
||||
@@ -153,4 +153,4 @@ Compare: [`v2.8.5...v2.9.0`](https://github.com/coder/coder/compare/v2.8.5...v2.
|
||||
|
||||
## Install/upgrade
|
||||
|
||||
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a release asset below.
|
||||
Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below.
|
||||
|
||||
+12
-13
@@ -37,7 +37,7 @@ The primary developer use case is a local IDE connecting over SSH to a Coder
|
||||
workspace.
|
||||
|
||||
Coder's networking stack has intelligence to attempt a peer-to-peer or
|
||||
[Direct connection](https://coder.com/docs/v2/latest/networking#direct-connections)
|
||||
[Direct connection](https://coder.com/docs/networking#direct-connections)
|
||||
between the local IDE and the workspace. However, this requires some additional
|
||||
protocols like UDP and being able to reach a STUN server to echo the IP
|
||||
addresses of the local IDE machine and workspace, for sharing using a Wireguard
|
||||
@@ -52,11 +52,11 @@ to establish these direct connections.
|
||||
Setting the following flags as shown disables this logic to simplify
|
||||
troubleshooting.
|
||||
|
||||
| Flag | Value | Meaning |
|
||||
| -------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
|
||||
| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/v2/latest/cli/server#--block-direct-connections) | `true` | Blocks direct connections |
|
||||
| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/v2/latest/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN |
|
||||
| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/v2/latest/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP |
|
||||
| Flag | Value | Meaning |
|
||||
| ---------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
|
||||
| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/cli/server#--block-direct-connections) | `true` | Blocks direct connections |
|
||||
| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN |
|
||||
| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP |
|
||||
|
||||
### How do I configure NGINX as the reverse proxy in front of Coder?
|
||||
|
||||
@@ -118,8 +118,7 @@ resource "coder_app" "code-server" {
|
||||
An important concept to understand is that Coder creates workspaces which have
|
||||
an agent that must be able to reach the `coder server`.
|
||||
|
||||
If the
|
||||
[`CODER_ACCESS_URL`](https://coder.com/docs/v2/latest/admin/configure#access-url)
|
||||
If the [`CODER_ACCESS_URL`](https://coder.com/docs/admin/configure#access-url)
|
||||
is not accessible from a workspace, the workspace may build, but the agent
|
||||
cannot reach Coder, and thus the missing icons. e.g., Terminal, IDEs, Apps.
|
||||
|
||||
@@ -149,9 +148,9 @@ of these values can lead to existing workspaces failing to start. This issue
|
||||
occurs because the Terraform state will not be in sync with the new template.
|
||||
|
||||
However, a lesser-known CLI sub-command,
|
||||
[`coder update`](https://coder.com/docs/v2/latest/cli/update), can resolve this
|
||||
issue. This command re-prompts users to re-enter the input variables,
|
||||
potentially saving the workspace from a failed status.
|
||||
[`coder update`](https://coder.com/docs/cli/update), can resolve this issue.
|
||||
This command re-prompts users to re-enter the input variables, potentially
|
||||
saving the workspace from a failed status.
|
||||
|
||||
```sh
|
||||
coder update --always-prompt <workspace name>
|
||||
@@ -290,12 +289,12 @@ References:
|
||||
|
||||
- [Public Github Issue 6117](https://github.com/coder/coder/issues/6117)
|
||||
- [Public Github Issue 5677](https://github.com/coder/coder/issues/5677)
|
||||
- [Coder docs: Templates/Change Management](https://coder.com/docs/v2/latest/templates/change-management)
|
||||
- [Coder docs: Templates/Change Management](https://coder.com/docs/templates/change-management)
|
||||
|
||||
### Can I run Coder in an air-gapped or offline mode? (no Internet)?
|
||||
|
||||
Yes, Coder can be deployed in air-gapped or offline mode.
|
||||
https://coder.com/docs/v2/latest/install/offline
|
||||
https://coder.com/docs/install/offline
|
||||
|
||||
Our product bundles with the Terraform binary so assume access to terraform.io
|
||||
during installation. The docs outline rebuilding the Coder container with
|
||||
|
||||
@@ -37,9 +37,9 @@ two type of modules that automate the JFrog Artifactory and Coder integration.
|
||||
|
||||
This module is usable by JFrog self-hosted (on-premises) Artifactory as it
|
||||
requires configuring a custom integration. This integration benefits from
|
||||
Coder's [external-auth](https://coder.com/docs/v2/latest/admin/external-auth)
|
||||
feature and allows each user to authenticate with Artifactory using an OAuth
|
||||
flow and issues user-scoped tokens to each user.
|
||||
Coder's [external-auth](https://coder.com/docs/admin/external-auth) feature and
|
||||
allows each user to authenticate with Artifactory using an OAuth flow and issues
|
||||
user-scoped tokens to each user.
|
||||
|
||||
To set this up, follow these steps:
|
||||
|
||||
@@ -72,8 +72,8 @@ artifactory:
|
||||
|
||||
|
||||
3. Add a new
|
||||
[external authentication](https://coder.com/docs/v2/latest/admin/external-auth)
|
||||
to Coder by setting these env variables,
|
||||
[external authentication](https://coder.com/docs/admin/external-auth) to
|
||||
Coder by setting these env variables,
|
||||
|
||||
```env
|
||||
# JFrog Artifactory External Auth
|
||||
|
||||
@@ -16,7 +16,7 @@ December 13, 2023
|
||||
|
||||
To configure custom claims in Okta to support syncing roles and groups with
|
||||
Coder, you must first have setup an Okta application with
|
||||
[OIDC working with Coder](https://coder.com/docs/v2/latest/admin/auth#openid-connect).
|
||||
[OIDC working with Coder](https://coder.com/docs/admin/auth#openid-connect).
|
||||
From here, we will add additional claims for Coder to use for syncing groups and
|
||||
roles.
|
||||
|
||||
@@ -39,14 +39,14 @@ be sent.
|
||||
|
||||
> !! If the user does not belong to any groups, the claim will not be sent. Make
|
||||
> sure the user authenticating for testing is in at least 1 group. Defer to
|
||||
> [troubleshooting](https://coder.com/docs/v2/latest/admin/auth#troubleshooting)
|
||||
> with issues
|
||||
> [troubleshooting](https://coder.com/docs/admin/auth#troubleshooting) with
|
||||
> issues
|
||||
|
||||
|
||||
|
||||
Configure Coder to use these claims for group sync. These claims are present in
|
||||
the `id_token`. See all configuration options for group sync in the
|
||||
[docs](https://coder.com/docs/v2/latest/admin/auth#group-sync-enterprise).
|
||||
[docs](https://coder.com/docs/admin/auth#group-sync-enterprise).
|
||||
|
||||
```bash
|
||||
# Add the 'groups' scope.
|
||||
|
||||
@@ -11,14 +11,14 @@ December 13, 2023
|
||||
---
|
||||
|
||||
This is a guide on how to make Coder guides, it is not listed on our
|
||||
[official guides page](https://coder.com/docs/v2/latest/guides) in the docs.
|
||||
Intended for those who don't frequently contribute documentation changes to the
|
||||
`coder/coder` repository.
|
||||
[official guides page](https://coder.com/docs/guides) in the docs. Intended for
|
||||
those who don't frequently contribute documentation changes to the `coder/coder`
|
||||
repository.
|
||||
|
||||
## Content
|
||||
|
||||
Defer to our
|
||||
[Contributing/Documentation](https://coder.com/docs/v2/latest/contributing/documentation)
|
||||
[Contributing/Documentation](https://coder.com/docs/contributing/documentation)
|
||||
page for rules on technical writing.
|
||||
|
||||
### Adding Photos
|
||||
|
||||
@@ -6,5 +6,5 @@ Enterprise. These tutorials are hosted on our
|
||||
request new topics to be covered.
|
||||
|
||||
<children>
|
||||
This page is rendered on https://coder.com/docs/v2/latest/guides. Refer to the other documents in the `guides/` directory for specific employee-written guides.
|
||||
This page is rendered on https://coder.com/docs/guides. Refer to the other documents in the `guides/` directory for specific employee-written guides.
|
||||
</children>
|
||||
|
||||
@@ -27,9 +27,8 @@ using Coder's [JFrog Xray Integration](https://github.com/coder/coder-xray).
|
||||
[permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
|
||||
for the repositories you want to scan.
|
||||
2. Create a Coder
|
||||
[token](https://coder.com/docs/v2/latest/cli/tokens_create#tokens-create)
|
||||
with a user that has the
|
||||
[`owner`](https://coder.com/docs/v2/latest/admin/users#roles) role.
|
||||
[token](https://coder.com/docs/cli/tokens_create#tokens-create) with a user
|
||||
that has the [`owner`](https://coder.com/docs/admin/users#roles) role.
|
||||
3. Create kubernetes secrets for the JFrog Xray and Coder tokens.
|
||||
|
||||
```bash
|
||||
|
||||
@@ -224,9 +224,9 @@ resource "coder_app" "jupyter" {
|
||||
```
|
||||
|
||||
If you cannot enable a
|
||||
[wildcard subdomain](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url),
|
||||
[wildcard subdomain](https://coder.com/docs/admin/configure#wildcard-access-url),
|
||||
you can configure the template to run Jupyter on a path. There is however
|
||||
[security risk](https://coder.com/docs/v2/latest/cli/server#--dangerous-allow-path-app-sharing)
|
||||
[security risk](https://coder.com/docs/cli/server#--dangerous-allow-path-app-sharing)
|
||||
running an app on a path and the template code is more complicated with coder
|
||||
value substitution to recreate the path structure.
|
||||
|
||||
@@ -271,10 +271,10 @@ resource "coder_app" "rstudio" {
|
||||
```
|
||||
|
||||
If you cannot enable a
|
||||
[wildcard subdomain](https://coder.com/docs/v2/latest/admin/configure#wildcard-access-url),
|
||||
[wildcard subdomain](https://coder.com/docs/admin/configure#wildcard-access-url),
|
||||
you can configure the template to run RStudio on a path using an NGINX reverse
|
||||
proxy in the template. There is however
|
||||
[security risk](https://coder.com/docs/v2/latest/cli/server#--dangerous-allow-path-app-sharing)
|
||||
[security risk](https://coder.com/docs/cli/server#--dangerous-allow-path-app-sharing)
|
||||
running an app on a path and the template code is more complicated with coder
|
||||
value substitution to recreate the path structure.
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@ Coder can be installed on many cloud providers using our
|
||||
|
||||
| Platform Name | Status | Documentation | Deploy |
|
||||
| --------------------- | ----------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| AWS EC2 | Live ✅ | [Guide: AWS](https://coder.com/docs/v2/latest/platforms/aws) | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) |
|
||||
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
|
||||
| Google Compute Engine | Live ✅ | [Guide: Google Compute Engine](https://coder.com/docs/v2/latest/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) |
|
||||
| AWS EC2 | Live ✅ | [Guide: AWS](https://coder.com/docs/platforms/aws) | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) |
|
||||
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
|
||||
| Google Compute Engine | Live ✅ | [Guide: Google Compute Engine](https://coder.com/docs/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) |
|
||||
| Fly.io | Live ✅ | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) | [Deploy Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) |
|
||||
| Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [](https://railway.app/template/coder?referralCode=tfH8Uw) |
|
||||
| Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/README.md) | [](https://heroku.com/deploy?template=https://github.com/coder/packages) |
|
||||
|
||||
@@ -91,7 +91,7 @@ You can use a remote Docker host in 2 ways.
|
||||
[remote host](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs#remote-hosts)
|
||||
over SSH or TCP.
|
||||
2. Running an
|
||||
[external provisoner](https://coder.com/docs/v2/latest/admin/provisioners#external-provisioners)
|
||||
[external provisoner](https://coder.com/docs/admin/provisioners#external-provisioners)
|
||||
on the remote docker host.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@@ -82,6 +82,6 @@ Otherwise, the following information will be reported:
|
||||
- Time the affected API key was last used
|
||||
|
||||
> 💡 If your license includes the
|
||||
> [Audit Logs](https://coder.com/docs/v2/latest/admin/audit-logs#filtering-logs)
|
||||
> feature, you can then query all actions performed by the above users by using
|
||||
> the filter `email:$USER_EMAIL`.
|
||||
> [Audit Logs](https://coder.com/docs/admin/audit-logs#filtering-logs) feature,
|
||||
> you can then query all actions performed by the above users by using the
|
||||
> filter `email:$USER_EMAIL`.
|
||||
|
||||
Reference in New Issue
Block a user