Getting started
Installation
Install Rift with Homebrew or from a release binary. No local PHP installation is needed: the binary includes its own runtime.
Requirements
Before starting a project, you need:
- macOS or Linux, with Git (opens in a new tab) installed and Docker (opens in a new tab) running. Docker Desktop (opens in a new tab), OrbStack (opens in a new tab) and Colima (opens in a new tab) are supported ways to run Docker.
- A project using Docker Compose (opens in a new tab) or Laravel Sail (opens in a new tab), with an
.envor.env.examplefile. - Local DNS for
*.test, pointing to127.0.0.1, or to therouter.bindaddress when you set one. See Local DNS below. - Ports 80, 443 and 2019 available for Rift's shared router.
Already running Valet, Herd or Lerd?
They also need ports 80 and 443. You can keep them running: see Running alongside Valet, Herd or Lerd.
Install with Homebrew
Add and trust Rift's tap, then install it with Homebrew (opens in a new tab):
brew tap lucapipolo/rift https://github.com/LucaPipolo/rift
brew trust lucapipolo/rift
brew install rift
To update Rift from then on:
brew upgrade rift
Install from a release binary
Download the binary for your machine from the latest release (opens in a new tab).
| Platform | File |
|---|---|
| macOS, Apple Silicon | rift-darwin-arm64 |
| macOS, Intel | rift-darwin-x86_64 |
| Linux, ARM64 | rift-linux-arm64 |
| Linux, x86-64 | rift-linux-x86_64 |
For example, on an Apple Silicon Mac:
curl -fsSL -o rift https://github.com/LucaPipolo/rift/releases/latest/download/rift-darwin-arm64
chmod +x rift
sudo mv rift /usr/local/bin/rift
To update, download the new release's binary the same way.
Local DNS
Your browser needs to resolve every *.test domain to the router. Rift does not configure DNS for you, so set it up once with a tool such as dnsmasq (opens in a new tab), pointing *.test at 127.0.0.1, or at your router.bind address when you set one.
Once a project is set up, rift doctor checks that its domain resolves to the right address.
Next steps
With Rift installed, follow the Quick start to serve your first project.