Docs/Getting Started/Quick Start

Quick Start Guide

Get your first door or device accepting payments in under 5 minutes.

TL;DR Checklist

  • Complete initial setup at /setup
  • Configure Stripe in Settings
  • Add a location
  • Sync and add a door or device
  • Generate and print QR code
  • Test the full guest flow

The Fastest Path

1. Finish Setup (2 minutes)

Open /setup in your browser. Create your admin account with email and password.

2. Connect Stripe (1 minute)

  1. Go to Settings → Stripe
  2. Copy your keys from the Stripe Dashboard
  3. Get your webhook secret from Stripe Dashboard → Webhooks
  4. Paste all three values and test the connection
  5. Save

3. Add Your First Door (2 minutes)

  1. Go to Settings → TTLock and enter your TTLock credentials
  2. Go to Locations → Add Location → name it (e.g., "My Building")
  3. Go to Doors → Sync from TTLock
  4. Select your lock(s), assign the location, set a price and duration
  5. Click Save

4. Generate and Test (1 minute)

  1. Open the door in Doors
  2. Click Generate QR Code
  3. Customize and download the PDF
  4. Print it
  5. Scan with your phone to test the payment page
  6. Complete a test payment with Stripe test mode

That's it. Your first door is live.

Alternate Path: Start with a Device

If you don't have TTLock locks, start with a Shelly device instead:

  1. Go to Settings → Shelly and enter your Shelly Auth Key
  2. Go to Locations → Add Location
  3. Go to Devices → Sync from Shelly
  4. Select your device, assign the location
  5. Click Add Usage Plan — set price (e.g., €2.00), duration (e.g., 60 min)
  6. Go to Doors → open any door → Generate QR Code (devices share the same QR system)
  7. Test the full payment and session activation flow

Testing Without Real Money

Use Stripe's test mode during development:

  1. In Stripe Dashboard, toggle Test Mode
  2. Use test card numbers:
    • 4242 4242 4242 4242 — Successful payment
    • 4000 0000 0000 0002 — Failed payment
    • 4000 0025 0000 3155 — Requires 3D Secure

What's Next?