opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-10-30 18:12:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify that Coder server should run on a separate machine (#27468)

Browse Source 
Closes
[DOCS-600](https://linear.app/codercom/issue/DOCS-600/make-it-clear-in-the-quickstart-that-you-should-install-the-coder).

The Quickstart guide has readers install and run `coder server` on the
same machine they're working from, without calling out that this is only
for a quick trial. Coder's actual value comes from remote development,
so hosting the Coder server on a separate machine has a lot more power
than running it locally.

This adds two notes to `docs/get-started/index.md`:
- In **Prerequisites**, explaining that this quickstart runs the server
locally for convenience, but a real deployment should host it on a
separate machine, and linking to the
[Install](https://coder.com/docs/install) page.
- In **Step 2: Install and start Coder**, a shorter reminder right
before the install commands.

----

Created using Coder Agents 🤖

---------

Co-authored-by: Nick Vigilante <nickvigilante@users.noreply.github.com>
This commit is contained in:
earapo13
2026-08-24 08:27:00 -04:00
committed by GitHub
co-authored by Nick Vigilante
parent df6a33ad37
commit defd5d48a1
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/get-started/index.md
+12 -1
View File
@@ -30,10 +30,21 @@ explained through a cooking analogy:
## Prerequisites
- A machine with 2+ CPU cores and 4GB+ RAM
- A machine with 2+ CPU cores and 4GB+ RAM (ideally a separate machine or VM, not your primary dev machine)
- Familiarity with running commands in the terminal
- 10 minutes of your time
<details>
<summary>Why a separate machine?</summary>
Coder's value comes from remote development.
Hosting the Coder server on a separate machine, such as a cloud VM, a spare desktop, or on-premises hardware, gives you and your team infrastructure that's more powerful, always-on, and reachable from anywhere, instead of tying your dev environment to your own laptop.
When you're ready to move past this tutorial, install the Coder server on a separate machine and connect to it remotely.
Refer to the [Install guide](../install/index.md) for supported platforms and installation methods.
</details>
> [!TIP]
> If you use a coding agent like Claude Code, the [coder/skills](https://github.com/coder/skills) `setup` skill can train the coding agent on the following steps (install a container runtime, install Coder, create your first template, and launch a workspace).