Skip to content

docs: add macOS installation page #9443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/install/homebrew.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions docs/install/install.sh.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,27 @@ and macOS.

To install, run:

```bash
```console
# This is will automatically use supported package managers when available
curl -fsSL https://coder.com/install.sh | sh
```

To install without using a system package manager:

```console
curl -fsSL https://coder.com/install.sh | sh -s -- --method standalone
```

You can preview what occurs during the install process:

```bash
```console
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
```console
curl -fsSL https://coder.com/install.sh | sh -s -- --help
```

Expand Down
35 changes: 35 additions & 0 deletions docs/install/macos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# macOS

You can use [Homebrew](https://brew.sh) to install the `coder` command. Homebrew
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this whole doc should go in the system packages section.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see both sides. I think it's nice to give macOS parity with Windows by giving users of them each an obvious page to look at.

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)
5 changes: 5 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down