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.

Sign up for GitHub

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

docs: add macOS installation page #9443

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f930373
docs: add macOS installation page
aslilac Aug 30, 2023
61cc420
🧼
aslilac Aug 30, 2023
fb39a0c
tweak docs a bit more
aslilac Aug 30, 2023
4539883
blah
aslilac Aug 30, 2023
3e18e6f
fix lang tag
aslilac Aug 30, 2023
d4c2816
-= "is"
aslilac Aug 30, 2023
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
Next Next commit
docs: add macOS installation page
  • Loading branch information
@aslilac
aslilac committed Aug 30, 2023
commit f9303739869a55d2bf847e4da547372da801bfac
Binary file added docs/images/install/homebrew.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions docs/install/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 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).

4. 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)