Commit d2132e8e authored by Evan Read's avatar Evan Read

Refactor macOS install instructions

parent 7218afe8
---
last_updated: 2017-10-09
---
# Install GitLab Runner on macOS
## Homebrew Installation
1. Install the GitLab runner.
GitLab Runner can be installed and updated on macOS.
```bash
brew install gitlab-runner
```
## Installing
1. Install the runner as a service and start it.
There are two methods for installing GitLab Runner on macOS:
```bash
brew services start gitlab-runner
```
- [Manual installation](#manual-installation-official). This method is officially supported and recommended by GitLab.
- [Homebrew installation](#homebrew-installation-alternative). Install with [Homebrew](https://brew.sh) as an alternative to manual installation.
Voila! Runner is installed and running.
### Manual installation (official)
## Manual Installation
CAUTION: **Important:**
With GitLab Runner 10, the executable was renamed to `gitlab-runner`. If you
want to install a version prior to GitLab Runner 10, [visit the old docs](old.md).
NOTE: **Note:**
For documentation on GitLab Runner 9 and earlier, [visit this documentation](old.md).
1. Download the binary for your system:
......@@ -52,41 +40,32 @@ want to install a version prior to GitLab Runner 10, [visit the old docs](old.md
gitlab-runner start
```
Voila! Runner is installed and will be run after a system reboot.
## Manual Update
1. Stop the service:
Runner is installed and will be run after a system reboot.
```bash
gitlab-runner stop
```
### Homebrew installation (alternative)
1. Download the binary to replace the Runner's executable:
A Homebrew [formula is available](https://formulae.brew.sh/formula/gitlab-runner) to install GitLab.
```bash
curl -o /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-darwin-amd64
```
CAUTION: **Caution:**
GitLab does not maintain the Homebrew formula.
You can download a binary for every available version as described in
[Bleeding Edge - download any other tagged release](bleeding-edge.md#download-any-other-tagged-release).
To install GitLab Runner using Homebrew:
1. Give it permissions to execute:
1. Install the GitLab Runner.
```bash
chmod +x /usr/local/bin/gitlab-runner
brew install gitlab-runner
```
1. Start the service:
1. Install the Runner as a service and start it.
```bash
gitlab-runner start
brew services start gitlab-runner
```
Make sure that you read the [FAQ](../faq/README.md) section which describes
some of the most common problems with GitLab Runner.
Runner is installed and running.
## Limitations on macOS
### Limitations on macOS
>**Note:**
The service needs to be installed from the Terminal by running its GUI
......@@ -111,6 +90,38 @@ You can verify that the Runner created the service configuration file after
executing the `install` command, by checking the
`~/Library/LaunchAgents/gitlab-runner.plist` file.
## Manual update
1. Stop the service:
```bash
gitlab-runner stop
```
1. Download the binary to replace the Runner's executable:
```bash
curl -o /usr/local/bin/gitlab-runner https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-darwin-amd64
```
You can download a binary for every available version as described in
[Bleeding Edge - download any other tagged release](bleeding-edge.md#download-any-other-tagged-release).
1. Give it permissions to execute:
```bash
chmod +x /usr/local/bin/gitlab-runner
```
1. Start the service:
```bash
gitlab-runner start
```
Make sure that you read the [FAQ](../faq/README.md) section which describes
some of the most common problems with GitLab Runner.
## Upgrade the service file
In order to upgrade the `LaunchAgent` configuration, you need to uninstall and
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment