You are browsing documentation for a version of Kuma that is not the latest release.
Looking for even older versions? Learn more.
If you only want the CLI, you can always use homebrew
brew install kumactl.
To install and run Kuma execute the following steps:
Finally, you can follow the Quickstart to take it from here and continue your Kuma journey.
Run the following script to automatically detect the operating system and download Kuma:
curl -L https://kuma.io/installer.sh | VERSION=1.7.5 sh -
or you can download the distribution manually.
Then extract the archive with:
tar xvzf kuma-1.7.5.
Make sure you have tar and gzip installed.
Once downloaded, you will find the contents of Kuma in the
kuma-1.7.5 folder. In this folder, you will find - among other files - the
bin directory that stores all the executables for Kuma.
You can start the control-plane with:
This example will run Kuma in
standalone mode for a “flat” deployment, but there are more advanced
We suggest adding the
kumactl executable to your
PATH so that it’s always available in every working directory. Or - alternatively - you can also create link in
/usr/local/bin/ by executing:
ln -s kuma-1.7.5/bin/kumactl /usr/local/bin/kumactl
Note: By default this will run Kuma with a
memory store, but for production you have to use a persistent storage like PostgreSQL by updating the
kuma-cp) is now running! Now that Kuma has been installed you can access the control-plane via either the GUI, the HTTP API, or the CLI:
Kuma ships with a read-only GUI that you can use to retrieve Kuma resources. By default the GUI listens on the API port and defaults to
To access Kuma you can navigate to
127.0.0.1:5681/gui to see the GUI.
You will notice that Kuma automatically creates a
entity with name
Congratulations! You have successfully installed Kuma 🚀.
In order to start using Kuma, it’s time to check out the quickstart guide for Universal deployments.