macOS Installation

Packages

• Homebrew Formula

---

Installation

1. Install Kong

   Use the Homebrew package manager to add Kong as a tap and install it:

    $ brew tap kong/kong
    $ brew install kong
   

2. Add kong.conf

   Note: This step is required if you are using Cassandra; it is optional for Postgres users.

   By default, Kong is configured to communicate with a local Postgres instance. If you are using Cassandra, or need to modify any settings, download the kong.conf.default file and adjust it as necessary. Then, as root, add it to /etc:

    $ sudo mkdir -p /etc/kong
    $ sudo cp kong.conf.default /etc/kong/kong.conf
   

3. Prepare your database

   Configure Kong so it can connect to your database. Kong supports both PostgreSQL 9.5+ and Cassandra 3.x.x as its datastore.

   If you are using Postgres, provision a database and a user before starting Kong:

    CREATE USER kong; CREATE DATABASE kong OWNER kong;
   

   Next, run the Kong migrations:

    $ kong migrations bootstrap [-c /path/to/kong.conf]
   

   Note for Kong < 0.15: with Kong versions below 0.15 (up to 0.14), use the up sub-command instead of bootstrap. Also note that with Kong < 0.15, migrations should never be run concurrently; only one Kong node should be performing migrations at a time. This limitation is lifted for Kong 0.15, 1.0, and above.

4. Start Kong

    $ kong start [-c /path/to/kong.conf]
   

5. Use Kong

   Verify that Kong is running:

    $ curl -i http://localhost:8001/
   

   Quickly learn how to use Kong with the 5-minute Quickstart.

---