macOS
These instructions apply to both Intel (x86_64) and Apple Silicon (M1/M2/M3/ARM64) Macs.
Prerequisites
Install the following:
Installation
1. Choose a rack name
Pick a name for your local rack. This name becomes part of the domain used to reach your applications. We will use dev throughout this guide.
2. Start Minikube
Start Minikube with the Docker driver and the insecure registry flag for your rack name:
minikube start \
--driver=docker \
--kubernetes-version=v1.33.0 \
--insecure-registry="registry.dev.macdev.convox.cloud"
Replace dev with your chosen rack name in the --insecure-registry flag.
Check the Convox releases page to find the Kubernetes version for the rack version you want to install.
3. Enable required addons
minikube addons enable ingress
minikube addons enable ingress-dns
4. Install the rack
convox rack install local dev -v 3.24.0 os=mac
Replace 3.24.0 with the latest version from the releases page.
The
os=macparameter is required on macOS. It configures the rack to use*.macdev.convox.cloudinstead of*.localdev.convox.cloud.
5. Start the Minikube tunnel
Open a separate terminal window and run:
minikube tunnel
You must keep this terminal open while using the rack. The tunnel allows your Mac to reach services inside the Minikube cluster.
6. Verify the installation
convox rack -r dev
You should see output like:
Name dev
Provider local
Router router.dev.macdev.convox.cloud
Status running
Version 3.24.0
Using the rack
Switch to your new rack:
convox switch dev
Now all convox commands will target your local rack. You can deploy apps with convox deploy, start local development with convox start, and use all the same commands you would on a production rack.
Your applications will be available at https://<service>.<app>.dev.macdev.convox.cloud.
Browsers will show a certificate warning because the local rack uses self-signed TLS certificates. This is expected.
Management
Rack files
Local rack configuration is stored at:
~/Library/Preferences/convox/racks/<RACK_NAME>
Stopping and starting
minikube stop # pause the cluster (preserves state)
minikube start # resume the cluster
minikube tunnel # remember to restart the tunnel after starting
Uninstalling
To uninstall the rack cleanly:
convox rack uninstall -r <RACK_NAME>
If that fails, you can remove the rack files manually:
rm -rf ~/Library/Preferences/convox/racks/<RACK_NAME>
minikube delete
See Also
- Running Locally for using
convox startto develop locally - Local Development Tutorial for a guided walkthrough