docs: add macOS installation page (#9443)

This commit is contained in:
Kayla Washburn
2023-08-30 14:37:51 -06:00
committed by GitHub
parent 53a5f18ba4
commit d2462e5b88
4 changed files with 50 additions and 3 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 MiB

View File

@ -4,20 +4,27 @@ and macOS.
To install, run: To install, run:
```bash ```shell
# This will automatically use supported package managers when available
curl -fsSL https://coder.com/install.sh | sh 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: You can preview what occurs during the install process:
```bash ```shell
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
``` ```
You can modify the installation process by including flags. Run the help command You can modify the installation process by including flags. Run the help command
for reference: for reference:
```bash ```shell
curl -fsSL https://coder.com/install.sh | sh -s -- --help curl -fsSL https://coder.com/install.sh | sh -s -- --help
``` ```

35
docs/install/macos.md Normal file
View File

@ -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 <url> --access-url <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)

View File

@ -31,6 +31,11 @@
"description": "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine", "description": "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine",
"path": "./install/packages.md" "path": "./install/packages.md"
}, },
{
"title": "macOS",
"description": "Install Coder using our Homebrew tap",
"path": "./install/macos.md"
},
{ {
"title": "Kubernetes", "title": "Kubernetes",
"description": "Install Coder with Kubernetes via Helm", "description": "Install Coder with Kubernetes via Helm",