Quickstart

Before you startCopy Anchor Link

The live demo needs no installation or provider credentials. To send messages on your own instance, choose a model provider during setup. Some providers use an API key; others use account sign-in or a local model. See Providers.

Install Bun only if you run from source. Managed hosting and Docker do not need it.

Choose a deployment pathCopy Anchor Link

Option 1: Try the demoCopy Anchor Link

Explore a live instance without installing anything. Open https://demo.getnakama.cloud and sign in with:

• Username: demo@getnakama.cloud
• Password: demo1234

The demo is shared and reset periodically — use it to click around the dashboard, not for real data or API keys.

Option 2: Managed hostingCopy Anchor Link

If you do not want to run your own server, use Nakama Cloud. Sign up, create an instance, and open your dedicated URL (for example acme.getnakama.cloud).

Complete the setup wizard in the browser and you are live. Skip to First-time setup.

Option 3: DockerCopy Anchor Link

For a single-container deployment:

docker pull ghcr.io/ahmadrosid/nakama:latest
docker run -d -p 4310:4310 -v nakama-data:/nakama/data --name nakama ghcr.io/ahmadrosid/nakama:latest

Open http://localhost:4310. See Docker for build-from-source, volumes, and production notes.

Option 4: Local developmentCopy Anchor Link

Clone the repository and install dependencies:

git clone https://github.com/ahmadrosid/nakama.git
cd nakama
bun install
bun run dev:web

Open:

• Dashboard: http://localhost:3003
• API server: http://127.0.0.1:4310
• API docs: http://127.0.0.1:4310/docs

If you only want the API server:

bun run dev:server

On first run, the browser setup wizard guides you through creating an admin account and organization, then configuring a model provider. Local settings are saved in ~/.nakama/config.ini.

First-time setupCopy Anchor Link

After Nakama is running:

1. Open the dashboard
2. Create the first admin account and first organization
3. Configure your model provider
4. Create or review profiles
5. Send a test message to the default profile

See First-time setup for the wizard walkthrough and Providers for supported LLM backends.

Common next stepsCopy Anchor Link

Connect a channelCopy Anchor Link

Use the web dashboard, CLI, Telegram, WhatsApp, or Discord:

• CLI
• Telegram
• WhatsApp
• Discord

Understand the mental modelCopy Anchor Link

Most of Nakama fits four ideas: organization, profile, tool access, and channel. See Overview.

Next stepsCopy Anchor Link

• Overview — what Nakama is and how to think about it
• Providers — LLM API keys and model setup
• Profiles — how to define each bot
• Multi-tenancy — orgs, members, and roles
• Documentation hub — full docs map