- Notifications
You must be signed in to change notification settings - Fork1k
docs: add documentation about the offline docs#8603
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Changes fromall commits
File filter
Filter by extension
Conversations
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -185,3 +185,15 @@ coder: | ||||||
value: "" | ||||||
# ... | ||||||
``` | ||||||
## Offline 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 server, as demonstrated in the example below: | ||||||
1. Go to the release page. In this case, we want to use the [latest version](https://github.com/coder/coder/releases/latest). | ||||||
2. Download the documentation files from the "Assets" section. It is named as `coder_docs_<version>.tgz`. | ||||||
3. Extract the file and move its contents to your server folder. | ||||||
4. If you are using NodeJS, you can execute the following command: `cd docs && npx http-server .` | ||||||
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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I will make a hotfix for this | ||||||
With these steps, you'll have the Coder documentation hosted on your server and accessible for your team to use. |