diff --git a/docs/images/install/windows-installer.png b/docs/images/install/windows-installer.png new file mode 100644 index 0000000000..5d96cdc5b9 Binary files /dev/null and b/docs/images/install/windows-installer.png differ diff --git a/docs/install/windows.md b/docs/install/windows.md new file mode 100644 index 0000000000..62b80e4ebd --- /dev/null +++ b/docs/install/windows.md @@ -0,0 +1,35 @@ +# Windows + +Use the Windows installer to download the CLI and add Coder to `PATH`. Alternatively, you can install Coder on Windows via a [standalone binary](./binary.md). + +1. Download the Windows installer from [GitHub releases](https://github.com/coder/coder/releases) or from `winget` + + ```powershell + winget install Coder.Coder + ``` + +2. Run the application + + ![Windows installer](../images/install/windows-installer.png) + +3. Start a Coder server + + ```console + # Automatically sets up an external access URL on *.try.coder.app + coder server + + # Requires a PostgreSQL instance (version 13 or higher) and external access URL + coder server --postgres-url --access-url + ``` + + > Set `CODER_ACCESS_URL` to the external URL that users and workspaces will use to + > connect to Coder. This is not required if you are using the tunnel. Learn more + > about Coder's [configuration options](../admin/configure.md). + +4. Visit the Coder URL in the logs to set up your first account, or use the CLI. + +## Next steps + +- [Quickstart](../quickstart.md) +- [Configuring Coder](../admin/configure.md) +- [Templates](../templates.md) diff --git a/docs/manifest.json b/docs/manifest.json index 52bbb0ba4f..d674f22052 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -41,6 +41,11 @@ "description": "Install Coder with Docker / docker-compose", "path": "./install/docker.md" }, + { + "title": "Windows", + "description": "Install Coder on Windows", + "path": "./install/windows.md" + }, { "title": "Standalone binaries", "description": "Download binaries for macOS, Windows, and Linux",