User Registration Setup

Configure and implement user self-registration in Bknd applications.

Prerequisites

• Bknd project with auth enabled (bknd-setup-auth)
• Password strategy configured
• For SDK: bknd package installed

When to Use UI Mode

• Testing registration endpoint via admin panel
• Viewing registered users

UI steps: Admin Panel > Auth > Test password/register endpoint

When to Use Code Mode

• Building registration forms in frontend
• Configuring registration settings
• Adding validation and error handling

Registration Configuration

Enable/Disable Registration

import { serve } from "bknd/adapter/bun";

serve({
  connection: { url: "file:data.db" },
  config: {
    auth: {
      enabled: true,
      allow_register: true,  // Enable self-registration (default: true)
      default_role_register: "user",  // Role assigned on registration
      strategies: {
        password: {
          type: "password",
          config: {
            hashing: "bcrypt",  // "plain" | "sha256" | "bcrypt"
            minLength: 8,       // Minimum password length
          },
        },
      },
      roles: {
        user: { implicit_allow: false },
      },
    },
  },
});

Config options:

Option	Type	Default	Description
allow_register	boolean	true	Enable self-registration
default_role_register	string	-	Role for new users
minLength	number	8	Minimum password length

SDK Registration

import { Api } from "bknd";

const api = new Api({
  host: "http://localhost:7654",
  storage: localStorage,  // Persist token
});

async function register(email: string, password: string) {
  const { ok, data, status } = await api.auth.register("password", {
    email,
    password,
  });

  if (ok) {
    // Token stored automatically - user is logged in
    return data.user;
  }

  if (status === 409) throw new Error("Email already r...