If you'd like to run Kubernetes locally, please see our local Kubernetes guide for installation and usage information.
If you want to install Garden from source, see the instructions in our contributor guide.
You need the following dependencies on your local machine to use Garden:
Git (v2.14 or newer)
rsync (v3.1.0 or newer)
And if you'd like to build and run services locally, you need a local installation of Kubernetes. Garden is committed to supporting the latest six stable versions (i.e. if the latest stable version is v1.17.x, Garden supports v1.12.x and newer).
For Mac, we recommend the following steps to install Garden. You can also follow the manual installation steps below if you prefer.
This will significantly speed up the first Garden build of large projects on Windows machines.
Note that you must run Powershell with elevated permissions when you execute this command.
Step 1: Install core dependencies
Use your preferred method or package manager to install git and rsync. On Ubuntu, that's sudo apt install git rsync, on Alpine apk add --no-cache git rsync
The Alpine linux distribution also requires gcc to be installed: apk add --no-cache gcc.
Step 2: Install Garden
Installation script (Linux)
You can use our installation script to install Garden automatically:
curl -sL https://get.garden.io/install.sh |bash
To later upgrade to the latest version, simply run the script again.
Manual download and install (Linux)
If you prefer, you can perform the installation manually, as follows:
Visit the Garden releases page on GitHub and download the linux archive (under Assets).
Next create a ~/.garden/bin directory, and extract the archive to that directory. Make sure to include the whole contents of the archive.
Lastly, either add the ~/.garden/bin directory to your PATH, or add a symlink from your /usr/local/bin/garden to the binary at ~/.garden/bin/garden.
Step 3 (optional): Local Kubernetes
If you'd like to use a local Kubernetes cluster, please refer to the local Kubernetes guide for installation and usage information.
Using Garden with proxies
If you're running Garden behind a firewall, you may need to use a proxy to route external requests. To do this, you need to set the HTTP_PROXY, HTTPS_PROXY and NO_PROXY environment variables. For example:
exportHTTP_PROXY=http://localhost:9999 # <- Replace with your proxy address.
exportHTTPS_PROXY=$HTTP_PROXY# <- Replace if you use a separate proxy for HTTPS.
exportNO_PROXY=local.app.garden,localhost,127.0.0.1 # <- This is important! See below.
The NO_PROXY variable should include any other hostnames you might use for local development, since you likely don't want to route local traffic through the proxy.