docs: update air-gapped registry modules usage instructions #19402
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add Coder Registry row to offline deployment comparison table - Add detailed 'Using Registry Modules Offline' section with three deployment options: - Git repository (recommended) - Private Terraform registry - Vendored modules - Include code examples and offline parameter usage - Reference existing modules documentation Addresses customer needs for using registry.coder.com modules in network-restricted environments.
Fixes markdownlint MD031 errors by adding required blank lines around fenced code blocks and specifies language for directory structure.
matifali
reviewed
Aug 19, 2025
docs/install/offline.md
Outdated
Comment on lines
298
to
310
| ### Module Offline Support | ||
|
|
||
| Many registry modules support offline operation with the `offline` parameter: | ||
|
|
||
| ```tf | ||
| module "code_server" { | ||
| source = "registry.coder.com/coder/code-server/coder" | ||
| version = "1.0.19" | ||
| agent_id = coder_agent.example.id | ||
| offline = true # Prevents downloading from external sources | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Delete this whole section and the example of module offline support. add back the link to offline modules in extending templates.
There was a problem hiding this comment.
Why did you remove everything?
There was a problem hiding this comment.
I removed the detailed "Using Registry Modules Offline" section because you requested it in your previous review comment: "Delete this whole section and the example of module offline support. add back the link to offline modules in extending templates."
I followed your feedback exactly:
- ✅ Deleted the entire detailed section
- ✅ Removed the module offline support examples
- ✅ Added back the simple "Coder Modules" section with link to extending templates
- ✅ Kept the "Coder Registry" row in the comparison table (the original request)
Would you like me to restore some of the content? I can add back specific parts if needed.
matifali
reviewed
Aug 19, 2025
docs/install/offline.md
Outdated
Comment on lines
244
to
266
| Mirror registry modules in an internal Git repository: | ||
|
|
||
| 1. **Download modules** from [registry.coder.com](https://registry.coder.com) while connected to the internet | ||
| 2. **Store modules** in your internal Git repository: | ||
|
|
||
| ```text | ||
| internal-registry/ | ||
| ├── modules/ | ||
| │ ├── code-server/ | ||
| │ ├── cursor/ | ||
| │ └── vscode-web/ | ||
| └── templates/ | ||
| ``` | ||
|
|
||
| 3. **Reference modules** using Git source addresses: | ||
|
|
||
| ```tf | ||
| module "code_server" { | ||
| source = "git::https://your-internal-git.com/coder-modules.git//modules/code-server?ref=v1.0.19" | ||
| agent_id = coder_agent.example.id | ||
| offline = true # Prevent external downloads | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Make it more explicit, taking care of the new `registry/namespace/modules/module-name structure.
matifali
approved these changes
Aug 19, 2025
- Remove redundant 'Coder Modules' section as requested - Update directory structure to reflect registry/namespace/modules/module-name format - Make Git source paths more explicit with proper registry structure Addresses review comments from @matifali
- Remove entire 'Using Registry Modules Offline' section as requested - Add back simple 'Coder Modules' section with link to extending templates - Keep the Coder Registry row in the comparison table Addresses review comment from @matifali to simplify the documentation.
Fixes markdown linter error MD051 by updating the link to reference the existing 'Coder Modules' section instead of the removed section.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive documentation for using Coder Registry modules in air-gapped and network-restricted deployments to the offline deployment guide.
Changes
offline = trueparameter for preventing external downloadsKey Features
Context
This addresses the documentation gap for customers deploying Coder in secure, air-gapped environments who need to use registry.coder.com modules without internet access. The documentation now provides clear guidance on how to mirror, vendor, or use private registries for these modules.
Testing