Welcome to Vorrio

Vorrio turns reviewed receipts and package scans into dependable household stock. It is self-hosted, open source and designed to keep every stock-changing decision visible.

This documentation is generated from the same repository as the application. You can read the complete guide and API contract without access to a running or private Vorrio installation.

Start in three steps

1. Prepare the installation

Vorrio requires Docker Engine with Compose v2 and persistent local storage. Clone the repository and create the local environment file:

git clone https://github.com/amturo-gbr/vorrio.git
cd vorrio
cp .env.example .env
openssl rand -hex 32

Store the generated value as APP_SECRET_KEY in .env. Never commit that file.

2. Start Vorrio

docker compose up -d --build

Open http://localhost:9380, create the first Owner and configure an analysis provider. Camera scanning and passkeys require a stable HTTPS origin.

3. Review the first purchase

Upload a receipt or scan a package, check the proposed product mapping and confirm only the intended changes. Vorrio never changes stock merely because an AI provider or product database returned a possible match.

Open source and under your control

Vorrio is released under AGPL-3.0-or-later. Household data stays in the storage you operate; optional providers and integrations are configured deliberately.

Choose your path

If you want to…	Continue with…
Install a new household instance	Installation
Understand required and optional settings	Configuration
Learn the receipt, scan, stock and shopping flow	Daily workflow
Expose Vorrio through HTTPS	Deployment profiles
Back up or restore the installation	Backup and restore
Build an integration	Static API reference
Contribute another language	Translation community

Public documentation boundary

This site contains public product and operator documentation only. It does not connect to a household, expose a private API token or provide an interactive request console. The API reference is rendered statically from docs/api/openapi.json.

What to read next

Begin with Getting started for the product model and first-login flow, then use Installation for a production-ready setup.