Skip to content

Commit d2462e5

Browse files
authored
docs: add macOS installation page (#9443)
1 parent 53a5f18 commit d2462e5

File tree

4 files changed

+50
-3
lines changed

4 files changed

+50
-3
lines changed

docs/images/install/homebrew.png

1.97 MB
Loading

docs/install/install.sh.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,27 @@ and macOS.
44

55
To install, run:
66

7-
```bash
7+
```shell
8+
# This will automatically use supported package managers when available
89
curl -fsSL https://coder.com/install.sh | sh
910
```
1011

12+
To install without using a system package manager:
13+
14+
```shell
15+
curl -fsSL https://coder.com/install.sh | sh -s -- --method standalone
16+
```
17+
1118
You can preview what occurs during the install process:
1219

13-
```bash
20+
```shell
1421
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
1522
```
1623

1724
You can modify the installation process by including flags. Run the help command
1825
for reference:
1926

20-
```bash
27+
```shell
2128
curl -fsSL https://coder.com/install.sh | sh -s -- --help
2229
```
2330

docs/install/macos.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# macOS
2+
3+
You can use [Homebrew](https://brew.sh) to install the `coder` command. Homebrew
4+
is recommended, but you can also use our [install script](./install.sh.md) or
5+
download a [standalone binary](./binary.md).
6+
7+
1. Install Coder from our official
8+
[Homebrew tap](https://github.com/coder/homebrew-coder)
9+
10+
```console
11+
brew install coder/coder/coder
12+
```
13+
14+
![Homebrew output from installing Coder](../images/install/homebrew.png)
15+
16+
2. Start a Coder server
17+
18+
```console
19+
# Automatically sets up an external access URL on *.try.coder.app
20+
coder server
21+
22+
# Requires a PostgreSQL instance (version 13 or higher) and external access URL
23+
coder server --postgres-url <url> --access-url <url>
24+
```
25+
26+
> Set `CODER_ACCESS_URL` to the external URL that users and workspaces will
27+
> use to connect to Coder. This is not required if you are using the tunnel.
28+
> Learn more about Coder's [configuration options](../admin/configure.md).
29+
30+
3. Visit the Coder URL in the logs to set up your first account, or use the CLI.
31+
32+
## Next steps
33+
34+
- [Configuring Coder](../admin/configure.md)
35+
- [Templates](../templates/index.md)

docs/manifest.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@
3131
"description": "System packages for Debian, Ubuntu, Fedora, CentOS, RHEL, SUSE, and Alpine",
3232
"path": "./install/packages.md"
3333
},
34+
{
35+
"title": "macOS",
36+
"description": "Install Coder using our Homebrew tap",
37+
"path": "./install/macos.md"
38+
},
3439
{
3540
"title": "Kubernetes",
3641
"description": "Install Coder with Kubernetes via Helm",

0 commit comments

Comments
 (0)