Install Nakama Binary for macOS¶
This tutorial will show you how to setup and run Nakama binary and its prerequisites on macOS.
The binary setup allows you to install and manage Nakama without Docker but it requires extra steps to setup and manage:
- Installing CockroachDB or PostgreSQL
- Manually applying database migrations
- Manually upgrading Nakama and its database to newer versions
- Configuring services or manually starting Nakama and its database
Docker is the quickest way to download and start developing with Nakama.
Before proceeding ensure that you are running macOS 10.9 (Mavericks) or higher with a X86_64 (64bit) processor architecture.
Next, install a supported database engine.
Nakama officially supports CockroachDB v20.0 or higher, with queries optimised for its storage engine.
Install CockroachDB via one the official supported methods:
- Build from source
Nakama unofficially supports PostgreSQL 9.6 or higher for development environments only.
Install PostgreSQL via:
Get the latest binary release of Nakama server for macOS:
- Download a release from the Nakama GitHub repo releases page
- Extract the archive, optionally rename and move the folder to a suitable location
Before starting Nakama server you will need to run:
- Your chosen database, CockroachDB or PostgreSQL.
- Nakama database migrations if it is your first time running Nakama or you have upgraded Nakama versions.
If this is your first time running Nakama or you have upgraded Nakama versions, you may need to run Nakama database migrations. If you are unsure, running migrations again is safe.
If you are running CockroachDB with the default configuration, running migrations is straightforward with no additional options necessary.
If you are using PosgreSQL you will need to supply your database server address, user and password.
To run Nakama migrations, navigate to your Nakama directory and run the following:
./nakama migrate up
./nakama migrate up --database.address postgres:firstname.lastname@example.org:5432
To start Nakama server with CockroachDB or PostgreSQL, navigate to your Nakama directory and run the following:
./nakama --database.address postgres:email@example.com:5432
You will need to provide the same
database.address value used for running Nakama PostgreSQL database migrations:
You can also access the Nakama Console by navigating your browser to
When prompted to login, the default credentials are
admin:password. These can be changed via configuration file or command-line flags.
There are many configuration options available that you can customize for your Nakama server.
With your Nakama server now up and running with the desired configuration, you can get started with your preferred client SDK: