Skip to content

Commit 16cd1a6

Browse files
docs: add documentation about the offline docs (coder#8603)
1 parent 0e52461 commit 16cd1a6

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/install/offline.md

+12
Original file line numberDiff line numberDiff line change
@@ -185,3 +185,15 @@ coder:
185185
value: ""
186186
# ...
187187
```
188+
189+
## Offline docs
190+
191+
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 server, as demonstrated in the example below:
192+
193+
1. Go to the release page. In this case, we want to use the [latest version](https://github.com/coder/coder/releases/latest).
194+
2. Download the documentation files from the "Assets" section. It is named as `coder_docs_<version>.tgz`.
195+
3. Extract the file and move its contents to your server folder.
196+
4. If you are using NodeJS, you can execute the following command: `cd docs && npx http-server .`
197+
5. Set the `CODER_DOCS_URL` environment variable to use the URL of your hosted docs. This way, the Coder UI will reference the documentation from your specified URL.
198+
199+
With these steps, you'll have the Coder documentation hosted on your server and accessible for your team to use.

0 commit comments

Comments
 (0)