Configuration #

A YAML configuration file configures many aspects of how your Nakama server runs. You can run Nakama without specifying a configuration file and rely on the the default settings instead.

Specifying a config file #

You can specify a configuration file at run-time using the --config flag.

1

nakama --config my-special-config.yml

If you are running Nakama via Docker-Compose, you’ll need to bind a folder in your machine so that it’s available in Docker. See the documentation for configuring Nakama running on Docker.

Server ports #

Nakama is a very flexible system. You can exchange data with the server over gRPC, HTTP, Websockets and rUDP. Due to this flexibility, Nakama requires 4 ports to be available to bind to:

• HTTP API server on port 7350. Port can be changed in the config.
• HTTP API server powering the embedded developer console on port 7351. Port can be changed in the config.
• gRPC API server on port 7349. Port is chosen based on the API server port.
• gRPC API server for the embedded console on port 7348. Port is chosen based on the API server port.

Common properties #

There are a few configuration properties that need to be changed in most environments, for example you must change the values of socket.server_key, session.encryption_key and runtime.http_key before you deploy Nakama to a live production environment. The full list of configurations is at the bottom of the page.

Server configuration #

Nakama has various configuration options to make it as flexible as possible for various use cases and deployment environments.

Nakama ships with sane default values for all config options, therefore you’ll only need to override a subset of the options. You can also setup your own config file, and override the values in the config file via command-line flags. For instance, to override Runtime Path:

1

nakama --runtime.path /tmp/my-modules

If fields are not specific, default values will be used. For more information on how to override flags, have a look at the server command-line page.

Cluster #

This section configures how the nodes should connect to each other to form a cluster.

Console #

This section defined the configuration related for the embedded developer console.

Database #

Nakama requires a CockroachDB server instance to be available. Nakama creates and manages its own database called nakama within the CockroachDB database.

You can pass in multiple database addresses to Nakama via command like:

1

nakama --database.address "root@db1:26257" --database.address "root@db2:26257"

IAP (In-App Purchase) #

Nakama can verify in-app purchases by connecting to various stores and keeps a ledger of valid purchases. This is useful for preventing common in-app purchase replay attacks with valid receipts, as well as restoring purchases for user accounts as needed.

Apple #

Apple In-App Purchase configuration

Google #

Google In-App Purchase configuration

Huawei #

Leaderboard #

You can change configuration options related to the leaderboard and tournament systems.

Logger #

Nakama produces logs in JSON format so various systems can interact with the logs. By default they are written to the standard out (console).

The standard startup log messages will always be printed to the console irrespective of the value of logger.stdout field.

Match #

You can change configuration options related to the authoritative multiplayer runtime.

Metrics #

Nakama produces metrics information. This information can be exported to Prometheus.

Ensure that metrics exports are protected as they contain sensitive server information.

Runtime #

Options related to the runtime engine.

The runtime environment is a key-value pair. They are separated by the = character like this:

1

nakama --runtime.env "key=value" --runtime.env "key2=value2" --runtime.env "key3=valuecanhave=sign"

Satori #

Nakama can connect to Satori via the server runtime.

Session #

You can change configuration options related to each user , such as the encryption key used to create the token.

Social #

Nakama can connect to various social networks to fetch user information. It can also act as a notification center for delivering and persisting notifications.

Apple #

Configuration related to Apple iOS/iPadOS apps.

Steam #

Configure Steam network settings. Facebook, Google and GameCenter don’t require any server settings.

Facebook Instant Game #

Configuration relevant to Facebook Instant Games.

Socket #

Options related to connection socket and transport protocol between the server and clients.

Tracker #

You can change configuration options related to session tracking.

Matchmaker #

You can change configuration options related to matchmaking.

Google Auth #

You can change configuration options related to Google Auth.

Example file #

You can use the entire file or just a subset of the configuration.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

name: nakama-node-1
data_dir: "./data/"

logger:
  stdout: false
  level: "warn"
  file: "/tmp/path/to/logfile.log"
  rotation: false
  max_size: 100
  max_age: 0
  max_backups: 0
  local_time: false
  compress: false

metrics:
  reporting_freq_sec: 60
  namespace: ""
  prometheus_port: 7354

database:
  address:
    - "root@localhost:26257"
  conn_max_lifetime_ms: 0
  max_open_conns: 0
  max_idle_conns: 100

runtime:
  env:
    - "example_apikey=example_apivalue"
    - "encryptionkey=afefa==e332*u13=971mldq"
  path: "/tmp/modules/folders"
  http_key: "defaulthttpkey"

socket:
  server_key: "defaultkey"
  port: 7350
  max_message_size_bytes: 4096 # bytes
  read_timeout_ms: 10000
  write_timeout_ms: 10000
  idle_timeout_ms: 60000
  write_wait_ms: 5000
  pong_wait_ms: 10000
  ping_period_ms: 8000 # Must be less than pong_wait_ms
  outgoing_queue_size: 16

session:
  encryption_key: "defaultencryptionkey"
  token_expiry_sec: 60
    refresh_encryption_key: "defaultrefreshencryptionkey"
    refresh_token_expiry_sec: 3600

social:
  steam:
  publisher_key: ""
  app_id: 0

console:
  port: 7351
  username: "admin"
  password: "password"

cluster:
  join:
    - "10.0.0.2:7352"
    - "10.0.0.3:7352"
  gossip_bindaddr: "0.0.0.0"
  gossip_bindport: 7352
  rpc_port: 7353
  local_priority: true
  work_factor_interval_ms: 1000

tracker:
  max_delta_sizes:
    - 100
    - 1000
    - 10000

matchmaker:
  max_tickets: 2
  interval_sec: 15
  max_intervals: 3

iap:
  apple:
    shared_password: "password"
  google:
    client_email: "email@google.com"
    private_key: "pk"
  huawei:
    public_key: "pk"
    client_id: "id"
    client_secret: "secret"