Installation

Prerequisites

• Node.js 20 LTS or newer
• Git

Quick start

1. Clone the repository

   git clone https://github.com/mfried40/kiosk-admin.git
   cd kiosk-admin/kiosk-admin

2. Install dependencies

   npm install

3. Create your .env file

   cp .env.example .env

   Then edit .env and fill in at minimum:

   AUTH_SECRET=<random 32+ character string>
   AUTH_URL=http://localhost:3000
   ENCRYPTION_SECRET=<64 hex characters>

   Generate ENCRYPTION_SECRET with:

   node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

4. Set up the database

   npx prisma migrate dev

   This creates a local dev.db SQLite file. No external database required.

5. Start the server

   npm run dev

   Open http://localhost:3000/setup to create your first admin account.

Production build

npm run build
npm start

Tip

For production, use a process manager like PM2 or containerise with Docker to keep the server running after a restart.

Using PostgreSQL or MongoDB

Set these environment variables before running migrations:

DATABASE_PROVIDER=postgresql
DATABASE_URL=postgresql://user:password@localhost:5432/kiosk_admin

For MongoDB:

DATABASE_PROVIDER=mongodb
DATABASE_URL=mongodb://localhost:27017/kiosk_admin

Then run npx prisma db push (MongoDB) or npx prisma migrate dev (PostgreSQL) instead.

See Database configuration for more details.