From 4b203fa4b6d43176f9cff2f4482b0b7e4d61ab03 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Thu, 28 Aug 2025 16:36:17 +0000 Subject: [PATCH 01/10] docs: Update offline deployments terminology to air-gapped - Change title from 'Offline Deployments' to 'Air-gapped Deployments' - Update summary to prioritize 'air-gapped' and add 'disconnected' - Change table header from 'Offline deployments' to 'Air-gapped deployments' - Update tutorial reference to use 'air-gapped' terminology - Update section header to 'Air-gapped container images' This improves clarity by using the more precise 'air-gapped' terminology and includes 'disconnected' to cover additional deployment scenarios. --- docs/install/offline.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/install/offline.md b/docs/install/offline.md index 289780526f76a..4a5b9f4a9f2ee 100644 --- a/docs/install/offline.md +++ b/docs/install/offline.md @@ -1,12 +1,12 @@ -# Offline Deployments +# Air-gapped Deployments -All Coder features are supported in offline / behind firewalls / in air-gapped +All Coder features are supported in air-gapped / behind firewalls / disconnected / offline environments. However, some changes to your configuration are necessary. This is a general comparison. Keep reading for a full tutorial running Coder -offline with Kubernetes or Docker. +air-gapped with Kubernetes or Docker. -| | Public deployments | Offline deployments | +| | Public deployments | Air-gapped deployments | |--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) | | Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below | @@ -16,7 +16,7 @@ offline with Kubernetes or Docker. | Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) | | Update check | By default, Coder checks for updates from [GitHub releases](https://github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) | -## Offline container images +## Air-gapped container images The following instructions walk you through how to build a custom Coder server image for Docker or Kubernetes From c860aa64532ef6028e2204f4ff64fef21ec3089c Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Thu, 28 Aug 2025 16:38:40 +0000 Subject: [PATCH 02/10] fix: Remove trailing spaces from table header to fix formatting The markdown table formatter was removing trailing spaces from the 'Air-gapped deployments' column header, causing CI failures. --- docs/install/offline.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/offline.md b/docs/install/offline.md index 4a5b9f4a9f2ee..69d9dfebe53ed 100644 --- a/docs/install/offline.md +++ b/docs/install/offline.md @@ -6,7 +6,7 @@ environments. However, some changes to your configuration are necessary. This is a general comparison. Keep reading for a full tutorial running Coder air-gapped with Kubernetes or Docker. -| | Public deployments | Air-gapped deployments | +| | Public deployments | Air-gapped deployments | |--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](https://github.com/coder/coder/blob/main/provisioner/terraform/install.go#L23-L24) | | Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below | From 7ac172fbc87dd28f602915d4ab06721048c3c63b Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Thu, 28 Aug 2025 18:46:12 +0000 Subject: [PATCH 03/10] docs: Update navigation title and fix line breaks - Update manifest.json to change navigation title from 'Offline Deployments' to 'Air-gapped Deployments' - Update description to prioritize 'air-gapped' terminology - Fix line break issues in the markdown file This ensures the navigation, breadcrumbs, and page title all consistently use 'Air-gapped Deployments'. --- docs/install/offline.md | 2 -- docs/manifest.json | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/install/offline.md b/docs/install/offline.md index 69d9dfebe53ed..cb2a6632b073f 100644 --- a/docs/install/offline.md +++ b/docs/install/offline.md @@ -1,8 +1,6 @@ # Air-gapped Deployments All Coder features are supported in air-gapped / behind firewalls / disconnected / offline -environments. However, some changes to your configuration are necessary. - This is a general comparison. Keep reading for a full tutorial running Coder air-gapped with Kubernetes or Docker. diff --git a/docs/manifest.json b/docs/manifest.json index d2cd11ace699b..d2784b475d43d 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -154,8 +154,8 @@ ] }, { - "title": "Offline Deployments", - "description": "Run Coder in offline / air-gapped environments", + "title": "Air-gapped Deployments", + "description": "Run Coder in air-gapped / disconnected / offline environments", "path": "./install/offline.md", "icon_path": "./images/icons/lan.svg" }, From 46d6c88656543a6f4b4f02e426a8f61d378db7e4 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Thu, 28 Aug 2025 19:00:41 +0000 Subject: [PATCH 04/10] docs: Rename offline.md to airgap.md and update all references - Rename docs/install/offline.md to docs/install/airgap.md for consistency - Update manifest.json path to point to ./install/airgap.md - Update all internal links from install/offline to install/airgap - Add redirect configuration for /install/offline -> /install/airgap - Updated files: integrations/index.md, networking/index.md, changelogs/v0.27.0.md, faqs.md This ensures complete consistency with the new 'air-gapped' terminology while maintaining backward compatibility through redirects. --- docs/_redirects | 3 +++ docs/admin/integrations/index.md | 2 +- docs/admin/networking/index.md | 4 ++-- docs/changelogs/v0.27.0.md | 2 +- docs/install/{offline.md => airgap.md} | 0 docs/manifest.json | 2 +- docs/tutorials/faqs.md | 2 +- 7 files changed, 9 insertions(+), 6 deletions(-) create mode 100644 docs/_redirects rename docs/install/{offline.md => airgap.md} (100%) diff --git a/docs/_redirects b/docs/_redirects new file mode 100644 index 0000000000000..0bd6b53d96b0e --- /dev/null +++ b/docs/_redirects @@ -0,0 +1,3 @@ +# Redirect old offline deployments URL to new airgap URL +/install/offline /install/airgap 301 +/install/offline.md /install/airgap.md 301 diff --git a/docs/admin/integrations/index.md b/docs/admin/integrations/index.md index 900925bd2dfd0..6abbf065ceee1 100644 --- a/docs/admin/integrations/index.md +++ b/docs/admin/integrations/index.md @@ -13,6 +13,6 @@ our [installation guides](../../install/index.md). The following resources may help as you're deploying Coder. - [Coder packages: one-click install on cloud providers](https://github.com/coder/packages) -- [Deploy Coder offline](../../install/offline.md) +- [Deploy Coder offline](../../install/airgap.md) - [Supported resources (Terraform registry)](https://registry.terraform.io) - [Writing custom templates](../templates/index.md) diff --git a/docs/admin/networking/index.md b/docs/admin/networking/index.md index 4ab3352b2c19f..4bcacc15461d6 100644 --- a/docs/admin/networking/index.md +++ b/docs/admin/networking/index.md @@ -116,12 +116,12 @@ If a direct connection is not available (e.g. client or server is behind NAT), Coder will use a relayed connection. By default, [Coder uses Google's public STUN server](../../reference/cli/server.md#--derp-server-stun-addresses), but this can be disabled or changed for -[offline deployments](../../install/offline.md). +[offline deployments](../../install/airgap.md). ### Relayed connections By default, your Coder server also runs a built-in DERP relay which can be used -for both public and [offline deployments](../../install/offline.md). +for both public and [offline deployments](../../install/airgap.md). However, our Wireguard integration through Tailscale has graciously allowed us to use diff --git a/docs/changelogs/v0.27.0.md b/docs/changelogs/v0.27.0.md index a37997f942f23..4947e9685d17f 100644 --- a/docs/changelogs/v0.27.0.md +++ b/docs/changelogs/v0.27.0.md @@ -25,7 +25,7 @@ Agent logs can be pushed after a workspace has started (#8528) - Template version messages (#8435) 252772262-087f1338-f1e2-49fb-81f2-358070a46484 - TTL and max TTL validation increased to 30 days (#8258) -- [Self-hosted docs](https://coder.com/docs/install/offline#offline-docs): +- [Self-hosted docs](https://coder.com/docs/install/airgap#offline-docs): Host your own copy of Coder's documentation in your own environment (#8527) (#8601) - Add custom coder bin path for `config-ssh` (#8425) diff --git a/docs/install/offline.md b/docs/install/airgap.md similarity index 100% rename from docs/install/offline.md rename to docs/install/airgap.md diff --git a/docs/manifest.json b/docs/manifest.json index d2784b475d43d..9359fb6f1da33 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -156,7 +156,7 @@ { "title": "Air-gapped Deployments", "description": "Run Coder in air-gapped / disconnected / offline environments", - "path": "./install/offline.md", + "path": "./install/airgap.md", "icon_path": "./images/icons/lan.svg" }, { diff --git a/docs/tutorials/faqs.md b/docs/tutorials/faqs.md index bd386f81288a8..a2f350b45a734 100644 --- a/docs/tutorials/faqs.md +++ b/docs/tutorials/faqs.md @@ -332,7 +332,7 @@ References: ## Can I run Coder in an air-gapped or offline mode? (no Internet)? Yes, Coder can be deployed in -[air-gapped or offline mode](../install/offline.md). +[air-gapped or offline mode](../install/airgap.md). Our product bundles with the Terraform binary so assume access to terraform.io during installation. The docs outline rebuilding the Coder container with From 4a5b0068b1ffa97aea8a0805af0a162826103ed0 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Thu, 28 Aug 2025 19:07:04 +0000 Subject: [PATCH 05/10] docs: Update subsection anchors from offline to airgap - Update 'Offline docs' section header to 'Air-gapped docs' - Add redirects for anchor fragments: - /install/offline#offline-docs -> /install/airgap#airgap-docs - /install/offline#offline-container-images -> /install/airgap#airgap-container-images - Update changelog reference to use new airgap-docs anchor This ensures complete URL consistency including subsection anchors while maintaining backward compatibility for deep links. --- docs/_redirects | 4 ++++ docs/changelogs/v0.27.0.md | 2 +- docs/install/airgap.md | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/_redirects b/docs/_redirects index 0bd6b53d96b0e..1c297339caed0 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,3 +1,7 @@ # Redirect old offline deployments URL to new airgap URL /install/offline /install/airgap 301 /install/offline.md /install/airgap.md 301 + +# Redirect old offline anchor fragments to new airgap anchors +/install/offline#offline-docs /install/airgap#airgap-docs 301 +/install/offline#offline-container-images /install/airgap#airgap-container-images 301 diff --git a/docs/changelogs/v0.27.0.md b/docs/changelogs/v0.27.0.md index 4947e9685d17f..5e06e5a028c3c 100644 --- a/docs/changelogs/v0.27.0.md +++ b/docs/changelogs/v0.27.0.md @@ -25,7 +25,7 @@ Agent logs can be pushed after a workspace has started (#8528) - Template version messages (#8435) 252772262-087f1338-f1e2-49fb-81f2-358070a46484 - TTL and max TTL validation increased to 30 days (#8258) -- [Self-hosted docs](https://coder.com/docs/install/airgap#offline-docs): +- [Self-hosted docs](https://coder.com/docs/install/airgap#airgap-docs): Host your own copy of Coder's documentation in your own environment (#8527) (#8601) - Add custom coder bin path for `config-ssh` (#8425) diff --git a/docs/install/airgap.md b/docs/install/airgap.md index cb2a6632b073f..18853a4a41ad0 100644 --- a/docs/install/airgap.md +++ b/docs/install/airgap.md @@ -212,7 +212,7 @@ coder: -## Offline docs +## Air-gapped docs Coder also provides offline documentation in case you want to host it on your own server. The docs are exported as static files that you can host on any web From f4b962e5411dd69f59d4fd39f645854e82fb91fd Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Thu, 28 Aug 2025 19:14:55 +0000 Subject: [PATCH 06/10] docs: Clean up redirects - remove unnecessary .md redirect Removed /install/offline.md redirect as users don't typically access raw markdown files directly. Kept the essential redirects: - Main page: /install/offline -> /install/airgap - Subsection anchors for deep links --- docs/_redirects | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/_redirects b/docs/_redirects index 1c297339caed0..fdfc401f098f9 100644 --- a/docs/_redirects +++ b/docs/_redirects @@ -1,6 +1,5 @@ # Redirect old offline deployments URL to new airgap URL /install/offline /install/airgap 301 -/install/offline.md /install/airgap.md 301 # Redirect old offline anchor fragments to new airgap anchors /install/offline#offline-docs /install/airgap#airgap-docs 301 From 2b830a3cc1da83bd707c61dc0688cd4fbd40ce1e Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Thu, 28 Aug 2025 21:42:51 +0000 Subject: [PATCH 07/10] docs: Fix remaining 'offline documentation' reference Changed 'offline documentation' to 'air-gapped documentation' in the Air-gapped docs section for complete terminology consistency. --- docs/install/airgap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/airgap.md b/docs/install/airgap.md index 18853a4a41ad0..8c031830ef3f5 100644 --- a/docs/install/airgap.md +++ b/docs/install/airgap.md @@ -214,7 +214,7 @@ coder: ## Air-gapped docs -Coder also provides offline documentation in case you want to host it on your +Coder also provides air-gapped documentation in case you want to host it on your own server. The docs are exported as static files that you can host on any web server, as demonstrated in the example below: From c4cca226b739eccd0c6f98f09d4a507556ebaac4 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 10:29:50 +0000 Subject: [PATCH 08/10] docs: Fix missed 'offline deployments' mentions found in review Updated remaining instances to use 'air-gapped deployments' terminology: - integrations/index.md: 'Deploy Coder offline' -> 'Deploy Coder Air-gapped' - networking/index.md: Multiple 'offline deployments' -> 'Air-gapped deployments' - jfrog-artifactory.md: Section header and text updated - changelogs/v2.8.0.md: Changelog entry updated Thanks to @matifali for catching these missed references! --- docs/admin/integrations/index.md | 2 +- docs/admin/integrations/jfrog-artifactory.md | 4 ++-- docs/admin/networking/index.md | 6 +++--- docs/changelogs/v2.8.0.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/admin/integrations/index.md b/docs/admin/integrations/index.md index 6abbf065ceee1..3a1a11f2448df 100644 --- a/docs/admin/integrations/index.md +++ b/docs/admin/integrations/index.md @@ -13,6 +13,6 @@ our [installation guides](../../install/index.md). The following resources may help as you're deploying Coder. - [Coder packages: one-click install on cloud providers](https://github.com/coder/packages) -- [Deploy Coder offline](../../install/airgap.md) +- [Deploy Coder Air-gapped](../../install/airgap.md) - [Supported resources (Terraform registry)](https://registry.terraform.io) - [Writing custom templates](../templates/index.md) diff --git a/docs/admin/integrations/jfrog-artifactory.md b/docs/admin/integrations/jfrog-artifactory.md index 702bce2599266..06f0bc670fad8 100644 --- a/docs/admin/integrations/jfrog-artifactory.md +++ b/docs/admin/integrations/jfrog-artifactory.md @@ -129,9 +129,9 @@ To set this up, follow these steps: If you don't want to use the official modules, you can read through the [example template](https://github.com/coder/coder/tree/main/examples/jfrog/docker), which uses Docker as the underlying compute. The same concepts apply to all compute types. -## Offline Deployments +## Air-Gapped Deployments -See the [offline deployments](../templates/extending-templates/modules.md#offline-installations) section for instructions on how to use Coder modules in an offline environment with Artifactory. +See the [air-gapped deployments](../templates/extending-templates/modules.md#offline-installations) section for instructions on how to use Coder modules in an offline environment with Artifactory. ## Next Steps diff --git a/docs/admin/networking/index.md b/docs/admin/networking/index.md index 4bcacc15461d6..87cbcd7775c93 100644 --- a/docs/admin/networking/index.md +++ b/docs/admin/networking/index.md @@ -116,12 +116,12 @@ If a direct connection is not available (e.g. client or server is behind NAT), Coder will use a relayed connection. By default, [Coder uses Google's public STUN server](../../reference/cli/server.md#--derp-server-stun-addresses), but this can be disabled or changed for -[offline deployments](../../install/airgap.md). +[Air-gapped deployments](../../install/airgap.md). ### Relayed connections By default, your Coder server also runs a built-in DERP relay which can be used -for both public and [offline deployments](../../install/airgap.md). +for both public and [Air-gapped deployments](../../install/airgap.md). However, our Wireguard integration through Tailscale has graciously allowed us to use @@ -135,7 +135,7 @@ coder server --derp-config-url https://controlplane.tailscale.com/derpmap/defaul #### Custom Relays If you want lower latency than what Tailscale offers or want additional DERP -relays for offline deployments, you may run custom DERP servers. Refer to +relays for air-gapped deployments, you may run custom DERP servers. Refer to [Tailscale's documentation](https://tailscale.com/kb/1118/custom-derp-servers/#why-run-your-own-derp-server) to learn how to set them up. diff --git a/docs/changelogs/v2.8.0.md b/docs/changelogs/v2.8.0.md index e7804ab57b3db..17c37797025f6 100644 --- a/docs/changelogs/v2.8.0.md +++ b/docs/changelogs/v2.8.0.md @@ -83,7 +83,7 @@ ### Documentation -- Using coder modules in offline deployments (#11788) (@matifali) +- Using coder modules in air-gapped deployments (#11788) (@matifali) - Simplify JFrog integration docs (#11787) (@matifali) - Add guide for azure federation (#11864) (@ericpaulsen) - Fix example template README 404s and semantics (#11903) (@ericpaulsen) @@ -104,4 +104,4 @@ Compare: [`v2.7.2...v2.7.3`](https://github.com/coder/coder/compare/v2.7.2...v2. ## Install/upgrade -Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/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. \ No newline at end of file From 3e0d496dfe22ac0d9380e80172cd2183e7360b03 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 13:50:33 +0000 Subject: [PATCH 09/10] docs: Add missing period after 'offline' in first sentence Fixed punctuation in the opening sentence of the air-gapped deployments page. --- docs/install/airgap.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install/airgap.md b/docs/install/airgap.md index 8c031830ef3f5..cb2f2340a63cd 100644 --- a/docs/install/airgap.md +++ b/docs/install/airgap.md @@ -1,6 +1,6 @@ # Air-gapped Deployments -All Coder features are supported in air-gapped / behind firewalls / disconnected / offline +All Coder features are supported in air-gapped / behind firewalls / disconnected / offline. This is a general comparison. Keep reading for a full tutorial running Coder air-gapped with Kubernetes or Docker. From 6c186000a1c9df3a37cb5f44676e5622260d13b1 Mon Sep 17 00:00:00 2001 From: "blink-so[bot]" <211532188+blink-so[bot]@users.noreply.github.com> Date: Fri, 29 Aug 2025 13:55:07 +0000 Subject: [PATCH 10/10] docs: Add missing newline at end of changelog file Fixes lint failure - files must end with a newline character. --- docs/changelogs/v2.8.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelogs/v2.8.0.md b/docs/changelogs/v2.8.0.md index 17c37797025f6..1b17ba3a7343f 100644 --- a/docs/changelogs/v2.8.0.md +++ b/docs/changelogs/v2.8.0.md @@ -104,4 +104,4 @@ Compare: [`v2.7.2...v2.7.3`](https://github.com/coder/coder/compare/v2.7.2...v2. ## Install/upgrade -Refer to our docs to [install](https://coder.com/docs/install) or [upgrade](https://coder.com/docs/admin/upgrade) Coder, or use a release asset below. \ No newline at end of file +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.