Skip to content

docs: replace offline deployments terminology to air-gapped #19625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Aug 29, 2025
Merged

docs: replace offline deployments terminology to air-gapped #19625

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4b203fa
docs: Update offline deployments terminology to air-gapped
blink-so[bot] Aug 28, 2025
c860aa6
fix: Remove trailing spaces from table header to fix formatting
blink-so[bot] Aug 28, 2025
7ac172f
docs: Update navigation title and fix line breaks
blink-so[bot] Aug 28, 2025
46d6c88
docs: Rename offline.md to airgap.md and update all references
blink-so[bot] Aug 28, 2025
4a5b006
docs: Update subsection anchors from offline to airgap
blink-so[bot] Aug 28, 2025
f4b962e
docs: Clean up redirects - remove unnecessary .md redirect
blink-so[bot] Aug 28, 2025
2b830a3
docs: Fix remaining 'offline documentation' reference
blink-so[bot] Aug 28, 2025
c4cca22
docs: Fix missed 'offline deployments' mentions found in review
blink-so[bot] Aug 29, 2025
3e0d496
docs: Add missing period after 'offline' in first sentence
blink-so[bot] Aug 29, 2025
6c18600
docs: Add missing newline at end of changelog file
blink-so[bot] Aug 29, 2025
151d7cc
Merge branch 'main' into blink/update-offline-docs-terminology
david-fraley Aug 29, 2025
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
6 changes: 6 additions & 0 deletions docs/_redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Redirect old offline deployments URL to new airgap URL
/install/offline /install/airgap 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
2 changes: 1 addition & 1 deletion docs/admin/integrations/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- [Deploy Coder offline](../../install/airgap.md)
- [Deploy Coder Air-gapped](../../install/airgap.md)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

✅ Fixed! Updated to "Deploy Coder Air-gapped" along with several other missed mentions I found throughout the docs.

- [Supported resources (Terraform registry)](https://registry.terraform.io)
- [Writing custom templates](../templates/index.md)
4 changes: 2 additions & 2 deletions docs/admin/networking/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
[offline deployments](../../install/airgap.md).
[Air-gapped deployments](../../install/airgap.md).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

✅ Fixed! Updated to "Air-gapped deployments" here and found several other instances throughout the docs that needed the same update.


### 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
Expand Down
2 changes: 1 addition & 1 deletion docs/changelogs/v0.27.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Agent logs can be pushed after a workspace has started (#8528)
- Template version messages (#8435)
<img width="428" alt="252772262-087f1338-f1e2-49fb-81f2-358070a46484" src="https://github.com/coder/coder/assets/22407953/5f6e5e47-e61b-41f1-92fe-f624e92f8bd3">
- TTL and max TTL validation increased to 30 days (#8258)
- [Self-hosted docs](https://coder.com/docs/install/offline#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)
Expand Down
16 changes: 7 additions & 9 deletions docs/install/offline.md → docs/install/airgap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# Offline Deployments

All Coder features are supported in offline / behind firewalls / in air-gapped
environments. However, some changes to your configuration are necessary.
# Air-gapped Deployments

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
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 |
Expand All @@ -16,7 +14,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
Expand Down Expand Up @@ -214,9 +212,9 @@ coder:

</div>

## Offline docs
## 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:

Expand Down
6 changes: 3 additions & 3 deletions docs/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,9 @@
]
},
{
"title": "Offline Deployments",
"description": "Run Coder in offline / air-gapped environments",
"path": "./install/offline.md",
"title": "Air-gapped Deployments",
"description": "Run Coder in air-gapped / disconnected / offline environments",
"path": "./install/airgap.md",
"icon_path": "./images/icons/lan.svg"
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/faqs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading