Nakama Commands #
Day to day operation of Nakama is straightforward, requiring minimal intervention. There are just a few Nakama commands available, and only three to keep in mind:
nakama #
Running the nakama command by itself will start the server with the default configuration. You can override the configuration default (and configuration file parameters) using command line flags.
migrate #
The Nakama binary contains the schema and a way to upgrade an existing database schema. When you first run Nakama, you need to setup the database schema that Nakama interacts with. Similarly, when a new Nakama version is released, you need to migrate the data schema to that of the new version.
| Command | Description |
|---|---|
migrate up | Creates and updates the database schema to the latest version required by Nakama. By default, the schema is updated sequentially to the latest available. |
migrate down | Downgrades the database schema to the version requested. By default, it downgrades one schema change at a time. |
migrate redo | Downgrades one schema change, and re-applies the change. |
migrate status | Provides information on the schemas currently applied to the database, and if there any are unapplied schemas. |
| Flags | description |
|---|---|
database.address | Database node to connect to. It should follow the form of username:password@address:port/dbname (postgres:// protocol is appended to the path automatically). Defaults to root@localhost:26257. |
--limit | Number of migrations to use when running either up, down, or redo. |
config #
Nakama comes with a default configuration which can be overridden by using a YML Configuration file or by passing command line flags like below:
| |
Command line flags override options set in a config file. Configuration file overrides default config options.
Have a look at Configuration documentation for the complete list of configuration flags.
version #
Use the version command to see the semantic version of your Nakama server instance. For example:
| |
check #
The check command will parse any command line arguments to look up the runtime path, where the server will scan for Lua and Go library files.
help #
Use the help command to display all available configuration flags. These are also available on the Configurations page.
| |
