Take snapshots, remove, and re-install Nakama without affecting your primary operating system
Enjoy a quick and simplified installation experience regardless of your OS
Following this guide, you will use Docker Compose to quickly and easily define all the necessary services and run your local development instance of Nakama.
Copy and paste the contents of your preferred option into your docker-compose.yml file.
Windows Users
You must edit the nakama:volumes: entry in your docker-compose.yml file so that it looks like the following: /c/Users/<username>/projects/docker:/nakama/data.
Open a Terminal window and navigate to your Nakama directory. For example:
1
cd desktop/nakama
To pull all required images and start your application, run the following:
1
docker compose up
Congratulations! Your Nakama server is now up and running, available at 127.0.0.1:7350.
Nakama containers running
Use the Open in Visual Studio Code button (or that for your IDE) to edit your docker-compose.yml file directly.
When prompted to login, the default credentials are admin for username and password for password. These can be changed via configuration file or command-line flags.
Nakama reads settings from a YAML configuration file. If no file is supplied, Nakama starts with built-in defaults. Start with the Server configuration guide to learn how to supply a config file, which options to change first, and how to override values at startup.
When running in Docker, mount the file into the Nakama container and reference it with the --config flag in docker-compose.yml so the server reads it at startup. For step-by-step instructions and examples, see the Docker configuration guide.