Skip to main content

Getting started

Accessing the documentation​

The documentation is available without logging in at …/docs/. From the app, a Help button appears in every portal header and on the portals page; it opens this documentation in a new tab. On the desktop app, the Help menu offers the same access.

Signing in to the app​

Each user reaches their portal through their company (tenant) URL. Authentication relies on a per-user PIN code.

PIN recovery​

If a PIN is forgotten, an email reset flow (via Resend) sends a reset link. The previous, insecure PIN auto-claim mechanism has been removed.

Anti-bot protection (captcha)​

Sensitive screens can be protected by Cloudflare Turnstile. When the captcha is not configured on the environment, the check is automatically skipped (no blocking).

POS lock​

The point of sale can lock after each sale (slide bar to unlock). This is driven by Tenant.posLockAfterSale and is off by default.

The zero-state model​

A new tenant contains no demo data. Onboarding consists of:

  1. Creating the company and its owner account.
  2. Defining stores and the number of allowed registers (per the plan).
  3. Building the product catalogue (brands, suppliers, families, packaging).
  4. Opening a register to start recording sales — dashboards stay at zero until a register is opened.

Offline mode (PWA / Desktop)​

The app ships a read-only offline layer. On a network outage, a banner appears and writes resume when connectivity returns. The /docs/ documentation is not cached by this layer: it loads directly.

Desktop app updates​

The Desktop app updates automatically: it checks for a new version on launch, downloads the update in the background, then prompts you to restart to apply it. You can also trigger a manual check via Help → Check for updates. Help → About shows the installed version and the device IP address. See Desktop & updates for details.