docs: add usage in Coder (#5975)
* docs: add difference between Coder Add a short block explaining the difference between code-server and Coder. * docs: add new doc coder.md under Install This adds a new doc explaining how to install code-server in a Coder workspace using Terraform.
This commit is contained in:
parent
96d9c5eb0f
commit
401d423dfd
10
docs/FAQ.md
10
docs/FAQ.md
@ -26,6 +26,7 @@
|
|||||||
- [Is multi-tenancy possible?](#is-multi-tenancy-possible)
|
- [Is multi-tenancy possible?](#is-multi-tenancy-possible)
|
||||||
- [Can I use Docker in a code-server container?](#can-i-use-docker-in-a-code-server-container)
|
- [Can I use Docker in a code-server container?](#can-i-use-docker-in-a-code-server-container)
|
||||||
- [How do I disable telemetry?](#how-do-i-disable-telemetry)
|
- [How do I disable telemetry?](#how-do-i-disable-telemetry)
|
||||||
|
- [What's the difference between code-server and Coder?](#whats-the-difference-between-code-server-and-coder)
|
||||||
- [What's the difference between code-server and Theia?](#whats-the-difference-between-code-server-and-theia)
|
- [What's the difference between code-server and Theia?](#whats-the-difference-between-code-server-and-theia)
|
||||||
- [What's the difference between code-server and OpenVSCode-Server?](#whats-the-difference-between-code-server-and-openvscode-server)
|
- [What's the difference between code-server and OpenVSCode-Server?](#whats-the-difference-between-code-server-and-openvscode-server)
|
||||||
- [What's the difference between code-server and GitHub Codespaces?](#whats-the-difference-between-code-server-and-github-codespaces)
|
- [What's the difference between code-server and GitHub Codespaces?](#whats-the-difference-between-code-server-and-github-codespaces)
|
||||||
@ -363,6 +364,15 @@ Use the `--disable-telemetry` flag to disable telemetry.
|
|||||||
|
|
||||||
> We use the data collected only to improve code-server.
|
> We use the data collected only to improve code-server.
|
||||||
|
|
||||||
|
## What's the difference between code-server and Coder?
|
||||||
|
|
||||||
|
code-server and Coder are both applications that can be installed on any
|
||||||
|
machine. The main difference is who they serve. Out of the box, code-server is
|
||||||
|
simply VS Code in the browser while Coder is a tool for provisioning remote
|
||||||
|
development environments via Terraform.
|
||||||
|
|
||||||
|
code-server was built for individuals while Coder was built for teams. In Coder, you create Workspaces which can have applications like code-server. If you're looking for a team solution, you should reach for [Coder](https://github.com/coder/coder).
|
||||||
|
|
||||||
## What's the difference between code-server and Theia?
|
## What's the difference between code-server and Theia?
|
||||||
|
|
||||||
At a high level, code-server is a patched fork of VS Code that runs in the
|
At a high level, code-server is a patched fork of VS Code that runs in the
|
||||||
|
37
docs/coder.md
Normal file
37
docs/coder.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
# Coder
|
||||||
|
|
||||||
|
To install and run code-server in a Coder workspace, we suggest using the `install.sh`
|
||||||
|
script in your template like so:
|
||||||
|
|
||||||
|
```terraform
|
||||||
|
resource "coder_agent" "dev" {
|
||||||
|
arch = "amd64"
|
||||||
|
os = "linux"
|
||||||
|
startup_script = <<EOF
|
||||||
|
#!/bin/sh
|
||||||
|
set -x
|
||||||
|
# install and start code-server
|
||||||
|
curl -fsSL https://code-server.dev/install.sh | sh -s -- --version 4.8.3
|
||||||
|
code-server --auth none --port 13337 &
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
resource "coder_app" "code-server" {
|
||||||
|
agent_id = coder_agent.dev.id
|
||||||
|
slug = "code-server"
|
||||||
|
display_name = "code-server"
|
||||||
|
url = "http://localhost:13337/"
|
||||||
|
icon = "/icon/code.svg"
|
||||||
|
subdomain = false
|
||||||
|
share = "owner"
|
||||||
|
|
||||||
|
healthcheck {
|
||||||
|
url = "http://localhost:13337/healthz"
|
||||||
|
interval = 3
|
||||||
|
threshold = 10
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
If you run into issues, ask for help on the `coder/coder` [Discussions
|
||||||
|
here](https://github.com/coder/coder/discussions).
|
@ -37,6 +37,11 @@
|
|||||||
"icon_path": "assets/images/icons/usage.svg",
|
"icon_path": "assets/images/icons/usage.svg",
|
||||||
"path": "./guide.md",
|
"path": "./guide.md",
|
||||||
"children": [
|
"children": [
|
||||||
|
{
|
||||||
|
"title": "Coder",
|
||||||
|
"description": "How to run code-server in Coder",
|
||||||
|
"path": "./coder.md"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"title": "--link",
|
"title": "--link",
|
||||||
"description": "How to run code-server --link",
|
"description": "How to run code-server --link",
|
||||||
|
Reference in New Issue
Block a user