Getting started
Welcome to the YumKiosk documentation. If you're new to the platform, the three pages below are the fastest path from zero to a running kiosk session. Read them in order and you'll have a working setup in about half an hour, most of which is waiting for Stripe's onboarding flow to finish verifying your business.
What you'll need
Before you start:
- A valid business email and a password you can remember.
- About 30 minutes of uninterrupted time.
- Optionally, a tablet you can test with. If you don't have one, use our built-in simulator at
agent.yumkiosk.com/simulator— it emulates a real kiosk in your browser.
You do NOT need:
- Any hardware for the agent side (any laptop with a webcam works).
- Stripe set up in advance — we'll walk you through it during onboarding.
- A pre-built menu — we ship a sample menu you can edit.
The three starter pages
Read these in order:
- What is YumKiosk — a two-minute read that explains the product, who it's for, and why it's different from traditional kiosks.
- Architecture overview — the three tiers (kiosk, agent, cloud) and how they talk to each other. Useful even if you're not a developer — it makes the rest of the docs click.
- 5-minute quickstart — hands-on walkthrough of signing up, pairing a simulated kiosk, inviting a test agent, and running a full session end to end.
After those three, head to the section for your role:
- For Business Owners — if you're a restaurant operator setting up kiosks.
- For Agents — if you're an agent who was just invited to a team.
- For Kiosks — if you're the person configuring physical tablets.
- API Reference — if you're integrating programmatically.
Getting help
If anything in these docs is unclear or wrong, please let us know — click "Suggest an edit" in the footer, or email support@yumkiosk.com. We read every message and usually update the docs within a day.
For platform-specific questions, the owner and agent panels both have a built-in chat widget that'll reach our support team during business hours.