Skip to content

Commit 4e7acda

Browse files
authored
feat: document offline docs (coder#1083)
1 parent c6d3bc0 commit 4e7acda

File tree

3 files changed

+23
-0
lines changed

3 files changed

+23
-0
lines changed

assets/setup/offline-docs-links.png

128 KB
Loading

assets/setup/offline-docs.png

998 KB
Loading

setup/air-gapped/offline-docs.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Offline documentation
3+
description: Learn how to use Coder's embedded documentation.
4+
---
5+
6+
While Coder's documentation is hosted at <https://coder.com/docs/coder>, you can
7+
also access it directly via the Coder deplopyment. This may come in handy if
8+
users are connecting via a network without access to `coder.com`.
9+
10+
![Offline docs](../../assets/setup/offline-docs.png)
11+
12+
By default, in-product documentation links will link to `coder.com`. To change
13+
the links to the offline documentation, you can
14+
[upgrade Coder](../upgrade/index.md) with the following Helm value:
15+
16+
```yaml
17+
coderd:
18+
extraEnvs:
19+
- name: USE_OFFLINE_DOCS_LINKS
20+
value: "true"
21+
```
22+
23+
![Links to offline docs](../../assets/setup/offline-docs-links.png)

0 commit comments

Comments
 (0)