Repository navigation
Installation and Docker
VehicleVault runs as a lightweight, self-contained Docker container with an embedded SQLite (WAL mode) database and persistent local storage for receipts, maintenance invoices, vehicle photos, and documents.
# Linux / macOS
curl -fsSL https://raw.githubusercontent.com/TeeCodeDev/VehicleVault/main/scripts/install.sh | bash# Windows (PowerShell)
irm https://raw.githubusercontent.com/TeeCodeDev/VehicleVault/main/scripts/install.ps1 | iexThe installer creates ~/vehiclevault (%USERPROFILE%\VehicleVault on Windows) with a generated .env (random JWT_SECRET/JWT_REFRESH_SECRET), writes docker-compose.yml, pulls ghcr.io/teecodedev/vehiclevault:latest, and starts the stack. Flags: --dir, --port, --tag (e.g. v3.4.0), --dry-run, --uninstall (install.ps1: -Dir, -Port, -Tag, -DryRun, -Uninstall). Requires Docker Engine (Linux) or Docker Desktop (macOS/Windows + WSL2).
Create a docker-compose.yml file:
services:
vehiclevault:
image: ghcr.io/teecodedev/vehiclevault:latest
# container_name: vehiclevault # (Optional: omit to prevent container naming conflicts in Dockhand/Portainer)
restart: unless-stopped
ports:
- "${PORT:-3084}:3084"
environment:
- NODE_ENV=production
- DATA_DIR=/data
- JWT_SECRET=${JWT_SECRET:-change_this_to_a_long_random_secret_string}
- JWT_REFRESH_SECRET=${JWT_REFRESH_SECRET:-change_this_to_another_long_random_secret_string}
volumes:
- ./data:/dataStart the container:
docker compose up -dOpen http://localhost:3084 in your browser. The first account you register is automatically granted the admin role.
All application data is stored inside the mounted /data volume:
| Path | Description |
|---|---|
/data/vehiclevault.db |
SQLite database in Write-Ahead Logging (WAL) mode |
/data/uploads/receipts/ |
Fuel & EV charging receipt images |
/data/uploads/invoices/ |
Maintenance & workshop invoices (.pdf, .jpg, .png, .webp) |
/data/uploads/documents/ |
Digital glovebox documents & synced maintenance invoices |
/data/uploads/vehicles/ |
Vehicle gallery photos & showcase images |
| Variable | Default | Description |
|---|---|---|
PORT |
3084 |
HTTP port exposed by the Express server & PWA |
DATA_DIR |
/data |
Directory for the SQLite database and uploaded files |
JWT_SECRET |
(auto-generated) | Secret key for signing JWT access tokens |
JWT_REFRESH_SECRET |
(auto-generated) | Secret key for signing long-lived refresh tokens |
DISABLE_AUTH |
false |
Set to true to bypass login completely (e.g., behind a trusted LAN or tunnel) |
ENABLE_PROXY_AUTH |
true |
Authenticate users via reverse proxy headers (Remote-Email, X-Pangolin-User) |
ALLOW_GUEST_ACCESS |
true |
Enable 1-click isolated guest trial sandbox access (?guest=1, ?proef=1) |
PUBLIC_URL |
(request origin) | Canonical external URL (e.g. https://voertuigen.jouwdomein.nl) for OAuth callbacks |
RP_ID |
(request host) | Domain that passkeys are bound to (optional; needs HTTPS and a domain name) |
RP_ORIGINS |
(request origin) | Comma-separated https origins allowed for passkeys, e.g. https://vault.yourdomain.com
|
GEMINI_API_KEY |
(optional) | Default Google Gemini API key (can also be configured in the web UI) |
OPENAI_API_KEY |
(optional) | Default OpenAI API key (can also be configured in the web UI) |
Under Settings β Backup & Opslag, administrators can:
-
Download Complete Backup (
.zip): Exports a consistent snapshot ofvehiclevault.db,manifest.json, and all/data/uploads/*folders into a single ZIP archive. -
Restore from Backup (
.zip): Upload any previously exported VehicleVault ZIP archive to restore the database and all attachments in one click.
VehicleVault v3.2.0 β Self-Hosted Vehicle Management, AI Invoice Translator, TCO & Model Context Protocol β’ GitHub Repository
- π Home
- π³ Installation & Docker
- π€ AI Receipt & Invoice Scanner
- π οΈ Maintenance, TCO & PDF Export
- π Tires & Trip Logging
- π Home Assistant, .ics & MCP
- π Notifications, Sharing & Security