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

chore: update documentation links to the new format (#13797)

Browse Source
This commit is contained in:
Muhammad Atif Ali
2024-07-10 21:31:37 +03:00
committed by GitHub
parent 2a297b073a
commit 0787de88a9
87 changed files with 213 additions and 222 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
agent/agentscripts/agentscripts.go
View File

@ -349,7 +349,7 @@ func (r *Runner) run(ctx context.Context, script codersdk.WorkspaceAgentScript)
"This usually means a child process was started with references to stdout or stderr. As a result, this " + "This usually means a child process was started with references to stdout or stderr. As a result, this " +
"process may now have been terminated. Consider redirecting the output or using a separate " + "process may now have been terminated. Consider redirecting the output or using a separate " +
"\"coder_script\" for the process, see " + "\"coder_script\" for the process, see " +
"https://coder.com/docs/v2/latest/templates/troubleshooting#startup-script-issues for more information.", "https://coder.com/docs/templates/troubleshooting#startup-script-issues for more information.",
) )
// Inform the user by propagating the message via log writers. // Inform the user by propagating the message via log writers.
_, _ = fmt.Fprintf(cmd.Stderr, "WARNING: %s. %s\n", message, details) _, _ = fmt.Fprintf(cmd.Stderr, "WARNING: %s. %s\n", message, details)

8
cli/cliui/agent.go
View File

@ -116,7 +116,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
if agent.Status == codersdk.WorkspaceAgentTimeout { if agent.Status == codersdk.WorkspaceAgentTimeout {
now := time.Now() now := time.Now()
sw.Log(now, codersdk.LogLevelInfo, "The workspace agent is having trouble connecting, wait for it to connect or restart your workspace.") sw.Log(now, codersdk.LogLevelInfo, "The workspace agent is having trouble connecting, wait for it to connect or restart your workspace.")
sw.Log(now, codersdk.LogLevelInfo, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates#agent-connection-issues")) sw.Log(now, codersdk.LogLevelInfo, troubleshootingMessage(agent, "https://coder.com/docs/templates#agent-connection-issues"))
for agent.Status == codersdk.WorkspaceAgentTimeout { for agent.Status == codersdk.WorkspaceAgentTimeout {
if agent, err = fetch(); err != nil { if agent, err = fetch(); err != nil {
return xerrors.Errorf("fetch: %w", err) return xerrors.Errorf("fetch: %w", err)
@ -221,13 +221,13 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
sw.Fail(stage, safeDuration(sw, agent.ReadyAt, agent.StartedAt)) sw.Fail(stage, safeDuration(sw, agent.ReadyAt, agent.StartedAt))
// Use zero time (omitted) to separate these from the startup logs. // Use zero time (omitted) to separate these from the startup logs.
sw.Log(time.Time{}, codersdk.LogLevelWarn, "Warning: A startup script exited with an error and your workspace may be incomplete.") sw.Log(time.Time{}, codersdk.LogLevelWarn, "Warning: A startup script exited with an error and your workspace may be incomplete.")
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates/troubleshooting#startup-script-exited-with-an-error")) sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/templates/troubleshooting#startup-script-exited-with-an-error"))
default: default:
switch { switch {
case agent.LifecycleState.Starting(): case agent.LifecycleState.Starting():
// Use zero time (omitted) to separate these from the startup logs. // Use zero time (omitted) to separate these from the startup logs.
sw.Log(time.Time{}, codersdk.LogLevelWarn, "Notice: The startup scripts are still running and your workspace may be incomplete.") sw.Log(time.Time{}, codersdk.LogLevelWarn, "Notice: The startup scripts are still running and your workspace may be incomplete.")
sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates/troubleshooting#your-workspace-may-be-incomplete")) sw.Log(time.Time{}, codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/templates/troubleshooting#your-workspace-may-be-incomplete"))
// Note: We don't complete or fail the stage here, it's // Note: We don't complete or fail the stage here, it's
// intentionally left open to indicate this stage didn't // intentionally left open to indicate this stage didn't
// complete. // complete.
@ -249,7 +249,7 @@ func Agent(ctx context.Context, writer io.Writer, agentID uuid.UUID, opts AgentO
stage := "The workspace agent lost connection" stage := "The workspace agent lost connection"
sw.Start(stage) sw.Start(stage)
sw.Log(time.Now(), codersdk.LogLevelWarn, "Wait for it to reconnect or restart your workspace.") sw.Log(time.Now(), codersdk.LogLevelWarn, "Wait for it to reconnect or restart your workspace.")
sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/v2/latest/templates/troubleshooting#agent-connection-issues")) sw.Log(time.Now(), codersdk.LogLevelWarn, troubleshootingMessage(agent, "https://coder.com/docs/templates/troubleshooting#agent-connection-issues"))
disconnectedAt := agent.DisconnectedAt disconnectedAt := agent.DisconnectedAt
for agent.Status == codersdk.WorkspaceAgentDisconnected { for agent.Status == codersdk.WorkspaceAgentDisconnected {

2
cli/dotfiles.go
View File

@ -204,7 +204,7 @@ func (r *RootCmd) dotfiles() *serpent.Command {
} }
if fi.Mode()&0o111 == 0 { if fi.Mode()&0o111 == 0 {
return xerrors.Errorf("script %q is not executable. See https://coder.com/docs/v2/latest/dotfiles for information on how to resolve the issue.", script) return xerrors.Errorf("script %q is not executable. See https://coder.com/docs/dotfiles for information on how to resolve the issue.", script)
} }
// it is safe to use a variable command here because it's from // it is safe to use a variable command here because it's from

2
cli/server.go
View File

@ -838,7 +838,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
} }
defer options.Telemetry.Close() defer options.Telemetry.Close()
} else { } else {
logger.Warn(ctx, `telemetry disabled, unable to notify of security issues. Read more: https://coder.com/docs/v2/latest/admin/telemetry`) logger.Warn(ctx, `telemetry disabled, unable to notify of security issues. Read more: https://coder.com/docs/admin/telemetry`)
} }
// This prevents the pprof import from being accidentally deleted. // This prevents the pprof import from being accidentally deleted.

4
cli/testdata/server-config.yaml.golden vendored
View File

@ -427,8 +427,8 @@ termsOfServiceURL: ""
# (default: ed25519, type: string) # (default: ed25519, type: string)
sshKeygenAlgorithm: ed25519 sshKeygenAlgorithm: ed25519
# URL to use for agent troubleshooting when not set in the template. # URL to use for agent troubleshooting when not set in the template.
# (default: https://coder.com/docs/v2/latest/templates/troubleshooting, type: url) # (default: https://coder.com/docs/templates/troubleshooting, type: url)
agentFallbackTroubleshootingURL: https://coder.com/docs/v2/latest/templates/troubleshooting agentFallbackTroubleshootingURL: https://coder.com/docs/templates/troubleshooting
# Disable workspace apps that are not served from subdomains. Path-based apps can # Disable workspace apps that are not served from subdomains. Path-based apps can
# make requests to the Coder API and pose a security risk when the workspace # make requests to the Coder API and pose a security risk when the workspace
# serves malicious JavaScript. This is recommended for security purposes if a # serves malicious JavaScript. This is recommended for security purposes if a

10
coderd/healthcheck/health/model.go
View File

@ -4,7 +4,6 @@ import (
"fmt" "fmt"
"strings" "strings"
"github.com/coder/coder/v2/buildinfo"
"github.com/coder/coder/v2/coderd/util/ptr" "github.com/coder/coder/v2/coderd/util/ptr"
) )
@ -49,7 +48,7 @@ const (
// Default docs URL // Default docs URL
var ( var (
docsURLDefault = "https://coder.com/docs/v2" docsURLDefault = "https://coder.com/docs"
) )
// @typescript-generate Severity // @typescript-generate Severity
@ -92,12 +91,7 @@ func (m Message) URL(base string) string {
if base == "" { if base == "" {
base = docsURLDefault base = docsURLDefault
versionPath := buildinfo.Version() return fmt.Sprintf("%s/admin/healthcheck#%s", base, codeAnchor)
if buildinfo.IsDev() {
// for development versions, just use latest
versionPath = "latest"
}
return fmt.Sprintf("%s/%s/admin/healthcheck#%s", base, versionPath, codeAnchor)
} }
// We don't assume that custom docs URLs are versioned. // We don't assume that custom docs URLs are versioned.

4
coderd/healthcheck/health/model_test.go
View File

@ -17,8 +17,8 @@ func Test_MessageURL(t *testing.T) {
base string base string
expected string expected string
}{ }{
{"empty", "", "", "https://coder.com/docs/v2/latest/admin/healthcheck#eunknown"}, {"empty", "", "", "https://coder.com/docs/admin/healthcheck#eunknown"},
{"default", health.CodeAccessURLFetch, "", "https://coder.com/docs/v2/latest/admin/healthcheck#eacs03"}, {"default", health.CodeAccessURLFetch, "", "https://coder.com/docs/admin/healthcheck#eacs03"},
{"custom docs base", health.CodeAccessURLFetch, "https://example.com/docs", "https://example.com/docs/admin/healthcheck#eacs03"}, {"custom docs base", health.CodeAccessURLFetch, "https://example.com/docs", "https://example.com/docs/admin/healthcheck#eacs03"},
} { } {
tt := tt tt := tt

2
codersdk/deployment.go
View File

@ -1867,7 +1867,7 @@ when required by your organization's security policy.`,
Flag: "agent-fallback-troubleshooting-url", Flag: "agent-fallback-troubleshooting-url",
Env: "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL", Env: "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL",
Hidden: true, Hidden: true,
Default: "https://coder.com/docs/v2/latest/templates/troubleshooting", Default: "https://coder.com/docs/templates/troubleshooting",
Value: &c.AgentFallbackTroubleshootingURL, Value: &c.AgentFallbackTroubleshootingURL,
YAML: "agentFallbackTroubleshootingURL", YAML: "agentFallbackTroubleshootingURL",
}, },

20
codersdk/healthsdk/healthsdk_test.go
View File

@ -41,22 +41,22 @@ func TestSummarize(t *testing.T) {
expected := []string{ expected := []string{
"Access URL: Error: test error", "Access URL: Error: test error",
"Access URL: Warn: TEST: testing", "Access URL: Warn: TEST: testing",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test", "See: https://coder.com/docs/admin/healthcheck#test",
"Database: Error: test error", "Database: Error: test error",
"Database: Warn: TEST: testing", "Database: Warn: TEST: testing",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test", "See: https://coder.com/docs/admin/healthcheck#test",
"DERP: Error: test error", "DERP: Error: test error",
"DERP: Warn: TEST: testing", "DERP: Warn: TEST: testing",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test", "See: https://coder.com/docs/admin/healthcheck#test",
"Provisioner Daemons: Error: test error", "Provisioner Daemons: Error: test error",
"Provisioner Daemons: Warn: TEST: testing", "Provisioner Daemons: Warn: TEST: testing",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test", "See: https://coder.com/docs/admin/healthcheck#test",
"Websocket: Error: test error", "Websocket: Error: test error",
"Websocket: Warn: TEST: testing", "Websocket: Warn: TEST: testing",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test", "See: https://coder.com/docs/admin/healthcheck#test",
"Workspace Proxies: Error: test error", "Workspace Proxies: Error: test error",
"Workspace Proxies: Warn: TEST: testing", "Workspace Proxies: Warn: TEST: testing",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test", "See: https://coder.com/docs/admin/healthcheck#test",
} }
actual := hr.Summarize("") actual := hr.Summarize("")
assert.Equal(t, expected, actual) assert.Equal(t, expected, actual)
@ -93,9 +93,9 @@ func TestSummarize(t *testing.T) {
expected: []string{ expected: []string{
"Error: testing", "Error: testing",
"Warn: TEST01: testing one", "Warn: TEST01: testing one",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test01", "See: https://coder.com/docs/admin/healthcheck#test01",
"Warn: TEST02: testing two", "Warn: TEST02: testing two",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test02", "See: https://coder.com/docs/admin/healthcheck#test02",
}, },
}, },
{ {
@ -117,9 +117,9 @@ func TestSummarize(t *testing.T) {
expected: []string{ expected: []string{
"TEST: Error: testing", "TEST: Error: testing",
"TEST: Warn: TEST01: testing one", "TEST: Warn: TEST01: testing one",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test01", "See: https://coder.com/docs/admin/healthcheck#test01",
"TEST: Warn: TEST02: testing two", "TEST: Warn: TEST02: testing two",
"See: https://coder.com/docs/v2/latest/admin/healthcheck#test02", "See: https://coder.com/docs/admin/healthcheck#test02",
}, },
}, },
} { } {

2
docs/admin/auth.md
View File

@ -321,7 +321,7 @@ OIDC provider will be added to the `myCoderGroupName` group in Coder.
### Group allowlist ### Group allowlist
You can limit which groups from your identity provider can log in to Coder with 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: Users who are not in a matching group will see the following error:
![Unauthorized group error](../images/admin/group-allowlist.png) ![Unauthorized group error](../images/admin/group-allowlist.png)

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

@ -184,8 +184,7 @@ CODER_EXTERNAL_AUTH_0_REGEX=github\.company\.org
### JFrog Artifactory ### JFrog Artifactory
See See [this](https://coder.com/docs/guides/artifactory-integration#jfrog-oauth)
[this](https://coder.com/docs/v2/latest/guides/artifactory-integration#jfrog-oauth)
guide on instructions on how to set up for JFrog Artifactory. guide on instructions on how to set up for JFrog Artifactory.
### Custom scopes ### Custom scopes

4
docs/architecture/architecture.md
View File

@ -357,8 +357,8 @@ project-oriented [features](https://containers.dev/features) without requiring
platform administrators to push altered Docker images. platform administrators to push altered Docker images.
Learn more about Learn more about
[Dev containers support](https://coder.com/docs/v2/latest/templates/dev-containers) [Dev containers support](https://coder.com/docs/templates/dev-containers) in
in Coder. Coder.
![Architecture Diagram](../images/architecture-devcontainers.png) ![Architecture Diagram](../images/architecture-devcontainers.png)

8
docs/changelogs/v0.25.0.md
View File

@ -8,7 +8,7 @@
- The `coder stat` fetches workspace utilization metrics, even from within a - The `coder stat` fetches workspace utilization metrics, even from within a
container. Our example templates have been updated to use this to show CPU, container. Our example templates have been updated to use this to show CPU,
memory, disk via memory, disk via
[agent metadata](https://coder.com/docs/v2/latest/templates/agent-metadata) [agent metadata](https://coder.com/docs/templates/agent-metadata)
(#8005) (#8005)
- Helm: `coder.command` can specify a different command for the Coder pod - Helm: `coder.command` can specify a different command for the Coder pod
(#8116) (#8116)
@ -20,7 +20,7 @@
- Healthcheck endpoint has a database section: `/api/v2/debug/health` - Healthcheck endpoint has a database section: `/api/v2/debug/health`
- Force DERP connections in CLI with `--disable-direct` flag (#8131) - Force DERP connections in CLI with `--disable-direct` flag (#8131)
- Disable all direct connections for a Coder deployment with - 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) (#7936)
- Search for workspaces based on last activity (#2658) - Search for workspaces based on last activity (#2658)
```text ```text
@ -83,6 +83,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

10
docs/changelogs/v0.26.0.md
View File

@ -2,7 +2,7 @@
### Important changes ### 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 are enabled by default. The following block within templates is obsolete and
can be removed from your templates: can be removed from your templates:
@ -16,13 +16,13 @@
> previously necessary to activate this additional feature. > previously necessary to activate this additional feature.
- Our scale test CLI is - 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 to allow for rapid iteration. You can still interact with it via
`coder exp scaletest` (#8339) `coder exp scaletest` (#8339)
### Features ### 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 specific branch
### Bug fixes ### Bug fixes
@ -49,6 +49,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

6
docs/changelogs/v0.26.1.md
View File

@ -2,7 +2,7 @@
### Features ### Features
- [Devcontainer templates](https://coder.com/docs/v2/latest/templates/dev-containers) - [Devcontainer templates](https://coder.com/docs/templates/dev-containers)
for Coder (#8256) for Coder (#8256)
- The dashboard will warn users when a workspace is unhealthy (#8422) - The dashboard will warn users when a workspace is unhealthy (#8422)
- Audit logs `resource_target` search query allows you to search by resource - Audit logs `resource_target` search query allows you to search by resource
@ -31,6 +31,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

16
docs/changelogs/v0.27.0.md
View File

@ -5,7 +5,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 > ⚠️ **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`. > to connect via `coder ssh`.
### Features ### Features
@ -24,7 +24,7 @@ Agent logs can be pushed after a workspace has started (#8528)
- Template version messages (#8435) - 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"> <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) - 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) Host your own copy of Coder's documentation in your own environment (#8527)
(#8601) (#8601)
- Add custom coder bin path for `config-ssh` (#8425) - 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) Agent logs can be pushed after a workspace has started (#8528)
> ⚠️ **Warning:** You will need to > ⚠️ **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`. > to connect via `coder ssh`.
### Features ### Features
@ -76,7 +76,7 @@ Agent logs can be pushed after a workspace has started (#8528)
- Template version messages (#8435) - 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"> <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) - 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) Host your own copy of Coder's documentation in your own environment (#8527)
(#8601) (#8601)
- Add custom coder bin path for `config-ssh` (#8425) - Add custom coder bin path for `config-ssh` (#8425)
@ -115,8 +115,8 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.
- Custom API use cases (custom agent logs, CI/CD pipelines) (#8445) - Custom API use cases (custom agent logs, CI/CD pipelines) (#8445)
@ -132,6 +132,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

4
docs/changelogs/v0.27.1.md
View File

@ -21,6 +21,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

4
docs/changelogs/v0.27.3.md
View File

@ -15,6 +15,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

20
docs/changelogs/v2.0.0.md
View File

@ -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 [happily support](https://coder.com/docs/admin/scaling/scale-utility#recent-scale-tests) 1000+ users
and workspace connections and workspace connections
- We have a full suite of - 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 customers deployed in production
- Users depend on our CLI to - 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 pipelines and templates
Why not v1.0? At the time of writing, our legacy product is currently on v1.34. 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 ### 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 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 Admin role and above can still use the `Users` page in dashboard and query
users via the API (#8650) (@Emyrk) 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) [Kubernetes example template](https://github.com/coder/coder/tree/main/examples/templates/kubernetes)
uses a `kubernetes_deployment` instead of `kubernetes_pod` since it works uses a `kubernetes_deployment` instead of `kubernetes_pod` since it works
best with 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. in Coder.
### Features ### Features
@ -60,11 +60,11 @@ ben@coder.com!
- Template insights: Admins can see daily active users, user latency, and - Template insights: Admins can see daily active users, user latency, and
popular IDEs (#8722) (@BrunoQuaresma) popular IDEs (#8722) (@BrunoQuaresma)
![Template insights](https://user-images.githubusercontent.com/22407953/258239988-69641bd6-28da-4c60-9ae7-c0b1bba53859.png) ![Template insights](https://user-images.githubusercontent.com/22407953/258239988-69641bd6-28da-4c60-9ae7-c0b1bba53859.png)
- [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 Stream Kubernetes event logs to the Coder agent logs to reveal Kuernetes-level
issues such as ResourceQuota limitations, invalid images, etc. issues such as ResourceQuota limitations, invalid images, etc.
![Kubernetes quota](https://raw.githubusercontent.com/coder/coder/main/docs/platforms/kubernetes/coder-logstream-kube-logs-quota-exceeded.png) ![Kubernetes quota](https://raw.githubusercontent.com/coder/coder/main/docs/platforms/kubernetes/coder-logstream-kube-logs-quota-exceeded.png)
- [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. (Enterprise): Sync roles from your OIDC provider to Coder roles (e.g.
`Template Admin`) (#8595) (@Emyrk) `Template Admin`) (#8595) (@Emyrk)
- Users can convert their accounts from username/password authentication to SSO - 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 - CLI: Added `--var` shorthand for `--variable` in
`coder templates <create/push>` CLI (#8710) (@ammario) `coder templates <create/push>` CLI (#8710) (@ammario)
- Sever logs: Added fine-grained - 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) Regex (#8748) (@ammario)
- d3991fac2 feat(coderd): add parameter insights to template insights (#8656) - d3991fac2 feat(coderd): add parameter insights to template insights (#8656)
(@mafredri) (@mafredri)
- Agent metadata: In cases where Coder does not receive metadata in time, we - 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 render the previous "stale" value. Stale values are grey versus the typical
green color. (#8745) (@BrunoQuaresma) 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, Generate a link that automatically creates a workspace on behalf of the user,
skipping the "Create Workspace" form (#8651) (@BrunoQuaresma) skipping the "Create Workspace" form (#8651) (@BrunoQuaresma)
![Open in Coder](https://user-images.githubusercontent.com/22407953/257410429-712de64d-ea2c-4520-8abf-0a9ba5a16e7a.png)- ![Open in Coder](https://user-images.githubusercontent.com/22407953/257410429-712de64d-ea2c-4520-8abf-0a9ba5a16e7a.png)-
@ -147,6 +147,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

12
docs/changelogs/v2.0.2.md
View File

@ -2,10 +2,10 @@
### Features ### Features
- [External provisioners](https://coder.com/docs/v2/latest/admin/provisioners) - [External provisioners](https://coder.com/docs/admin/provisioners)
updates updates
- Added - Added
[PSK authentication](https://coder.com/docs/v2/latest/admin/provisioners#authentication) [PSK authentication](https://coder.com/docs/admin/provisioners#authentication)
method (#8877) (@spikecurtis) method (#8877) (@spikecurtis)
- Provisioner daemons can be deployed - Provisioner daemons can be deployed
[via Helm](https://github.com/coder/coder/tree/main/helm/provisioner) [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) - Added login type (OIDC, GitHub, or built-in, or none) to users page (#8912)
(@Emyrk) (@Emyrk)
- Groups can be - 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) from OIDC group sync (#8884) (@Emyrk)
- Parameter values can be specified via the - 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) workspace creation/updates (#8898) (@mtojek)
- Added date range picker for the template insights page (#8976) - Added date range picker for the template insights page (#8976)
(@BrunoQuaresma) (@BrunoQuaresma)
@ -56,6 +56,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

12
docs/changelogs/v2.1.0.md
View File

@ -13,11 +13,11 @@
- You can manually add OIDC or GitHub users (#9000) (@Emyrk) - You can manually add OIDC or GitHub users (#9000) (@Emyrk)
![Manual add user](https://user-images.githubusercontent.com/22407953/261455971-adf2707c-93a7-49c6-be5d-2ec177e224b9.png) ![Manual add user](https://user-images.githubusercontent.com/22407953/261455971-adf2707c-93a7-49c6-be5d-2ec177e224b9.png)
> Use this with the > 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 > flag to manually onboard users before opening the floodgates to every user
> in your identity provider! > in your identity provider!
- CLI: The - 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 can leverage external services to provide dynamic headers to authenticate to a
Coder deployment behind an application proxy or VPN (#9059) (@code-asher) Coder deployment behind an application proxy or VPN (#9059) (@code-asher)
- OIDC: Add support for Azure OIDC PKI auth instead of client secret (#9054) - OIDC: Add support for Azure OIDC PKI auth instead of client secret (#9054)
@ -27,10 +27,10 @@
(@spikecurtis) (@spikecurtis)
- Add support for NodePort service type (#8993) (@ffais) - Add support for NodePort service type (#8993) (@ffais)
- Published - 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) to release and docs (#9050) (@spikecurtis)
- Exposed everyone group through UI. You can now set - 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) group. (#9117) (@sreya)
- Workspace build errors are shown as a tooltip (#9029) (@BrunoQuaresma) - Workspace build errors are shown as a tooltip (#9029) (@BrunoQuaresma)
- Add build log history to the build log page (#9150) (@BrunoQuaresma) - Add build log history to the build log page (#9150) (@BrunoQuaresma)
@ -71,6 +71,6 @@
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

8
docs/changelogs/v2.1.1.md
View File

@ -8,12 +8,12 @@
> You can use `last_used_before` and `last_used_after` in the workspaces > You can use `last_used_before` and `last_used_after` in the workspaces
> search with [RFC3339Nano](https://www.rfc-editor.org/rfc/rfc3339) datetime > search with [RFC3339Nano](https://www.rfc-editor.org/rfc/rfc3339) datetime
- Add `daily_cost`` to `coder ls` to show - 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) (@ammario)
- Added `coder_app` usage to template insights (#9138) (@mafredri) - Added `coder_app` usage to template insights (#9138) (@mafredri)
![code-server usage](https://user-images.githubusercontent.com/22407953/262412524-180390de-b1a9-4d57-8473-c8774ec3fd6e.png) ![code-server usage](https://user-images.githubusercontent.com/22407953/262412524-180390de-b1a9-4d57-8473-c8774ec3fd6e.png)
- Added documentation for - 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 This enterprise feature can be used to log all system-level processes in
workspaces. (#9002) (@deansheather) workspaces. (#9002) (@deansheather)
@ -44,6 +44,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

4
docs/changelogs/v2.1.2.md
View File

@ -27,6 +27,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

6
docs/changelogs/v2.1.3.md
View File

@ -14,7 +14,7 @@
### Documentation ### Documentation
- Explain - 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) for workspace builds (#9297) (@mtojek)
Compare: Compare:
@ -26,6 +26,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

4
docs/changelogs/v2.1.4.md
View File

@ -36,6 +36,6 @@ Compare:
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

8
docs/changelogs/v2.1.5.md
View File

@ -11,7 +11,7 @@
- You can install Coder with - You can install Coder with
[Homebrew](https://formulae.brew.sh/formula/coder#default) (#9414) (@aslilac). [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. also use Homebrew, if present on your machine.
- You can show/hide specific - You can show/hide specific
[display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps) [display apps](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#nested-schema-for-display_apps)
@ -52,7 +52,7 @@
### Documentation ### Documentation
- Add - 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) config steps (#9388) (@ericpaulsen)
- Describe - Describe
[dynamic options and locals for parameters](https://github.com/coder/coder/tree/main/examples/parameters-dynamic-options) [dynamic options and locals for parameters](https://github.com/coder/coder/tree/main/examples/parameters-dynamic-options)
@ -68,6 +68,6 @@
## Install/upgrade ## Install/upgrade
Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or Refer to our docs to [install](https://coder.com/docs/install) or
[upgrade](https://coder.com/docs/v2/latest/admin/upgrade) Coder, or use a [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a
release asset below. release asset below.

2
docs/changelogs/v2.10.0.md
View File

@ -127,4 +127,4 @@ Compare: [`v2.9.0...v2.10.0`](https://github.com/coder/coder/compare/v2.9.0...v2
## Install/upgrade ## 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
docs/changelogs/v2.2.0.md
View File

@ -73,4 +73,4 @@ Compare: [`v2.1.5...v2.2.0`](https://github.com/coder/coder/compare/v2.1.5...v2.
## Install/upgrade ## 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.

6
docs/changelogs/v2.2.1.md
View File

@ -8,7 +8,7 @@
- Users are now warned when renaming workspaces (#10023) (@aslilac) - Users are now warned when renaming workspaces (#10023) (@aslilac)
- Add reverse tunnelling SSH support for unix sockets (#9976) (@monika-canva) - 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) - 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 support for weekly active data on template insights (#9997) (@BrunoQuaresma)
![Weekly active users graph](https://user-images.githubusercontent.com/22407953/272647853-e9d6ca3e-aca4-4897-9be0-15475097d3a6.png) ![Weekly active users graph](https://user-images.githubusercontent.com/22407953/272647853-e9d6ca3e-aca4-4897-9be0-15475097d3a6.png)
- Add weekly user activity on template insights page (#10013) (@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) - Add checks for preventing HSL colors from entering React state (#9893) (@Parkreiner)
- Fix TestCreateValidateRichParameters/ValidateString (#9928) (@mtojek) - Fix TestCreateValidateRichParameters/ValidateString (#9928) (@mtojek)
- Pass `OnSubscribe` to HA MultiAgent (#9947) (@coadler) - 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) - Remove exp scaletest from slim binary (#9934) (@johnstcn)
- Fetch workspace agent scripts and log sources using system auth ctx (#10043) (@johnstcn) - Fetch workspace agent scripts and log sources using system auth ctx (#10043) (@johnstcn)
- Fix typo in pgDump (#10033) (@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 ## 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.

6
docs/changelogs/v2.3.0.md
View File

@ -8,8 +8,8 @@
- Add "Create Workspace" button to the workspaces page (#10011) (@Parkreiner) - 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" /> <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). - 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/v2/latest/enterprise). > This is an [Enterprise feature](https://coder.com/docs/enterprise).
- Show descriptions for parameter options (#10068) (@aslilac) - 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" /> <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) - 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 ## 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
docs/changelogs/v2.3.1.md
View File

@ -46,4 +46,4 @@ Compare: [`v2.3.0...v2.3.1`](https://github.com/coder/coder/compare/v2.3.0...v2.
## Install/upgrade ## 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
docs/changelogs/v2.3.2.md
View File

@ -34,4 +34,4 @@ Compare: [`v2.3.1...v2.3.2`](https://github.com/coder/coder/compare/v2.3.1...v2.
## Install/upgrade ## 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
docs/changelogs/v2.3.3.md
View File

@ -40,4 +40,4 @@ Compare: [`v2.3.2...v2.3.3`](https://github.com/coder/coder/compare/v2.3.2...v2.
## Install/upgrade ## 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
docs/changelogs/v2.4.0.md
View File

@ -131,4 +131,4 @@ Compare: [`v2.3.3...v2.4.0`](https://github.com/coder/coder/compare/v2.3.3...v2.
## Install/upgrade ## 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.

6
docs/changelogs/v2.5.0.md
View File

@ -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) - Templates can now be deprecated in "template settings" to warn new users and prevent new workspaces from being created (#10745) (@Emyrk)
![Deprecated template](https://gist.github.com/assets/22407953/5883ff54-11a6-4af0-afd3-ad77be1c4dc2) ![Deprecated template](https://gist.github.com/assets/22407953/5883ff54-11a6-4af0-afd3-ad77be1c4dc2)
> 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) - Add user/settings page for managing external auth (#10945) (@Emyrk)
![External auth settings](https://gist.github.com/assets/22407953/99252719-7255-426e-ba88-55d08dd04586) ![External auth settings](https://gist.github.com/assets/22407953/99252719-7255-426e-ba88-55d08dd04586)
- Allow auditors to read template insights (#10860) (@johnstcn) - Allow auditors to read template insights (#10860) (@johnstcn)
@ -16,7 +16,7 @@
- Dormant workspaces now appear in the default workspaces list (#11053) (@sreya) - Dormant workspaces now appear in the default workspaces list (#11053) (@sreya)
- Include server agent API version in buildinfo (#11057) (@spikecurtis) - Include server agent API version in buildinfo (#11057) (@spikecurtis)
- Restart stopped workspaces on `coder ssh` command (#11050) (@Emyrk) - 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) - 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) - Add support for `coder_env` resource to set environment variables within a workspace (#11102) (@mafredri)
- Handle session signals (#10842) (@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 ## 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
docs/changelogs/v2.5.1.md
View File

@ -29,4 +29,4 @@ Compare: [`v2.5.0...v2.5.1`](https://github.com/coder/coder/compare/v2.5.0...v2.
## Install/upgrade ## 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.

6
docs/changelogs/v2.6.0.md
View File

@ -2,13 +2,13 @@
### BREAKING CHANGES ### 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 ### Features
- Allow templates to specify max_ttl or autostop_requirement (#10920) (@deansheather) - Allow templates to specify max_ttl or autostop_requirement (#10920) (@deansheather)
- Add server flag to disable user custom quiet hours (#11124) (@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) - Add light theme (preview) (#11266) (@aslilac)
![Light theme preview](https://raw.githubusercontent.com/coder/coder/main/docs/changelogs/images/light-theme.png) ![Light theme preview](https://raw.githubusercontent.com/coder/coder/main/docs/changelogs/images/light-theme.png)
- Enable CSRF token header (#11283) (@Emyrk) - 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 ## 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
docs/changelogs/v2.6.1.md
View File

@ -17,4 +17,4 @@ Compare: [`v2.6.0...v2.6.1`](https://github.com/coder/coder/compare/v2.6.0...v2.
## Install/upgrade ## 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.

6
docs/changelogs/v2.7.0.md
View File

@ -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) - 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) - 🧹 Workspace Cleanup: Coder can flag or even auto-delete workspaces that are not in use (#11427) (@sreya)
![Workspace cleanup](http://raw.githubusercontent.com/coder/coder/main/docs/changelogs/images/workspace-cleanup.png) ![Workspace cleanup](http://raw.githubusercontent.com/coder/coder/main/docs/changelogs/images/workspace-cleanup.png)
> 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 a character counter for fields with length limits (#11558) (@aslilac)
- Add markdown support for template deprecation messages (#11562) (@aslilac) - Add markdown support for template deprecation messages (#11562) (@aslilac)
- Add support for loading template variables from tfvars files (#11549) (@mtojek) - 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) - Allow custom icons in the "support links" navbar (#11629) (@mtojek)
![Custom icons](https://i.imgur.com/FvJ8mFH.png) ![Custom icons](https://i.imgur.com/FvJ8mFH.png)
- Add additional fields to first time setup trial flow (#11533) (@coadler) - 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 ## 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
docs/changelogs/v2.7.1.md
View File

@ -14,4 +14,4 @@ Compare: [`v2.7.0...v2.7.1`](https://github.com/coder/coder/compare/v2.7.0...v2.
## Install/upgrade ## 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
docs/changelogs/v2.7.2.md
View File

@ -12,4 +12,4 @@ Compare: [`v2.7.1...v2.7.2`](https://github.com/coder/coder/compare/v2.7.0...v2.
## Install/upgrade ## 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
docs/changelogs/v2.7.3.md
View File

@ -17,4 +17,4 @@ Compare: [`v2.7.2...v2.7.3`](https://github.com/coder/coder/compare/v2.7.2...v2.
## Install/upgrade ## 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
docs/changelogs/v2.8.0.md
View File

@ -104,4 +104,4 @@ Compare: [`v2.7.2...v2.7.3`](https://github.com/coder/coder/compare/v2.7.2...v2.
## Install/upgrade ## 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
docs/changelogs/v2.8.2.md
View File

@ -12,4 +12,4 @@ Compare: [`v2.8.1...v2.8.2`](https://github.com/coder/coder/compare/v2.8.1...v2.
## Install/upgrade ## 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
docs/changelogs/v2.8.4.md
View File

@ -17,4 +17,4 @@ Compare: [`v2.8.3...v2.8.4`](https://github.com/coder/coder/compare/v2.8.3...v2.
## Install/upgrade ## 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
docs/changelogs/v2.9.0.md
View File

@ -61,7 +61,7 @@
### Experimental features ### 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) - 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) - 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 ## 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.

25
docs/faqs.md
View File

@ -37,7 +37,7 @@ The primary developer use case is a local IDE connecting over SSH to a Coder
workspace. workspace.
Coder's networking stack has intelligence to attempt a peer-to-peer or 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 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 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 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 Setting the following flags as shown disables this logic to simplify
troubleshooting. troubleshooting.
| Flag | Value | Meaning | | Flag | Value | Meaning |
| -------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- | | ---------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/v2/latest/cli/server#--block-direct-connections) | `true` | Blocks direct connections | | [`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/v2/latest/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN | | [`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/v2/latest/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP | | [`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? ### 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 important concept to understand is that Coder creates workspaces which have
an agent that must be able to reach the `coder server`. an agent that must be able to reach the `coder server`.
If the If the [`CODER_ACCESS_URL`](https://coder.com/docs/admin/configure#access-url)
[`CODER_ACCESS_URL`](https://coder.com/docs/v2/latest/admin/configure#access-url)
is not accessible from a workspace, the workspace may build, but the agent 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. 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. occurs because the Terraform state will not be in sync with the new template.
However, a lesser-known CLI sub-command, However, a lesser-known CLI sub-command,
[`coder update`](https://coder.com/docs/v2/latest/cli/update), can resolve this [`coder update`](https://coder.com/docs/cli/update), can resolve this issue.
issue. This command re-prompts users to re-enter the input variables, This command re-prompts users to re-enter the input variables, potentially
potentially saving the workspace from a failed status. saving the workspace from a failed status.
```sh ```sh
coder update --always-prompt <workspace name> 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 6117](https://github.com/coder/coder/issues/6117)
- [Public Github Issue 5677](https://github.com/coder/coder/issues/5677) - [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)? ### Can I run Coder in an air-gapped or offline mode? (no Internet)?
Yes, Coder can be deployed in air-gapped or offline mode. 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 Our product bundles with the Terraform binary so assume access to terraform.io
during installation. The docs outline rebuilding the Coder container with during installation. The docs outline rebuilding the Coder container with

10
docs/guides/artifactory-integration.md
View File

@ -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 This module is usable by JFrog self-hosted (on-premises) Artifactory as it
requires configuring a custom integration. This integration benefits from requires configuring a custom integration. This integration benefits from
Coder's [external-auth](https://coder.com/docs/v2/latest/admin/external-auth) Coder's [external-auth](https://coder.com/docs/admin/external-auth) feature and
feature and allows each user to authenticate with Artifactory using an OAuth allows each user to authenticate with Artifactory using an OAuth flow and issues
flow and issues user-scoped tokens to each user. user-scoped tokens to each user.
To set this up, follow these steps: To set this up, follow these steps:
@ -72,8 +72,8 @@ artifactory:
![JFrog Platform new integration](../images/guides/artifactory-integration/jfrog-oauth-app.png) ![JFrog Platform new integration](../images/guides/artifactory-integration/jfrog-oauth-app.png)
3. Add a new 3. Add a new
[external authentication](https://coder.com/docs/v2/latest/admin/external-auth) [external authentication](https://coder.com/docs/admin/external-auth) to
to Coder by setting these env variables, Coder by setting these env variables,
```env ```env
# JFrog Artifactory External Auth # JFrog Artifactory External Auth

8
docs/guides/configuring-okta.md
View File

@ -16,7 +16,7 @@ December 13, 2023
To configure custom claims in Okta to support syncing roles and groups with To configure custom claims in Okta to support syncing roles and groups with
Coder, you must first have setup an Okta application 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 From here, we will add additional claims for Coder to use for syncing groups and
roles. roles.
@ -39,14 +39,14 @@ be sent.
> !! If the user does not belong to any groups, the claim will not be sent. Make > !! 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 > sure the user authenticating for testing is in at least 1 group. Defer to
> [troubleshooting](https://coder.com/docs/v2/latest/admin/auth#troubleshooting) > [troubleshooting](https://coder.com/docs/admin/auth#troubleshooting) with
> with issues > issues
![Okta OpenID Connect ID Token](../images/guides/okta/oidc_id_token.png) ![Okta OpenID Connect ID Token](../images/guides/okta/oidc_id_token.png)
Configure Coder to use these claims for group sync. These claims are present in 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 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 ```bash
# Add the 'groups' scope. # Add the 'groups' scope.

8
docs/guides/example-guide.md
View File

@ -11,14 +11,14 @@ December 13, 2023
--- ---
This is a guide on how to make Coder guides, it is not listed on our 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. [official guides page](https://coder.com/docs/guides) in the docs. Intended for
Intended for those who don't frequently contribute documentation changes to the those who don't frequently contribute documentation changes to the `coder/coder`
`coder/coder` repository. repository.
## Content ## Content
Defer to our 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. page for rules on technical writing.
### Adding Photos ### Adding Photos

2
docs/guides/index.md
View File

@ -6,5 +6,5 @@ Enterprise. These tutorials are hosted on our
request new topics to be covered. request new topics to be covered.
<children> <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> </children>

5
docs/guides/xray-integration.md
View File

@ -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) [permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
for the repositories you want to scan. for the repositories you want to scan.
2. Create a Coder 2. Create a Coder
[token](https://coder.com/docs/v2/latest/cli/tokens_create#tokens-create) [token](https://coder.com/docs/cli/tokens_create#tokens-create) with a user
with a user that has the that has the [`owner`](https://coder.com/docs/admin/users#roles) role.
[`owner`](https://coder.com/docs/v2/latest/admin/users#roles) role.
3. Create kubernetes secrets for the JFrog Xray and Coder tokens. 3. Create kubernetes secrets for the JFrog Xray and Coder tokens.
```bash ```bash

8
docs/ides/web-ides.md
View File

@ -224,9 +224,9 @@ resource "coder_app" "jupyter" {
``` ```
If you cannot enable a 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 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 running an app on a path and the template code is more complicated with coder
value substitution to recreate the path structure. value substitution to recreate the path structure.
@ -271,10 +271,10 @@ resource "coder_app" "rstudio" {
``` ```
If you cannot enable a 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 you can configure the template to run RStudio on a path using an NGINX reverse
proxy in the template. There is however 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 running an app on a path and the template code is more complicated with coder
value substitution to recreate the path structure. value substitution to recreate the path structure.

6
docs/install/1-click.md
View File

@ -3,9 +3,9 @@ Coder can be installed on many cloud providers using our
| Platform Name | Status | Documentation | Deploy | | 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 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/v2/latest/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) | | 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/v2/latest/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) | | 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) | | 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) | [![Deploy Coder on Railway](https://railway.app/button.svg)](https://railway.app/template/coder?referralCode=tfH8Uw) | | Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [![Deploy Coder on Railway](https://railway.app/button.svg)](https://railway.app/template/coder?referralCode=tfH8Uw) |
| Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/README.md) | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) | | Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/README.md) | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) |

2
docs/platforms/docker.md
View File

@ -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) [remote host](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs#remote-hosts)
over SSH or TCP. over SSH or TCP.
2. Running an 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. on the remote docker host.
## Troubleshooting ## Troubleshooting

6
docs/security/0001_user_apikeys_invalidation.md
View File

@ -82,6 +82,6 @@ Otherwise, the following information will be reported:
- Time the affected API key was last used - Time the affected API key was last used
> 💡 If your license includes the > 💡 If your license includes the
> [Audit Logs](https://coder.com/docs/v2/latest/admin/audit-logs#filtering-logs) > [Audit Logs](https://coder.com/docs/admin/audit-logs#filtering-logs) feature,
> feature, you can then query all actions performed by the above users by using > you can then query all actions performed by the above users by using the
> the filter `email:$USER_EMAIL`. > filter `email:$USER_EMAIL`.

2
enterprise/coderd/coderd.go
View File

@ -97,7 +97,7 @@ func New(ctx context.Context, options *Options) (_ *API, err error) {
// This is a fatal error. // This is a fatal error.
var derr *dbcrypt.DecryptFailedError var derr *dbcrypt.DecryptFailedError
if xerrors.As(err, &derr) { if xerrors.As(err, &derr) {
return nil, xerrors.Errorf("database encrypted with unknown key, either add the key or see https://coder.com/docs/v2/latest/admin/encryption#disabling-encryption: %w", derr) return nil, xerrors.Errorf("database encrypted with unknown key, either add the key or see https://coder.com/docs/admin/encryption#disabling-encryption: %w", derr)
} }
return nil, xerrors.Errorf("init database encryption: %w", err) return nil, xerrors.Errorf("init database encryption: %w", err)
} }

16
examples/examples.gen.json
View File

@ -13,7 +13,7 @@
"persistent", "persistent",
"devcontainer" "devcontainer"
], ],
"markdown": "\n# Remote Development on AWS EC2 VMs using a Devcontainer\n\nProvision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/v2/latest) with this example template.\n![Architecture Diagram](./architecture.svg)\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nBy default, this template authenticates to AWS using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).\n\nThe simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.\n\nTo use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.\n\n## Required permissions / policy\n\nThe following sample policy allows Coder to create EC2 instances and modify\ninstances provisioned by Coder:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:GetDefaultCreditSpecification\",\n \"ec2:DescribeIamInstanceProfileAssociations\",\n \"ec2:DescribeTags\",\n \"ec2:DescribeInstances\",\n \"ec2:DescribeInstanceTypes\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:DescribeInstanceCreditSpecifications\",\n \"ec2:DescribeImages\",\n \"ec2:ModifyDefaultCreditSpecification\",\n \"ec2:DescribeVolumes\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"CoderResources\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:DescribeInstanceAttribute\",\n \"ec2:UnmonitorInstances\",\n \"ec2:TerminateInstances\",\n \"ec2:StartInstances\",\n \"ec2:StopInstances\",\n \"ec2:DeleteTags\",\n \"ec2:MonitorInstances\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:ModifyInstanceAttribute\",\n \"ec2:ModifyInstanceCreditSpecification\"\n ],\n \"Resource\": \"arn:aws:ec2:*:*:instance/*\",\n \"Condition\": {\n \"StringEquals\": {\n \"aws:ResourceTag/Coder_Provisioned\": \"true\"\n }\n }\n }\n ]\n}\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- AWS Instance\n\nCoder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the [`code-server`](https://registry.coder.com/modules/code-server) registry module. For a list of all modules and templates pplease check [Coder Registry](https://registry.coder.com).\n" "markdown": "\n# Remote Development on AWS EC2 VMs using a Devcontainer\n\nProvision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs) with this example template.\n![Architecture Diagram](./architecture.svg)\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nBy default, this template authenticates to AWS using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).\n\nThe simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.\n\nTo use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.\n\n## Required permissions / policy\n\nThe following sample policy allows Coder to create EC2 instances and modify\ninstances provisioned by Coder:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:GetDefaultCreditSpecification\",\n \"ec2:DescribeIamInstanceProfileAssociations\",\n \"ec2:DescribeTags\",\n \"ec2:DescribeInstances\",\n \"ec2:DescribeInstanceTypes\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:DescribeInstanceCreditSpecifications\",\n \"ec2:DescribeImages\",\n \"ec2:ModifyDefaultCreditSpecification\",\n \"ec2:DescribeVolumes\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"CoderResources\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:DescribeInstanceAttribute\",\n \"ec2:UnmonitorInstances\",\n \"ec2:TerminateInstances\",\n \"ec2:StartInstances\",\n \"ec2:StopInstances\",\n \"ec2:DeleteTags\",\n \"ec2:MonitorInstances\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:ModifyInstanceAttribute\",\n \"ec2:ModifyInstanceCreditSpecification\"\n ],\n \"Resource\": \"arn:aws:ec2:*:*:instance/*\",\n \"Condition\": {\n \"StringEquals\": {\n \"aws:ResourceTag/Coder_Provisioned\": \"true\"\n }\n }\n }\n ]\n}\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- AWS Instance\n\nCoder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the [`code-server`](https://registry.coder.com/modules/code-server) registry module. For a list of all modules and templates pplease check [Coder Registry](https://registry.coder.com).\n"
}, },
{ {
"id": "aws-linux", "id": "aws-linux",
@ -27,7 +27,7 @@
"aws", "aws",
"persistent-vm" "persistent-vm"
], ],
"markdown": "\n# Remote Development on AWS EC2 VMs (Linux)\n\nProvision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nBy default, this template authenticates to AWS using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).\n\nThe simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.\n\nTo use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.\n\n## Required permissions / policy\n\nThe following sample policy allows Coder to create EC2 instances and modify\ninstances provisioned by Coder:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:GetDefaultCreditSpecification\",\n \"ec2:DescribeIamInstanceProfileAssociations\",\n \"ec2:DescribeTags\",\n \"ec2:DescribeInstances\",\n \"ec2:DescribeInstanceTypes\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:DescribeInstanceCreditSpecifications\",\n \"ec2:DescribeImages\",\n \"ec2:ModifyDefaultCreditSpecification\",\n \"ec2:DescribeVolumes\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"CoderResources\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:DescribeInstanceAttribute\",\n \"ec2:UnmonitorInstances\",\n \"ec2:TerminateInstances\",\n \"ec2:StartInstances\",\n \"ec2:StopInstances\",\n \"ec2:DeleteTags\",\n \"ec2:MonitorInstances\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:ModifyInstanceAttribute\",\n \"ec2:ModifyInstanceCreditSpecification\"\n ],\n \"Resource\": \"arn:aws:ec2:*:*:instance/*\",\n \"Condition\": {\n \"StringEquals\": {\n \"aws:ResourceTag/Coder_Provisioned\": \"true\"\n }\n }\n }\n ]\n}\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- AWS Instance\n\nCoder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the `startup_script` argument in the `coder_agent`\nresource block. The `coder_app` resource is defined to access `code-server` through\nthe dashboard UI over `localhost:13337`.\n" "markdown": "\n# Remote Development on AWS EC2 VMs (Linux)\n\nProvision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nBy default, this template authenticates to AWS using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).\n\nThe simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.\n\nTo use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.\n\n## Required permissions / policy\n\nThe following sample policy allows Coder to create EC2 instances and modify\ninstances provisioned by Coder:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:GetDefaultCreditSpecification\",\n \"ec2:DescribeIamInstanceProfileAssociations\",\n \"ec2:DescribeTags\",\n \"ec2:DescribeInstances\",\n \"ec2:DescribeInstanceTypes\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:DescribeInstanceCreditSpecifications\",\n \"ec2:DescribeImages\",\n \"ec2:ModifyDefaultCreditSpecification\",\n \"ec2:DescribeVolumes\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"CoderResources\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:DescribeInstanceAttribute\",\n \"ec2:UnmonitorInstances\",\n \"ec2:TerminateInstances\",\n \"ec2:StartInstances\",\n \"ec2:StopInstances\",\n \"ec2:DeleteTags\",\n \"ec2:MonitorInstances\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:ModifyInstanceAttribute\",\n \"ec2:ModifyInstanceCreditSpecification\"\n ],\n \"Resource\": \"arn:aws:ec2:*:*:instance/*\",\n \"Condition\": {\n \"StringEquals\": {\n \"aws:ResourceTag/Coder_Provisioned\": \"true\"\n }\n }\n }\n ]\n}\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- AWS Instance\n\nCoder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the `startup_script` argument in the `coder_agent`\nresource block. The `coder_app` resource is defined to access `code-server` through\nthe dashboard UI over `localhost:13337`.\n"
}, },
{ {
"id": "aws-windows", "id": "aws-windows",
@ -40,7 +40,7 @@
"windows", "windows",
"aws" "aws"
], ],
"markdown": "\n# Remote Development on AWS EC2 VMs (Windows)\n\nProvision AWS EC2 Windows VMs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nBy default, this template authenticates to AWS with using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).\n\nThe simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.\n\nTo use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.\n\n## Required permissions / policy\n\nThe following sample policy allows Coder to create EC2 instances and modify\ninstances provisioned by Coder:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:GetDefaultCreditSpecification\",\n \"ec2:DescribeIamInstanceProfileAssociations\",\n \"ec2:DescribeTags\",\n \"ec2:DescribeInstances\",\n \"ec2:DescribeInstanceTypes\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:DescribeInstanceCreditSpecifications\",\n \"ec2:DescribeImages\",\n \"ec2:ModifyDefaultCreditSpecification\",\n \"ec2:DescribeVolumes\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"CoderResources\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:DescribeInstanceAttribute\",\n \"ec2:UnmonitorInstances\",\n \"ec2:TerminateInstances\",\n \"ec2:StartInstances\",\n \"ec2:StopInstances\",\n \"ec2:DeleteTags\",\n \"ec2:MonitorInstances\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:ModifyInstanceAttribute\",\n \"ec2:ModifyInstanceCreditSpecification\"\n ],\n \"Resource\": \"arn:aws:ec2:*:*:instance/*\",\n \"Condition\": {\n \"StringEquals\": {\n \"aws:ResourceTag/Coder_Provisioned\": \"true\"\n }\n }\n }\n ]\n}\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- AWS Instance\n\nCoder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the `startup_script` argument in the `coder_agent`\nresource block. The `coder_app` resource is defined to access `code-server` through\nthe dashboard UI over `localhost:13337`.\n" "markdown": "\n# Remote Development on AWS EC2 VMs (Windows)\n\nProvision AWS EC2 Windows VMs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nBy default, this template authenticates to AWS with using the provider's default [authentication methods](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication-and-configuration).\n\nThe simplest way (without making changes to the template) is via environment variables (e.g. `AWS_ACCESS_KEY_ID`) or a [credentials file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-format). If you are running Coder on a VM, this file must be in `/home/coder/aws/credentials`.\n\nTo use another [authentication method](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#authentication), edit the template.\n\n## Required permissions / policy\n\nThe following sample policy allows Coder to create EC2 instances and modify\ninstances provisioned by Coder:\n\n```json\n{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"VisualEditor0\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:GetDefaultCreditSpecification\",\n \"ec2:DescribeIamInstanceProfileAssociations\",\n \"ec2:DescribeTags\",\n \"ec2:DescribeInstances\",\n \"ec2:DescribeInstanceTypes\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:DescribeInstanceCreditSpecifications\",\n \"ec2:DescribeImages\",\n \"ec2:ModifyDefaultCreditSpecification\",\n \"ec2:DescribeVolumes\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"CoderResources\",\n \"Effect\": \"Allow\",\n \"Action\": [\n \"ec2:DescribeInstanceAttribute\",\n \"ec2:UnmonitorInstances\",\n \"ec2:TerminateInstances\",\n \"ec2:StartInstances\",\n \"ec2:StopInstances\",\n \"ec2:DeleteTags\",\n \"ec2:MonitorInstances\",\n \"ec2:CreateTags\",\n \"ec2:RunInstances\",\n \"ec2:ModifyInstanceAttribute\",\n \"ec2:ModifyInstanceCreditSpecification\"\n ],\n \"Resource\": \"arn:aws:ec2:*:*:instance/*\",\n \"Condition\": {\n \"StringEquals\": {\n \"aws:ResourceTag/Coder_Provisioned\": \"true\"\n }\n }\n }\n ]\n}\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- AWS Instance\n\nCoder uses `aws_ec2_instance_state` to start and stop the VM. This example template is fully persistent, meaning the full filesystem is preserved when the workspace restarts. See this [community example](https://github.com/bpmct/coder-templates/tree/main/aws-linux-ephemeral) of an ephemeral AWS instance.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the `startup_script` argument in the `coder_agent`\nresource block. The `coder_app` resource is defined to access `code-server` through\nthe dashboard UI over `localhost:13337`.\n"
}, },
{ {
"id": "azure-linux", "id": "azure-linux",
@ -53,7 +53,7 @@
"linux", "linux",
"azure" "azure"
], ],
"markdown": "\n# Remote Development on Azure VMs (Linux)\n\nProvision Azure Linux VMs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nThis template assumes that coderd is run in an environment that is authenticated\nwith Azure. For example, run `az login` then `az account set --subscription=\u003cid\u003e`\nto import credentials on the system and user running coderd. For other ways to\nauthenticate, [consult the Terraform docs](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs#authenticating-to-azure).\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Azure VM (ephemeral, deleted on stop)\n- Managed disk (persistent, mounted to `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script). Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the `startup_script` argument in the `coder_agent`\nresource block. The `coder_app` resource is defined to access `code-server` through\nthe dashboard UI over `localhost:13337`.\n" "markdown": "\n# Remote Development on Azure VMs (Linux)\n\nProvision Azure Linux VMs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Authentication\n\nThis template assumes that coderd is run in an environment that is authenticated\nwith Azure. For example, run `az login` then `az account set --subscription=\u003cid\u003e`\nto import credentials on the system and user running coderd. For other ways to\nauthenticate, [consult the Terraform docs](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs#authenticating-to-azure).\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Azure VM (ephemeral, deleted on stop)\n- Managed disk (persistent, mounted to `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script). Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## code-server\n\n`code-server` is installed via the `startup_script` argument in the `coder_agent`\nresource block. The `coder_app` resource is defined to access `code-server` through\nthe dashboard UI over `localhost:13337`.\n"
}, },
{ {
"id": "do-linux", "id": "do-linux",
@ -66,7 +66,7 @@
"linux", "linux",
"digitalocean" "digitalocean"
], ],
"markdown": "\n# Remote Development on DigitalOcean Droplets\n\nProvision DigitalOcean Droplets as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\nTo deploy workspaces as DigitalOcean Droplets, you'll need:\n\n- DigitalOcean [personal access token (PAT)](https://docs.digitalocean.com/reference/api/create-personal-access-token/)\n\n- DigitalOcean project ID (you can get your project information via the `doctl`\n CLI by running `doctl projects list`)\n\n- Remove the following sections from the `main.tf` file if you don't want to\n associate your workspaces with a project:\n\n - `variable \"step2_do_project_id\"`\n - `resource \"digitalocean_project_resources\" \"project\"`\n\n- **Optional:** DigitalOcean SSH key ID (obtain via the `doctl` CLI by running\n `doctl compute ssh-key list`)\n\n- Note that this is only required for Fedora images to work.\n\n### Authentication\n\nThis template assumes that coderd is run in an environment that is authenticated\nwith Digital Ocean. Obtain a [Digital Ocean Personal Access\nToken](https://cloud.digitalocean.com/account/api/tokens) and set the\nenvironment variable `DIGITALOCEAN_TOKEN` to the access token before starting\ncoderd. For other ways to authenticate [consult the Terraform docs](https://registry.terraform.io/providers/digitalocean/digitalocean/latest/docs).\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Azure VM (ephemeral, deleted on stop)\n- Managed disk (persistent, mounted to `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script).\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n" "markdown": "\n# Remote Development on DigitalOcean Droplets\n\nProvision DigitalOcean Droplets as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\nTo deploy workspaces as DigitalOcean Droplets, you'll need:\n\n- DigitalOcean [personal access token (PAT)](https://docs.digitalocean.com/reference/api/create-personal-access-token/)\n\n- DigitalOcean project ID (you can get your project information via the `doctl`\n CLI by running `doctl projects list`)\n\n- Remove the following sections from the `main.tf` file if you don't want to\n associate your workspaces with a project:\n\n - `variable \"step2_do_project_id\"`\n - `resource \"digitalocean_project_resources\" \"project\"`\n\n- **Optional:** DigitalOcean SSH key ID (obtain via the `doctl` CLI by running\n `doctl compute ssh-key list`)\n\n- Note that this is only required for Fedora images to work.\n\n### Authentication\n\nThis template assumes that coderd is run in an environment that is authenticated\nwith Digital Ocean. Obtain a [Digital Ocean Personal Access\nToken](https://cloud.digitalocean.com/account/api/tokens) and set the\nenvironment variable `DIGITALOCEAN_TOKEN` to the access token before starting\ncoderd. For other ways to authenticate [consult the Terraform docs](https://registry.terraform.io/providers/digitalocean/digitalocean/latest/docs).\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Azure VM (ephemeral, deleted on stop)\n- Managed disk (persistent, mounted to `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script).\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n"
}, },
{ {
"id": "docker", "id": "docker",
@ -78,7 +78,7 @@
"docker", "docker",
"container" "container"
], ],
"markdown": "\n# Remote Development on Docker Containers\n\nProvision Docker containers as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Infrastructure\n\nThe VM you run Coder on must have a running Docker socket and the `coder` user must be added to the Docker group:\n\n```sh\n# Add coder user to Docker group\nsudo adduser coder docker\n\n# Restart Coder server\nsudo systemctl restart coder\n\n# Test Docker\nsudo -u coder docker ps\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Docker image (built by Docker socket and kept locally)\n- Docker container pod (ephemeral)\n- Docker volume (persistent on `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n### Editing the image\n\nEdit the `Dockerfile` and run `coder templates push` to update workspaces.\n" "markdown": "\n# Remote Development on Docker Containers\n\nProvision Docker containers as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Infrastructure\n\nThe VM you run Coder on must have a running Docker socket and the `coder` user must be added to the Docker group:\n\n```sh\n# Add coder user to Docker group\nsudo adduser coder docker\n\n# Restart Coder server\nsudo systemctl restart coder\n\n# Test Docker\nsudo -u coder docker ps\n```\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Docker image (built by Docker socket and kept locally)\n- Docker container pod (ephemeral)\n- Docker volume (persistent on `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n### Editing the image\n\nEdit the `Dockerfile` and run `coder templates push` to update workspaces.\n"
}, },
{ {
"id": "gcp-devcontainer", "id": "gcp-devcontainer",
@ -143,7 +143,7 @@
"kubernetes", "kubernetes",
"container" "container"
], ],
"markdown": "\n# Remote Development on Kubernetes Pods\n\nProvision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Infrastructure\n\n**Cluster**: This template requires an existing Kubernetes cluster\n\n**Container Image**: This template uses the [codercom/enterprise-base:ubuntu image](https://github.com/coder/enterprise-images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself.\n\n### Authentication\n\nThis template authenticates using a `~/.kube/config`, if present on the server, or via built-in authentication if the Coder provisioner is running on Kubernetes with an authorized ServiceAccount. To use another [authentication method](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs#authentication), edit the template.\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Kubernetes pod (ephemeral)\n- Kubernetes persistent volume claim (persistent on `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n" "markdown": "\n# Remote Development on Kubernetes Pods\n\nProvision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n## Prerequisites\n\n### Infrastructure\n\n**Cluster**: This template requires an existing Kubernetes cluster\n\n**Container Image**: This template uses the [codercom/enterprise-base:ubuntu image](https://github.com/coder/enterprise-images/tree/main/images/base) with some dev tools preinstalled. To add additional tools, extend this image or build it yourself.\n\n### Authentication\n\nThis template authenticates using a `~/.kube/config`, if present on the server, or via built-in authentication if the Coder provisioner is running on Kubernetes with an authorized ServiceAccount. To use another [authentication method](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs#authentication), edit the template.\n\n## Architecture\n\nThis template provisions the following resources:\n\n- Kubernetes pod (ephemeral)\n- Kubernetes persistent volume claim (persistent on `/home/coder`)\n\nThis means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n"
}, },
{ {
"id": "nomad-docker", "id": "nomad-docker",
@ -155,7 +155,7 @@
"nomad", "nomad",
"container" "container"
], ],
"markdown": "\n# Remote Development on Nomad\n\nProvision Nomad Jobs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## Prerequisites\n\n- [Nomad](https://www.nomadproject.io/downloads)\n- [Docker](https://docs.docker.com/get-docker/)\n\n## Setup\n\n### 1. Start the CSI Host Volume Plugin\n\nThe CSI Host Volume plugin is used to mount host volumes into Nomad tasks. This is useful for development environments where you want to mount persistent volumes into your container workspace.\n\n1. Login to the Nomad server using SSH.\n\n2. Append the following stanza to your Nomad server configuration file and restart the nomad service.\n\n ```hcl\n plugin \"docker\" {\n config {\n allow_privileged = true\n }\n }\n ```\n\n ```shell\n sudo systemctl restart nomad\n ```\n\n3. Create a file `hostpath.nomad` with following content:\n\n ```hcl\n job \"hostpath-csi-plugin\" {\n datacenters = [\"dc1\"]\n type = \"system\"\n\n group \"csi\" {\n task \"plugin\" {\n driver = \"docker\"\n\n config {\n image = \"registry.k8s.io/sig-storage/hostpathplugin:v1.10.0\"\n\n args = [\n \"--drivername=csi-hostpath\",\n \"--v=5\",\n \"--endpoint=${CSI_ENDPOINT}\",\n \"--nodeid=node-${NOMAD_ALLOC_INDEX}\",\n ]\n\n privileged = true\n }\n\n csi_plugin {\n id = \"hostpath\"\n type = \"monolith\"\n mount_dir = \"/csi\"\n }\n\n resources {\n cpu = 256\n memory = 128\n }\n }\n }\n }\n ```\n\n4. Run the job:\n\n ```shell\n nomad job run hostpath.nomad\n ```\n\n### 2. Setup the Nomad Template\n\n1. Create the template by running the following command:\n\n ```shell\n coder template init nomad-docker\n cd nomad-docker\n coder template push\n ```\n\n2. Set up Nomad server address and optional authentication:\n\n3. Create a new workspace and start developing.\n" "markdown": "\n# Remote Development on Nomad\n\nProvision Nomad Jobs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template. This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes.\n\n\u003c!-- TODO: Add screenshot --\u003e\n\n\u003e **Note**\n\u003e This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.\n\n## Prerequisites\n\n- [Nomad](https://www.nomadproject.io/downloads)\n- [Docker](https://docs.docker.com/get-docker/)\n\n## Setup\n\n### 1. Start the CSI Host Volume Plugin\n\nThe CSI Host Volume plugin is used to mount host volumes into Nomad tasks. This is useful for development environments where you want to mount persistent volumes into your container workspace.\n\n1. Login to the Nomad server using SSH.\n\n2. Append the following stanza to your Nomad server configuration file and restart the nomad service.\n\n ```hcl\n plugin \"docker\" {\n config {\n allow_privileged = true\n }\n }\n ```\n\n ```shell\n sudo systemctl restart nomad\n ```\n\n3. Create a file `hostpath.nomad` with following content:\n\n ```hcl\n job \"hostpath-csi-plugin\" {\n datacenters = [\"dc1\"]\n type = \"system\"\n\n group \"csi\" {\n task \"plugin\" {\n driver = \"docker\"\n\n config {\n image = \"registry.k8s.io/sig-storage/hostpathplugin:v1.10.0\"\n\n args = [\n \"--drivername=csi-hostpath\",\n \"--v=5\",\n \"--endpoint=${CSI_ENDPOINT}\",\n \"--nodeid=node-${NOMAD_ALLOC_INDEX}\",\n ]\n\n privileged = true\n }\n\n csi_plugin {\n id = \"hostpath\"\n type = \"monolith\"\n mount_dir = \"/csi\"\n }\n\n resources {\n cpu = 256\n memory = 128\n }\n }\n }\n }\n ```\n\n4. Run the job:\n\n ```shell\n nomad job run hostpath.nomad\n ```\n\n### 2. Setup the Nomad Template\n\n1. Create the template by running the following command:\n\n ```shell\n coder template init nomad-docker\n cd nomad-docker\n coder template push\n ```\n\n2. Set up Nomad server address and optional authentication:\n\n3. Create a new workspace and start developing.\n"
}, },
{ {
"id": "scratch", "id": "scratch",

2
examples/parameters-dynamic-options/README.md
View File

@ -7,7 +7,7 @@ icon: /icon/docker.png
# Overview # Overview
This Coder template presents use of [dynamic](https://developer.hashicorp.com/terraform/language/expressions/dynamic-blocks) [parameter options](https://coder.com/docs/v2/latest/templates/parameters#options) and Terraform [locals](https://developer.hashicorp.com/terraform/language/values/locals). This Coder template presents use of [dynamic](https://developer.hashicorp.com/terraform/language/expressions/dynamic-blocks) [parameter options](https://coder.com/docs/templates/parameters#options) and Terraform [locals](https://developer.hashicorp.com/terraform/language/values/locals).
## Use case ## Use case

2
examples/parameters/README.md
View File

@ -7,7 +7,7 @@ icon: /icon/docker.png
# Overview # Overview
This Coder template presents various features of [rich parameters](https://coder.com/docs/v2/latest/templates/parameters), including types, validation constraints, This Coder template presents various features of [rich parameters](https://coder.com/docs/templates/parameters), including types, validation constraints,
mutability, ephemeral (one-time) parameters, etc. mutability, ephemeral (one-time) parameters, etc.
## Development ## Development

4
examples/parameters/main.tf
View File

@ -130,7 +130,7 @@ resource "docker_container" "workspace" {
} }
// Rich parameters // Rich parameters
// See: https://coder.com/docs/v2/latest/templates/parameters // See: https://coder.com/docs/templates/parameters
data "coder_parameter" "project_id" { data "coder_parameter" "project_id" {
name = "project_id" name = "project_id"
@ -248,7 +248,7 @@ data "coder_parameter" "enable_monitoring" {
} }
// Build options (ephemeral parameters) // Build options (ephemeral parameters)
// See: https://coder.com/docs/v2/latest/templates/parameters#ephemeral-parameters // See: https://coder.com/docs/templates/parameters#ephemeral-parameters
data "coder_parameter" "pause-startup" { data "coder_parameter" "pause-startup" {
name = "pause-startup" name = "pause-startup"

2
examples/templates/aws-devcontainer/README.md
View File

@ -9,7 +9,7 @@ tags: [vm, linux, aws, persistent, devcontainer]
# Remote Development on AWS EC2 VMs using a Devcontainer # Remote Development on AWS EC2 VMs using a Devcontainer
Provision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/v2/latest) with this example template. Provision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs) with this example template.
![Architecture Diagram](./architecture.svg) ![Architecture Diagram](./architecture.svg)
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->

2
examples/templates/aws-linux/README.md
View File

@ -9,7 +9,7 @@ tags: [vm, linux, aws, persistent-vm]
# Remote Development on AWS EC2 VMs (Linux) # Remote Development on AWS EC2 VMs (Linux)
Provision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision AWS EC2 VMs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->

2
examples/templates/aws-windows/README.md
View File

@ -9,7 +9,7 @@ tags: [vm, windows, aws]
# Remote Development on AWS EC2 VMs (Windows) # Remote Development on AWS EC2 VMs (Windows)
Provision AWS EC2 Windows VMs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision AWS EC2 Windows VMs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->

4
examples/templates/azure-linux/README.md
View File

@ -9,7 +9,7 @@ tags: [vm, linux, azure]
# Remote Development on Azure VMs (Linux) # Remote Development on Azure VMs (Linux)
Provision Azure Linux VMs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision Azure Linux VMs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->
@ -29,7 +29,7 @@ This template provisions the following resources:
- Azure VM (ephemeral, deleted on stop) - Azure VM (ephemeral, deleted on stop)
- Managed disk (persistent, mounted to `/home/coder`) - Managed disk (persistent, mounted to `/home/coder`)
This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script). Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles. This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the VM image, or use a [startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/script). Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.
> **Note** > **Note**
> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case. > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.

2
examples/templates/azure-windows/README.md
View File

@ -9,7 +9,7 @@ tags: [vm, windows, azure]
# Remote Development on Azure VMs (Windows) # Remote Development on Azure VMs (Windows)
Provision Azure Windows VMs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision Azure Windows VMs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->

6
examples/templates/devcontainer-docker/README.md
View File

@ -9,7 +9,7 @@ tags: [container, docker, devcontainer]
# Remote Development on Docker Containers (with Devcontainers) # Remote Development on Docker Containers (with Devcontainers)
Provision Docker containers as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision Docker containers as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->
@ -32,7 +32,7 @@ sudo -u coder docker ps
## Architecture ## Architecture
Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/v2/latest/templates/dev-containers). Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/templates/dev-containers).
This template provisions the following resources: This template provisions the following resources:
@ -40,7 +40,7 @@ This template provisions the following resources:
- Docker container pod (ephemeral) - Docker container pod (ephemeral)
- Docker volume (persistent on `/home/coder`) - Docker volume (persistent on `/home/coder`)
This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles. This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.
> **Note** > **Note**
> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case. > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.

6
examples/templates/devcontainer-kubernetes/README.md
View File

@ -9,7 +9,7 @@ tags: [container, kubernetes, devcontainer]
# Remote Development on Kubernetes Pods (with Devcontainers) # Remote Development on Kubernetes Pods (with Devcontainers)
Provision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->
@ -27,14 +27,14 @@ This template authenticates using a `~/.kube/config`, if present on the server,
## Architecture ## Architecture
Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/v2/latest/templates/dev-containers). Coder supports devcontainers with [envbuilder](https://github.com/coder/envbuilder), an open source project. Read more about this in [Coder's documentation](https://coder.com/docs/templates/dev-containers).
This template provisions the following resources: This template provisions the following resources:
- Kubernetes pod (ephemeral) - Kubernetes pod (ephemeral)
- Kubernetes persistent volume claim (persistent on `/home/coder`) - Kubernetes persistent volume claim (persistent on `/home/coder`)
This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles. This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.
> **Note** > **Note**
> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case. > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.

2
examples/templates/do-linux/README.md
View File

@ -9,7 +9,7 @@ tags: [vm, linux, digitalocean]
# Remote Development on DigitalOcean Droplets # Remote Development on DigitalOcean Droplets
Provision DigitalOcean Droplets as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision DigitalOcean Droplets as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->

4
examples/templates/docker/README.md
View File

@ -9,7 +9,7 @@ tags: [docker, container]
# Remote Development on Docker Containers # Remote Development on Docker Containers
Provision Docker containers as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision Docker containers as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->
@ -38,7 +38,7 @@ This template provisions the following resources:
- Docker container pod (ephemeral) - Docker container pod (ephemeral)
- Docker volume (persistent on `/home/coder`) - Docker volume (persistent on `/home/coder`)
This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles. This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.
> **Note** > **Note**
> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case. > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.

6
examples/templates/envbox/README.md
View File

@ -23,7 +23,7 @@ The following environment variables can be used to configure various aspects of
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `CODER_INNER_IMAGE` | The image to use for the inner container. | True | | `CODER_INNER_IMAGE` | The image to use for the inner container. | True |
| `CODER_INNER_USERNAME` | The username to use for the inner container. | True | | `CODER_INNER_USERNAME` | The username to use for the inner container. | True |
| `CODER_AGENT_TOKEN` | The [Coder Agent](https://coder.com/docs/v2/latest/about/architecture#agents) token to pass to the inner container. | True | | `CODER_AGENT_TOKEN` | The [Coder Agent](https://coder.com/docs/about/architecture#agents) token to pass to the inner container. | True |
| `CODER_INNER_ENVS` | The environment variables to pass to the inner container. A wildcard can be used to match a prefix. Ex: `CODER_INNER_ENVS=KUBERNETES_*,MY_ENV,MY_OTHER_ENV` | false | | `CODER_INNER_ENVS` | The environment variables to pass to the inner container. A wildcard can be used to match a prefix. Ex: `CODER_INNER_ENVS=KUBERNETES_*,MY_ENV,MY_OTHER_ENV` | false |
| `CODER_INNER_HOSTNAME` | The hostname to use for the inner container. | false | | `CODER_INNER_HOSTNAME` | The hostname to use for the inner container. | false |
| `CODER_IMAGE_PULL_SECRET` | The docker credentials to use when pulling the inner container. The recommended way to do this is to create an [Image Pull Secret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#registry-secret-existing-credentials) and then reference the secret using an [environment variable](https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#define-container-environment-variables-using-secret-data). | false | | `CODER_IMAGE_PULL_SECRET` | The docker credentials to use when pulling the inner container. The recommended way to do this is to create an [Image Pull Secret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#registry-secret-existing-credentials) and then reference the secret using an [environment variable](https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#define-container-environment-variables-using-secret-data). | false |
@ -38,9 +38,9 @@ The following environment variables can be used to configure various aspects of
## Migrating Existing Envbox Templates ## Migrating Existing Envbox Templates
Due to the [deprecation and removal of legacy parameters](https://coder.com/docs/v2/latest/templates/parameters#legacy) Due to the [deprecation and removal of legacy parameters](https://coder.com/docs/templates/parameters#legacy)
it may be necessary to migrate existing envbox templates on newer versions of it may be necessary to migrate existing envbox templates on newer versions of
Coder. Consult the [migration](https://coder.com/docs/v2/latest/templates/parameters#migration) Coder. Consult the [migration](https://coder.com/docs/templates/parameters#migration)
documentation for details on how to do so. documentation for details on how to do so.
To supply values to existing existing Terraform variables you can specify the To supply values to existing existing Terraform variables you can specify the

4
examples/templates/kubernetes/README.md
View File

@ -9,7 +9,7 @@ tags: [kubernetes, container]
# Remote Development on Kubernetes Pods # Remote Development on Kubernetes Pods
Provision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. Provision Kubernetes Pods as [Coder workspaces](https://coder.com/docs/workspaces) with this example template.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->
@ -32,7 +32,7 @@ This template provisions the following resources:
- Kubernetes pod (ephemeral) - Kubernetes pod (ephemeral)
- Kubernetes persistent volume claim (persistent on `/home/coder`) - Kubernetes persistent volume claim (persistent on `/home/coder`)
This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/v2/latest/dotfiles) their workspaces with dotfiles. This means, when the workspace restarts, any tools or files outside of the home directory are not persisted. To pre-bake tools into the workspace (e.g. `python3`), modify the container image. Alternatively, individual developers can [personalize](https://coder.com/docs/dotfiles) their workspaces with dotfiles.
> **Note** > **Note**
> This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case. > This template is designed to be a starting point! Edit the Terraform to extend the template to support your use case.

2
examples/templates/nomad-docker/README.md
View File

@ -9,7 +9,7 @@ tags: [nomad, container]
# Remote Development on Nomad # Remote Development on Nomad
Provision Nomad Jobs as [Coder workspaces](https://coder.com/docs/v2/latest/workspaces) with this example template. This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes. Provision Nomad Jobs as [Coder workspaces](https://coder.com/docs/workspaces) with this example template. This example shows how to use Nomad service tasks to be used as a development environment using docker and host csi volumes.
<!-- TODO: Add screenshot --> <!-- TODO: Add screenshot -->

2
examples/web-server/apache/README.md
View File

@ -2,7 +2,7 @@
## Requirements ## Requirements
1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure): 1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/admin/configure):
```env ```env
CODER_HTTP_ADDRESS=127.0.0.1:3000 CODER_HTTP_ADDRESS=127.0.0.1:3000

2
examples/web-server/nginx/README.md
View File

@ -2,7 +2,7 @@
## Requirements ## Requirements
1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/v2/latest/admin/configure): 1. Start a Coder deployment and be sure to set the following [configuration values](https://coder.com/docs/admin/configure):
```env ```env
CODER_HTTP_ADDRESS=127.0.0.1:3000 CODER_HTTP_ADDRESS=127.0.0.1:3000

2
examples/workspace-tags/README.md
View File

@ -7,7 +7,7 @@ icon: /icon/docker.png
# Overview # Overview
This Coder template presents use of [Workspace Tags](https://coder.com/docs/v2/latest/templates/workspace-tags) [Coder Parameters](https://coder.com/docs/v2/latest/templates/parameters). This Coder template presents use of [Workspace Tags](https://coder.com/docs/templates/workspace-tags) [Coder Parameters](https://coder.com/docs/templates/parameters).
# Use case # Use case

2
helm/coder/values.yaml
View File

@ -179,7 +179,7 @@ coder:
# --icon "/emojis/xyz.png" # --icon "/emojis/xyz.png"
# #
# This is an Enterprise feature. Contact sales@coder.com # This is an Enterprise feature. Contact sales@coder.com
# Docs: https://coder.com/docs/v2/latest/admin/workspace-proxies # Docs: https://coder.com/docs/admin/workspace-proxies
workspaceProxy: false workspaceProxy: false
# coder.lifecycle -- container lifecycle handlers for the Coder container, allowing # coder.lifecycle -- container lifecycle handlers for the Coder container, allowing

2
helm/provisioner/README.md
View File

@ -12,7 +12,7 @@ External provisioner daemons are an Enterprise feature. Contact sales@coder.com.
> instructions on a tagged release. > instructions on a tagged release.
View View
[our docs](https://coder.com/docs/v2/latest/admin/provisioners) [our docs](https://coder.com/docs/admin/provisioners)
for detailed installation instructions. for detailed installation instructions.
## Values ## Values

2
install.sh
View File

@ -216,7 +216,7 @@ To run a Coder server:
# Or just run the server directly # Or just run the server directly
$ coder server $ coder server
Configuring Coder: https://coder.com/docs/v2/latest/admin/configure Configuring Coder: https://coder.com/docs/admin/configure
To connect to a Coder deployment: To connect to a Coder deployment:

4
scripts/release/generate_release_notes.sh
View File

@ -179,7 +179,7 @@ stable_since=
if ((mainline)); then if ((mainline)); then
blurb=" blurb="
> [!NOTE] > [!NOTE]
> This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/v2/latest/install/releases). > This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/install/releases).
" "
else else
# Date format: April 23, 2024 # Date format: April 23, 2024
@ -198,5 +198,5 @@ Compare: [\`${old_version}...${new_version}\`](https://github.com/coder/coder/co
## Install/upgrade ## 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
scripts/release/main.go
View File

@ -281,7 +281,7 @@ func addStableSince(date time.Time, body string) string {
// Example: // Example:
// //
// > [!NOTE] // > [!NOTE]
// > This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/v2/latest/install/releases). // > This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/install/releases).
func removeMainlineBlurb(body string) string { func removeMainlineBlurb(body string) string {
lines := strings.Split(body, "\n") lines := strings.Split(body, "\n")

12
scripts/release/main_internal_test.go
View File

@ -35,7 +35,7 @@ Compare: [` + "`" + `v2.10.1...v2.10.2` + "`" + `](https://github.com/coder/code
## Install/upgrade ## 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.
`, `,
want: `## Changelog want: `## Changelog
@ -51,7 +51,7 @@ Compare: [` + "`" + `v2.10.1...v2.10.2` + "`" + `](https://github.com/coder/code
## Install/upgrade ## 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.
`, `,
}, },
{ {
@ -59,7 +59,7 @@ Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upg
body: `## Changelog body: `## Changelog
> [!NOTE] > [!NOTE]
> This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/v2/latest/install/releases). > This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/install/releases).
### Chores ### Chores
@ -73,7 +73,7 @@ Compare: [` + "`" + `v2.10.1...v2.10.2` + "`" + `](https://github.com/coder/code
## Install/upgrade ## 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.
`, `,
want: `## Changelog want: `## Changelog
@ -89,7 +89,7 @@ Compare: [` + "`" + `v2.10.1...v2.10.2` + "`" + `](https://github.com/coder/code
## Install/upgrade ## 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.
`, `,
}, },
{ {
@ -97,7 +97,7 @@ Refer to our docs to [install](https://coder.com/docs/v2/latest/install) or [upg
body: `## Changelog body: `## Changelog
> [!NOTE] > [!NOTE]
> This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/v2/latest/install/releases). > This is a mainline Coder release. We advise enterprise customers without a staging environment to install our [latest stable release](https://github.com/coder/coder/releases/latest) while we refine this version. Learn more about our [Release Schedule](https://coder.com/docs/install/releases).
> This is an extended note. > This is an extended note.
> This is another extended note. > This is another extended note.

2
site/.eslintrc.yaml
View File

@ -42,7 +42,7 @@ overrides:
# Occasionally, we must traverse the DOM when querying for an element to # Occasionally, we must traverse the DOM when querying for an element to
# avoid the performance costs that come with using selectors like ByRole. # avoid the performance costs that come with using selectors like ByRole.
# You can read more about these performance costs here: # You can read more about these performance costs here:
# https://coder.com/docs/v2/latest/contributing/frontend#tests-getting-too-slow. # https://coder.com/docs/contributing/frontend#tests-getting-too-slow.
testing-library/no-node-access: off testing-library/no-node-access: off
testing-library/no-container: off testing-library/no-container: off
- files: ["e2e/**/*.[tj]s"] - files: ["e2e/**/*.[tj]s"]

2
site/src/pages/CreateUserPage/CreateUserForm.tsx
View File

@ -50,7 +50,7 @@ export const authMethodLanguage = {
<Link <Link
target="_blank" target="_blank"
rel="noopener" rel="noopener"
href="https://coder.com/docs/v2/latest/admin/auth#disable-built-in-authentication" href="https://coder.com/docs/admin/auth#disable-built-in-authentication"
> >
documentation documentation
</Link>{" "} </Link>{" "}

2
site/src/pages/DeploySettingsPage/AppearanceSettingsPage/AppearanceSettingsPageView.tsx
View File

@ -71,7 +71,7 @@ export const AppearanceSettingsPageView: FC<
<PopoverPaywall <PopoverPaywall
message="Appearance" message="Appearance"
description="With an Enterprise license, you can customize the appearance of your deployment." description="With an Enterprise license, you can customize the appearance of your deployment."
documentationLink="https://coder.com/docs/v2/latest/admin/appearance" documentationLink="https://coder.com/docs/admin/appearance"
/> />
</PopoverContent> </PopoverContent>
</Popover> </Popover>

2
site/src/pages/DeploySettingsPage/GeneralSettingsPage/GeneralSettingsPageView.tsx
View File

@ -75,7 +75,7 @@ export const GeneralSettingsPageView: FC<GeneralSettingsPageViewProps> = ({
It is recommended that you remove these experiments from your It is recommended that you remove these experiments from your
configuration as they have no effect. See{" "} configuration as they have no effect. See{" "}
<a <a
href="https://coder.com/docs/v2/latest/cli/server#--experiments" href="https://coder.com/docs/cli/server#--experiments"
target="_blank" target="_blank"
rel="noreferrer" rel="noreferrer"
> >

2
site/src/utils/docs.ts
View File

@ -1,4 +1,4 @@
const DEFAULT_DOCS_URL = "https://coder.com/docs/v2/latest"; const DEFAULT_DOCS_URL = "https://coder.com/docs";
// Add cache to avoid DOM reading all the time // Add cache to avoid DOM reading all the time
let CACHED_DOCS_URL: string | undefined; let CACHED_DOCS_URL: string | undefined;