Oct 5, 2024 · Aug 23, 2024 · Aug 23, 2024 · Aug 23, 2024 · Aug 23, 2024 · Aug 23, 2024
diff --git a/.github/workflows/typos.toml b/.github/workflows/typos.toml
 EDE = "EDE"
 # HELO is an SMTP command
 HELO = "HELO"
 LKE = "LKE"

 [files]
 extend-exclude = [
diff --git a/.vscode/settings.json b/.vscode/settings.json
 "ASKPASS",
 "authcheck",
 "autostop",
 "autoupdate",
 "awsidentity",
 "bodyclose",
 "buildinfo",
 "buildname",
 "Caddyfile",
 "circbuf",
 "cliflag",
 "cliui",
 "codecov",
 "codercom",
 "coderd",
 "coderdenttest",
 "coderdtest",
 "codersdk",
 "contravariance",
 "cronstrue",
 "databasefake",
 "dbcrypt",
 "dbgen",
 "dbmem",
 "dbtype",
 "DERP",
 "derphttp",
 "derpmap",
 "devcontainers",
 "devel",
 "devtunnel",
 "dflags",
 "dogfood",
 "dotfiles",
 "drpc",
 "drpcconn",
 "drpcmux",
 "embeddedpostgres",
 "enablements",
 "enterprisemeta",
 "Entra",
 "errgroup",
 "eventsourcemock",
 "externalauth",
 "Failf",
 "fatih",
 "filebrowser",
 "Formik",
 "gitauth",
 "Gitea",
 "gitsshkey",
 "goarch",
 "gographviz",
 "goleak",
 "gonet",
 "googleclouddns",
 "gossh",
 "gsyslog",
 "GTTY",
 "initialisms",
 "ipnstate",
 "isatty",
 "jetbrains",
 "Jobf",
 "Keygen",
 "kirsle",
 "knowledgebase",
 "Kubernetes",
 "ldflags",
 "magicsock",
 "namesgenerator",
 "namespacing",
 "netaddr",
 "netcheck",
 "netip",
 "netmap",
 "netns",
 "opty",
 "paralleltest",
 "parameterscopeid",
 "portsharing",
 "pqtype",
 "prometheusmetrics",
 "promhttp",
 "protobuf",
 "provisionerd",
 "provisionerdserver",
 "provisionersdk",
 "psql",
 "ptrace",
 "ptty",
 "ptys",
 "ptytest",
 "Signup",
 "slogtest",
 "sourcemapped",
 "speedtest",
 "spinbutton",
 "Srcs",
 "stdbuf",
 "turnconn",
 "typegen",
 "typesafe",
 "unauthenticate",
 "unconvert",
 "Untar",
 "Userspace",
 "untar",
 "userspace",
 "VMID",
 "walkthrough",
 "weblinks",
 "webrtc",
 "websockets",
 "wgcfg",
 "wgconfig",
 "wgengine",
 "workspaceapps",
 "workspacebuilds",
 "workspacename",
 "workspaceproxies",
 "wsjson",
 "xerrors",
 "xlarge",
diff --git a/Makefile b/Makefile
 coderd/rbac/object_gen.go \
 codersdk/rbacresources_gen.go \
 site/src/api/rbacresourcesGenerated.ts \
 docs/admin/prometheus.md \
 docs/reference/cli/README.md \
 docs/admin/audit-logs.md \
 docs/admin/integrations/prometheus.md \
 docs/reference/cli/index.md \
 docs/admin/security/audit-logs.md \
 coderd/apidoc/swagger.json \
 .prettierignore.include \
 .prettierignore \
 coderd/rbac/object_gen.go \
 codersdk/rbacresources_gen.go \
 site/src/api/rbacresourcesGenerated.ts \
 docs/admin/prometheus.md \
 docs/reference/cli/README.md \
 docs/admin/audit-logs.md \
 docs/admin/integrations/prometheus.md \
 docs/reference/cli/index.md \
 docs/admin/security/audit-logs.md \
 coderd/apidoc/swagger.json \
 .prettierignore.include \
 .prettierignore \
 site/src/api/rbacresourcesGenerated.ts: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
 go run scripts/rbacgen/main.go typescript > "$@"


 docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
 docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
 go run scripts/metricsdocgen/main.go
 ./scripts/pnpm_install.sh
 pnpm exec prettier --write ./docs/admin/prometheus.md
 pnpm exec prettier --write ./docs/admin/integrations/prometheus.md

 docs/reference/cli/README.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
 docs/reference/cli/index.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
 CI=true BASE_PATH="." go run ./scripts/clidocgen
 ./scripts/pnpm_install.sh
 pnpm exec prettier --write ./docs/reference/cli/README.md ./docs/reference/cli/*.md ./docs/manifest.json
 pnpm exec prettier --write ./docs/reference/cli/index.md ./docs/reference/cli/*.md ./docs/manifest.json

 docs/admin/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
 docs/admin/security/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
 go run scripts/auditdocgen/main.go
 ./scripts/pnpm_install.sh
 pnpm exec prettier --write ./docs/admin/audit-logs.md
 pnpm exec prettier --write ./docs/admin/security/audit-logs.md

 coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) $(wildcard enterprise/wsproxy/wsproxysdk/*.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go
 ./scripts/apidocgen/generate.sh
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md

 ### Security

 > If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email
 > to security@coder.com.

 The
 [`security`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Asecurity)
 label can be added to PRs that have, or will be, merged into `main`. Doing so
diff --git a/docs/README.md b/docs/README.md
 # About Coder

 <!-- Warning for docs contributors: The first route in manifest.json must be titled "About" for the static landing page to work correctly.  -->

 Coder is an open-source platform for creating and managing developer workspaces
 on your preferred clouds and servers.

 <p align="center">
  <img src="./images/hero-image.png">
 </p>

 By building on top of common development interfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of **provisioning** and **accessing** remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity.
 By building on top of common development interfaces (SSH) and infrastructure
 tools (Terraform), Coder aims to make the process of **provisioning** and
 **accessing** remote workspaces approachable for organizations of various sizes
 and stages of cloud-native maturity.

 <blockquote class="warning">
  <p>
 ## How it works

 Coder workspaces are represented with Terraform, but no Terraform knowledge is
 required to get started. We have a database of pre-made templates built into the
 product.
 required to get started. We have a
 [database](https://registry.coder.com/templates) of pre-made templates built
 into the product.

 <p align="center">
  <img src="./images/providers-compute.png">
 </p>

 Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
 and whatever else Terraform lets you dream up.
 Coder workspaces don't stop at compute. You can add storage buckets, secrets,
 sidecarsand whatever else Terraform lets you dream up.

 [Learn more aboutmanaging infrastructure.](./templates/index.md)
 [Learn more abouttemplates.](./admin/templates/index.md)

 ## IDE Support

 You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/).
 You can use any [Web IDE](./admin/templates/extending-templates/web-ides.md)
 ([code-server](https://github.com/coder/code-server),
 [projector](https://github.com/JetBrains/projector-server),
 [Jupyter](https://jupyter.org), etc.),
 [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/),
 [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even
 a file sync such as [mutagen](https://mutagen.io/).

 <p align="center">
  <img src="./images/ide-icons.svg" height=72>
 ## Why remote development

 Migrating from local developer machines to workspaces hosted by cloud services
 is an [increasingly common solution for
 developers](https://blog.alexellis.io/the-internet-is-my-computer/) and
 [organizations
 alike](https://slack.engineering/development-environments-at-slack). There are
 several benefits, including:
 is an
 [increasingly common solution fordevelopers](https://blog.alexellis.io/the-internet-is-my-computer/)
 and
 [organizationsalike](https://slack.engineering/development-environments-at-slack).
 There areseveral benefits, including:

 - **Increased speed:** Server-grade compute speeds up operations in software
  development, such as IDE loading, code compilation and building, and the
 - Enable persistent workspaces, which are like local machines, but faster and
  hosted by a cloud service

 Coder includes [production-ready templates](https://github.com/coder/coder/tree/c6b1daabc5a7aa67bfbb6c89966d728919ba7f80/examples/templates) for use with AWS EC2,
 Azure, Google Cloud, Kubernetes, and more.
 Coder includes
 [production-ready templates](https://registry.coder.com/templates) for use with
 AWS EC2, Azure, Google Cloud, Kubernetes, and more.

 ## What Coder is _not_

 - Coder is not a collaboration platform. You can use git and dedicated IDE
  extensions for pull requests, code reviews, and pair programming.

 - Coder is not a SaaS/fully-managed offering. You must host
  Coder on a cloud service (AWS, Azure, GCP) or your private data center.

 ## Up next

 - Learn about [Templates](./templates/index.md)
 - [Install Coder](./install/index.md#install-coder)
 - Coder is not a SaaS/fully-managed offering. You must host Coder on a cloud
  service (AWS, Azure, GCP) or your private data center.
diff --git a/docs/admin/README.md b/docs/admin/README.md
diff --git a/docs/admin/app-logs.md b/docs/admin/app-logs.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,6 +22,7 @@ pn = "pn"
		EDE = "EDE"
		# HELO is an SMTP command
		HELO = "HELO"
		LKE = "LKE"

		[files]
		extend-exclude = [
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,30 +6,37 @@
		"ASKPASS",
		"authcheck",
		"autostop",
		"autoupdate",
		"awsidentity",
		"bodyclose",
		"buildinfo",
		"buildname",
		"Caddyfile",
		"circbuf",
		"cliflag",
		"cliui",
		"codecov",
		"codercom",
		"coderd",
		"coderdenttest",
		"coderdtest",
		"codersdk",
		"contravariance",
		"cronstrue",
		"databasefake",
		"dbcrypt",
		"dbgen",
		"dbmem",
		"dbtype",
		"DERP",
		"derphttp",
		"derpmap",
		"devcontainers",
		"devel",
		"devtunnel",
		"dflags",
		"dogfood",
		"dotfiles",
		"drpc",
		"drpcconn",
		"drpcmux",
Expand All		@@ -38,18 +45,22 @@
		"embeddedpostgres",
		"enablements",
		"enterprisemeta",
		"Entra",
		"errgroup",
		"eventsourcemock",
		"externalauth",
		"Failf",
		"fatih",
		"filebrowser",
		"Formik",
		"gitauth",
		"Gitea",
		"gitsshkey",
		"goarch",
		"gographviz",
		"goleak",
		"gonet",
		"googleclouddns",
		"gossh",
		"gsyslog",
		"GTTY",
Expand All		@@ -63,9 +74,11 @@
		"initialisms",
		"ipnstate",
		"isatty",
		"jetbrains",
		"Jobf",
		"Keygen",
		"kirsle",
		"knowledgebase",
		"Kubernetes",
		"ldflags",
		"magicsock",
Expand All		@@ -77,6 +90,7 @@
		"namesgenerator",
		"namespacing",
		"netaddr",
		"netcheck",
		"netip",
		"netmap",
		"netns",
Expand All		@@ -93,13 +107,16 @@
		"opty",
		"paralleltest",
		"parameterscopeid",
		"portsharing",
		"pqtype",
		"prometheusmetrics",
		"promhttp",
		"protobuf",
		"provisionerd",
		"provisionerdserver",
		"provisionersdk",
		"psql",
		"ptrace",
		"ptty",
		"ptys",
		"ptytest",
Expand All		@@ -114,6 +131,7 @@
		"Signup",
		"slogtest",
		"sourcemapped",
		"speedtest",
		"spinbutton",
		"Srcs",
		"stdbuf",
Expand DownExpand Up		@@ -154,13 +172,15 @@
		"turnconn",
		"typegen",
		"typesafe",
		"unauthenticate",
		"unconvert",
		"Untar",
		"Userspace",
		"untar",
		"userspace",
		"VMID",
		"walkthrough",
		"weblinks",
		"webrtc",
		"websockets",
		"wgcfg",
		"wgconfig",
		"wgengine",
Expand All		@@ -172,6 +192,7 @@
		"workspaceapps",
		"workspacebuilds",
		"workspacename",
		"workspaceproxies",
		"wsjson",
		"xerrors",
		"xlarge",
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -495,9 +495,9 @@ gen: \
		coderd/rbac/object_gen.go \
		codersdk/rbacresources_gen.go \
		site/src/api/rbacresourcesGenerated.ts \
		docs/admin/prometheus.md \
		docs/reference/cli/README.md \
		docs/admin/audit-logs.md \
		docs/admin/integrations/prometheus.md \
		docs/reference/cli/index.md \
		docs/admin/security/audit-logs.md \
		coderd/apidoc/swagger.json \
		.prettierignore.include \
		.prettierignore \
Expand DownExpand Up		@@ -525,9 +525,9 @@ gen/mark-fresh:
		coderd/rbac/object_gen.go \
		codersdk/rbacresources_gen.go \
		site/src/api/rbacresourcesGenerated.ts \
		docs/admin/prometheus.md \
		docs/reference/cli/README.md \
		docs/admin/audit-logs.md \
		docs/admin/integrations/prometheus.md \
		docs/reference/cli/index.md \
		docs/admin/security/audit-logs.md \
		coderd/apidoc/swagger.json \
		.prettierignore.include \
		.prettierignore \
Expand DownExpand Up		@@ -638,21 +638,20 @@ codersdk/rbacresources_gen.go: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/m
		site/src/api/rbacresourcesGenerated.ts: scripts/rbacgen/codersdk.gotmpl scripts/rbacgen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
		go run scripts/rbacgen/main.go typescript > "$@"


		docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
		docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
		go run scripts/metricsdocgen/main.go
		./scripts/pnpm_install.sh
		pnpm exec prettier --write ./docs/admin/prometheus.md
		pnpm exec prettier --write ./docs/admin/integrations/prometheus.md

		docs/reference/cli/README.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
		docs/reference/cli/index.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
		CI=true BASE_PATH="." go run ./scripts/clidocgen
		./scripts/pnpm_install.sh
		pnpm exec prettier --write ./docs/reference/cli/README.md ./docs/reference/cli/*.md ./docs/manifest.json
		pnpm exec prettier --write ./docs/reference/cli/index.md ./docs/reference/cli/*.md ./docs/manifest.json

		docs/admin/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
		docs/admin/security/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
		go run scripts/auditdocgen/main.go
		./scripts/pnpm_install.sh
		pnpm exec prettier --write ./docs/admin/audit-logs.md
		pnpm exec prettier --write ./docs/admin/security/audit-logs.md

		coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/.go) $(wildcard enterprise/coderd/.go) $(wildcard codersdk/.go) $(wildcard enterprise/wsproxy/wsproxysdk/.go) $(DB_GEN_FILES) .swaggo docs/manifest.json coderd/rbac/object_gen.go
		./scripts/apidocgen/generate.sh
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -315,6 +315,9 @@ Breaking changes can be triggered in two ways:

		### Security

		> If you find a vulnerability, DO NOT FILE AN ISSUE. Instead, send an email
		> to security@coder.com.

		The
		[`security`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Asecurity)
		label can be added to PRs that have, or will be, merged into `main`. Doing so
Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,13 +1,18 @@
		# About Coder

		<!-- Warning for docs contributors: The first route in manifest.json must be titled "About" for the static landing page to work correctly. -->

		Coder is an open-source platform for creating and managing developer workspaces
		on your preferred clouds and servers.

		<p align="center">
		<img src="./images/hero-image.png">
		</p>

		By building on top of common development interfaces (SSH) and infrastructure tools (Terraform), Coder aims to make the process of provisioning and accessing remote workspaces approachable for organizations of various sizes and stages of cloud-native maturity.
		By building on top of common development interfaces (SSH) and infrastructure
		tools (Terraform), Coder aims to make the process of provisioning and
		accessing remote workspaces approachable for organizations of various sizes
		and stages of cloud-native maturity.

		<blockquote class="warning">
		<p>
Expand All		@@ -18,21 +23,28 @@ By building on top of common development interfaces (SSH) and infrastructure too
		## How it works

		Coder workspaces are represented with Terraform, but no Terraform knowledge is
		required to get started. We have a database of pre-made templates built into the
		product.
		required to get started. We have a
		[database](https://registry.coder.com/templates) of pre-made templates built
		into the product.

		<p align="center">
		<img src="./images/providers-compute.png">
		</p>

		Coder workspaces don't stop at compute. You can add storage buckets, secrets, sidecars
		and whatever else Terraform lets you dream up.
		Coder workspaces don't stop at compute. You can add storage buckets, secrets,
		sidecarsand whatever else Terraform lets you dream up.

		[Learn more aboutmanaging infrastructure.](./templates/index.md)
		[Learn more abouttemplates.](./admin/templates/index.md)

		## IDE Support

		You can use any Web IDE ([code-server](https://github.com/coder/code-server), [projector](https://github.com/JetBrains/projector-server), [Jupyter](https://jupyter.org/), etc.), [JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/), [VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even a file sync such as [mutagen](https://mutagen.io/).
		You can use any [Web IDE](./admin/templates/extending-templates/web-ides.md)
		([code-server](https://github.com/coder/code-server),
		[projector](https://github.com/JetBrains/projector-server),
		[Jupyter](https://jupyter.org), etc.),
		[JetBrains Gateway](https://www.jetbrains.com/remote-development/gateway/),
		[VS Code Remote](https://code.visualstudio.com/docs/remote/ssh-tutorial) or even
		a file sync such as [mutagen](https://mutagen.io/).

		<p align="center">
		<img src="./images/ide-icons.svg" height=72>
Expand All		@@ -41,11 +53,11 @@ You can use any Web IDE ([code-server](https://github.com/coder/code-server), [p
		## Why remote development

		Migrating from local developer machines to workspaces hosted by cloud services
		is an [increasingly common solution for
		developers](https://blog.alexellis.io/the-internet-is-my-computer/) and
		[organizations
		alike](https://slack.engineering/development-environments-at-slack). There are
		several benefits, including:
		is an
		[increasingly common solution fordevelopers](https://blog.alexellis.io/the-internet-is-my-computer/)
		and
		[organizationsalike](https://slack.engineering/development-environments-at-slack).
		There areseveral benefits, including:

		- Increased speed: Server-grade compute speeds up operations in software
		development, such as IDE loading, code compilation and building, and the
Expand DownExpand Up		@@ -80,8 +92,9 @@ layer of infrastructure control. This additional layer allows admins to:
		- Enable persistent workspaces, which are like local machines, but faster and
		hosted by a cloud service

		Coder includes [production-ready templates](https://github.com/coder/coder/tree/c6b1daabc5a7aa67bfbb6c89966d728919ba7f80/examples/templates) for use with AWS EC2,
		Azure, Google Cloud, Kubernetes, and more.
		Coder includes
		[production-ready templates](https://registry.coder.com/templates) for use with
		AWS EC2, Azure, Google Cloud, Kubernetes, and more.

		## What Coder is _not_

Expand All		@@ -99,10 +112,5 @@ Azure, Google Cloud, Kubernetes, and more.
		- Coder is not a collaboration platform. You can use git and dedicated IDE
		extensions for pull requests, code reviews, and pair programming.

		- Coder is not a SaaS/fully-managed offering. You must host
		Coder on a cloud service (AWS, Azure, GCP) or your private data center.

		## Up next

		- Learn about [Templates](./templates/index.md)
		- [Install Coder](./install/index.md#install-coder)
		- Coder is not a SaaS/fully-managed offering. You must host Coder on a cloud
		service (AWS, Azure, GCP) or your private data center.