# macOS

To install and run Kuma on macOS execute the following steps:

Finally you can follow the Quickstart to take it from here and continue your Kuma journey.

# 1. Download Kuma

To run Kuma on macOS you can choose among different installation methods:

    # 2. Run Kuma

    Once downloaded, you will find the contents of Kuma in the kuma-1.0.0 folder. In this folder, you will find - among other files - the bin directory that stores all the executables for Kuma.

    So we enter the bin folder by executing:

    $ cd kuma-1.0.0/bin

    And we can then proceed to run Kuma with:

    $ ./kuma-cp run

    This example will run Kuma in standalone mode for a "flat" deployment, but there are more advanced deployment modes like "multi-zone".

    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 ./kumactl /usr/local/bin/kumactl

    Note: By default this will run Kuma with a memory backend, but you can use a persistent storage like PostgreSQL by updating the conf/kuma-cp.conf file.

    # 3. Use Kuma

    Kuma (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:

      You will notice that Kuma automatically creates a Mesh entity with name default.

      # 4. Quickstart

      Congratulations! You have successfully installed Kuma on macOS 🚀.

      In order to start using Kuma, it's time to check out the quickstart guide for Universal deployments.

      Last Updated: 4/21/2021, 8:30:00 PM