diff --git a/docs/images/install/homebrew.png b/docs/images/install/homebrew.png new file mode 100644 index 0000000000000..471cea4192746 Binary files /dev/null and b/docs/images/install/homebrew.png differ diff --git a/docs/install/install.sh.md b/docs/install/install.sh.md index 7b278676a9fae..93c04d74d573f 100644 --- a/docs/install/install.sh.md +++ b/docs/install/install.sh.md @@ -4,20 +4,27 @@ and macOS. To install, run: -```bash +```shell +# This will automatically use supported package managers when available curl -fsSL https://coder.com/install.sh | sh ``` +To install without using a system package manager: + +```shell +curl -fsSL https://coder.com/install.sh | sh -s -- --method standalone +``` + You can preview what occurs during the install process: -```bash +```shell curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run ``` You can modify the installation process by including flags. Run the help command for reference: -```bash +```shell curl -fsSL https://coder.com/install.sh | sh -s -- --help ``` diff --git a/docs/install/macos.md b/docs/install/macos.md new file mode 100644 index 0000000000000..18b9f0b32652e --- /dev/null +++ b/docs/install/macos.md @@ -0,0 +1,35 @@ +# macOS + +You can use [Homebrew](https://brew.sh) to install the `coder` command. Homebrew +is recommended, but you can also use our [install script](./install.sh.md) or +download a [standalone binary](./binary.md). + +1. Install Coder from our official + [Homebrew tap](https://github.com/coder/homebrew-coder) + + ```console + brew install coder/coder/coder + ``` + + ![Homebrew output from installing Coder](../images/install/homebrew.png) + +2. 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). + +3. Visit the Coder URL in the logs to set up your first account, or use the CLI. + +## Next steps + +- [Configuring Coder](../admin/configure.md) +- [Templates](../templates/index.md) diff --git a/docs/manifest.json b/docs/manifest.json index 8c18bb26ad9f5..2ad15b2a13402 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -31,6 +31,11 @@ "description": "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine", "path": "./install/packages.md" }, + { + "title": "macOS", + "description": "Install Coder using our Homebrew tap", + "path": "./install/macos.md" + }, { "title": "Kubernetes", "description": "Install Coder with Kubernetes via Helm",