Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/about/contributing/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Contributor Covenant Code of Conduct
---
title: Contributor Covenant Code of Conduct
---

## Our Pledge

Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Security Policy
---
title: Security Policy
---

Coder welcomes feedback from security researchers and the general public to help improve our security.
If you believe you have discovered a vulnerability, privacy issue, exposed data, or other security issues
Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/modules.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Contributing modules
---
title: Contributing modules
---

Learn how to create and contribute Terraform modules to the Coder Registry. Modules provide reusable components that extend Coder workspaces with IDEs, development tools, login tools, and other features.

Expand Down Expand Up @@ -292,7 +294,7 @@
- Improve error handling
- Optimize performance

### Making changes

Check warning on line 297 in docs/about/contributing/modules.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Making'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

1. **Identify the issue**: Reproduce the problem or identify the improvement needed
2. **Make focused changes**: Keep modifications minimal and targeted
Expand Down Expand Up @@ -352,7 +354,7 @@

## Common issues and solutions

### Testing problems

Check warning on line 357 in docs/about/contributing/modules.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Testing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

**Issue**: Tests fail with network errors
**Solution**: Ensure Docker is running with `--network=host` support
Expand Down
4 changes: 3 additions & 1 deletion docs/about/contributing/templates.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Contributing templates
---
title: Contributing templates
---

Learn how to create and contribute complete Coder workspace templates to the Coder Registry. Templates provide ready-to-use workspace configurations that users can deploy directly to create development environments.

Expand Down Expand Up @@ -388,7 +390,7 @@
- Add troubleshooting guides
- Improve usage examples

### Making changes

Check warning on line 393 in docs/about/contributing/templates.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Making'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

1. **Test thoroughly**: Always test template changes in a Coder instance
2. **Maintain compatibility**: Ensure existing workspaces continue to function
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/infrastructure/scale-utility.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Scale Tests and Utilities
---
title: Scale Tests and Utilities
---

We scale-test Coder with a built-in utility that can
be used in your environment for insights into how Coder scales with your
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Reference Architecture: up to 10,000 users
---
title: "Reference Architecture: up to 10,000 users"
---

The 10,000 users architecture targets enterprises with an extremely large global workforce of technical professionals or
applications requiring lots of simultaneous workspaces (for example, Agentic AI).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Reference Architecture: up to 1,000 users
---
title: "Reference Architecture: up to 1,000 users"
---

The 1,000 users architecture is designed to cover a wide range of workflows.
Examples of subjects that might utilize this architecture include medium-sized
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Reference Architecture: up to 2,000 users
---
title: "Reference Architecture: up to 2,000 users"
---

In the 2,000 users architecture, there is a moderate increase in traffic,
suggesting a growing user base or expanding operations. This setup is
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Reference Architecture: up to 3,000 users
---
title: "Reference Architecture: up to 3,000 users"
---

The 3,000 users architecture targets large-scale enterprises, possibly with
on-premises network and cloud deployments.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/infrastructure/validated-architectures/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Coder Validated Architecture
---
title: Coder Validated Architecture
---

Many customers operate Coder in complex organizational environments, consisting
of multiple business units, agencies, and/or subsidiaries. This can lead to
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Envbuilder releases and known issues
---
title: Envbuilder releases and known issues
---

## Release channels

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Envbuilder security and caching
---
title: Envbuilder security and caching
---

Ensure Envbuilder can only pull pre-approved images and artifacts by configuring
it with your existing HTTP proxies, firewalls, and artifact managers.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/devcontainers/integration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Configure a template for Dev Containers
---
title: Configure a template for Dev Containers
---

This guide covers the Dev Containers Integration, which uses Docker. For
environments without Docker, see [Envbuilder](./envbuilder/index.md) as an
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/dx-data-cloud.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# DX
---
title: DX
---

[DX](https://getdx.com) is a developer intelligence platform used by engineering
leaders and platform engineers.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/island.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Island Browser Integration
---
title: Island Browser Integration
---

<div>
<a href="https://github.com/ericpaulsen" style="text-decoration: none; color: inherit;">
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/istio.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Integrate Coder with Istio
---
title: Integrate Coder with Istio
---

Use Istio service mesh for your Coder workspace traffic to implement access
controls, encrypt service-to-service communication, and gain visibility into
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/jfrog-artifactory.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# JFrog Artifactory Integration
---
title: JFrog Artifactory Integration
---

Use Coder and JFrog Artifactory together to secure your development environments
without disturbing your developers' existing workflows.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/kubernetes-logs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Kubernetes event logs
---
title: Kubernetes event logs
---

To stream Kubernetes events into your workspace startup logs, you can use
Coder's [`coder-logstream-kube`](https://github.com/coder/coder-logstream-kube)
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/multiple-kube-clusters.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Additional clusters
---
title: Additional clusters
---

With Coder, you can deploy workspaces in additional Kubernetes clusters using
different
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/oauth2-provider.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# OAuth2 Provider (Experimental)
---
title: OAuth2 Provider (Experimental)
---

> [!WARNING]
> The OAuth2 provider functionality is currently **experimental and unstable**. This feature:
Expand Down Expand Up @@ -32,7 +34,7 @@
CODER_EXPERIMENTS=oauth2
```

## Creating OAuth2 Applications

Check warning on line 37 in docs/admin/integrations/oauth2-provider.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Creating'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

### Method 1: Web UI

Expand Down Expand Up @@ -282,7 +284,7 @@
This is also how you remove clients that registered themselves while dynamic client registration was enabled.
Turning the setting off stops new registrations; it does not remove the ones already there.

## Testing and Development

Check warning on line 287 in docs/admin/integrations/oauth2-provider.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Testing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Coder provides comprehensive test scripts for OAuth2 development:

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/integrations/vault.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Integrating HashiCorp Vault with Coder
---
title: Integrating HashiCorp Vault with Coder
---

<div>
<a href="https://github.com/matifali" style="text-decoration: none; color: inherit;">
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/connection-logs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Connection Logs (Premium)
---
title: Connection Logs (Premium)
---

> [!NOTE]
> Connection logs require a
Expand Down Expand Up @@ -80,7 +82,7 @@
Some events are neither ongoing nor completed, such as the opening of a
workspace app.

## Capturing/Exporting Connection Logs

Check warning on line 85 in docs/admin/monitoring/connection-logs.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Capturing'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

In addition to the Coder dashboard, there are multiple ways to consume or query
connection events.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/health-check.md

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach ../provisioners/index.md#external-provisioners Status: 404 Cannot find section: #external-provisioners in file: /home/runner/work/coder/coder/docs/admin/provisioners/index.md.

[External Provisioner Daemons](../provisioners/index.md#external-provisioners), ensure

Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Deployment Health
---
title: Deployment Health
---

Coder includes an operator-friendly deployment health page that provides a
number of details about the health of your Coder deployment.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Monitoring Coder
---
title: Monitoring Coder
---

Learn about our the tools, techniques, and best practices to monitor your Coder
deployment.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/monitoring/metrics.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Deployment Metrics
---
title: Deployment Metrics
---

Coder exposes many metrics which give insight into the current state of a live
Coder deployment. Our metrics are designed to be consumed by a
Expand All @@ -8,7 +10,7 @@
[Getting started](https://prometheus.io/docs/prometheus/latest/getting_started/)
guide.

## Setting up metrics

Check warning on line 13 in docs/admin/monitoring/metrics.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Setting'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

To set up metrics monitoring, please read our
[Prometheus integration guide](../integrations/prometheus.md). The following
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/networking/wildcard-access-url.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Wildcard Access URLs
---
title: Wildcard Access URLs
---

Wildcard access URLs unlock Coder's full potential for modern development workflows. While optional for basic SSH usage, this feature becomes essential when teams need web applications, development previews, or browser-based tools. **Wildcard access URLs are essential for many development workflows in Coder** - Web IDEs (code-server, VS Code Web, JupyterLab) and some development frameworks work significantly better with subdomain-based access rather than path-based URLs.

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/networking/workspace-proxies.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Workspace Proxies (Premium)
---
title: Workspace Proxies (Premium)
---

Workspace proxies provide low-latency experiences for geo-distributed teams.

Expand Down Expand Up @@ -107,7 +109,7 @@
# Additional configuration options are available.
```

### Running on Kubernetes

Check warning on line 112 in docs/admin/networking/workspace-proxies.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Running'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

Make a `values-wsproxy.yaml` with the workspace proxy configuration.

Expand Down Expand Up @@ -146,14 +148,14 @@
the Coder dashboard still shows the workspace proxy is `UNHEALTHY`, scale down
and up the deployment's replicas.

### Running on a VM

Check warning on line 151 in docs/admin/networking/workspace-proxies.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Running'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

```sh
# Set configuration options via environment variables, a config file, or cmd flags
coder wsproxy server
```

### Running as a system service

Check warning on line 158 in docs/admin/networking/workspace-proxies.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.GerundHeading

Heading starts with an -ing word ('Running'); prefer the imperative ('Install') or the noun ('Installation'). See capitalization-and-punctuation.md#no-gerund-leading-headings.

If you've installed Coder via a [system package](../../install/index.md), you
can configure the workspace proxy by settings in
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/provisioners/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# External provisioners
---
title: External provisioners
---

By default, the Coder server runs
[built-in provisioner daemons](../../reference/cli/server.md#--provisioner-daemons),
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/provisioners/manage-provisioner-jobs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Manage provisioner jobs
---
title: Manage provisioner jobs
---

[Provisioners](./index.md) start and run provisioner jobs to create or delete workspaces.
Each time a workspace is built, rebuilt, or destroyed, it generates a new job and assigns
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/setup/appearance.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Appearance (Premium)
---
title: Appearance (Premium)
---

> [!NOTE]
> Customizing Coder's appearance is a Premium feature.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/setup/chat-lifecycle-hooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Configure chat lifecycle hooks
---
title: Configure chat lifecycle hooks
---

> [!NOTE]
> Chat lifecycle hooks are an experimental feature.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/setup/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Configure Control Plane Access
---
title: Configure Control Plane Access
---

Coder server's primary configuration is done via environment variables. For a
full list of the options, run `coder server --help` or see our
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/agent-metadata.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Agent metadata
---
title: Agent metadata
---

![agent-metadata](../../../images/admin/templates/agent-metadata-ui.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Environment variables
---
title: Environment variables
---

Use the
[`coder_env`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/env)
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Extending templates
---
title: Extending templates
---

There are a variety of Coder-native features to extend the configuration of your
development environments. Many of the following features are defined in your
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# JetBrains IDEs in an air-gapped environment
---
title: JetBrains IDEs in an air-gapped environment
---

In networks that restrict access to the internet, you will need to leverage the
JetBrains Client Installer to download and save the IDE clients locally. Please
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Pre-install JetBrains IDEs in your template
---
title: Pre-install JetBrains IDEs in your template
---

For a faster first time connection with JetBrains IDEs, pre-install the IDEs backend in your template.

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/modules.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Reusing template code
---
title: Reusing template code
---

To reuse code across different Coder templates, such as common scripts or
resource definitions, we suggest using
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/parameters.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Parameters
---
title: Parameters
---

A template can prompt the user for additional information when creating
workspaces with
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/process-logging.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Workspace Process Logging
---
title: Workspace Process Logging
---

The workspace process logging feature allows you to log all system-level
processes executing in the workspace.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Resource monitoring
---
title: Resource monitoring
---

Use the
[`resources_monitoring`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#resources_monitoring-1)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# UI Resource Ordering
---
title: UI Resource Ordering
---

In Coder templates, managing the order of UI elements is crucial for a seamless
user experience. This page outlines how resources can be aligned using the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Resource persistence
---
title: Resource persistence
---

By default, all Coder resources are persistent, but production templates
**must** use the practices laid out in this document to prevent accidental
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/variables.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Terraform template-wide variables
---
title: Terraform template-wide variables
---

In Coder, Terraform templates offer extensive flexibility through template-wide
variables. These variables, managed by template authors, facilitate the
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/extending-templates/web-ides.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Web IDEs
---
title: Web IDEs in templates
---

In Coder, web IDEs are defined as
[coder_app](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/app)
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Template
---
title: Template
---

Templates are written in
[Terraform](https://developer.hashicorp.com/terraform/intro) and define the
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/managing-templates/change-management.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Template Change Management
---
title: Template Change Management
---

We recommend source-controlling your templates as you would other any code, and
automating the creation of new versions in CI/CD pipelines.
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/managing-templates/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Working with templates
---
title: Working with templates
---

You create and edit Coder templates as
[Terraform](https://developer.hashicorp.com/terraform/intro) configuration files (`.tf`) and
Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/startup-coordination/example.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Workspace Startup Coordination Examples
---
title: Workspace Startup Coordination Examples
---

## Script Example

Expand Down
4 changes: 3 additions & 1 deletion docs/admin/templates/startup-coordination/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Workspace Startup Coordination
---
title: Workspace Startup Coordination
---

> [!NOTE]
> This feature is experimental and may change without notice in future releases.
Expand Down
Loading
Loading