Website: satflux.io
satflux.io - BTCPay control panel & business invoicing
Multi-tenant web app for merchants to run BTCPay Server stores and Pro business invoicing (companies, accounting documents, expenses) through a Vue SPA backed by Laravel and the Greenfield API.
Current app version: 2.0.0 (see package.json; /api/version reads the same value).
Features
BTCPay stores
- Store dashboard: payment invoices, wallets, Lightning addresses, pay button, PoS / Crowdfund apps, API keys
- Wallet types: Blink, Aqua + Boltz (descriptor / SamRock pairing), Cashu (mint + Lightning address, settlements UI)
- Satoshi Tickets (events, offline tickets, check-in) and BTCPay Raffles (incl. event bundle)
- CSV / XLSX exports, webhooks, optional Stripe plugin per store
- Post-setup wallet verification checklist per wallet type
Accounts & plans
- Email/password, LNURL-auth, and seed-first onboarding (24-word recovery phrase)
- Guest demo: BTCPay store without Pro invoicing; upgrade to verified Free, then Pro / Enterprise via BTCPay subscription checkout
- One recovery phrase for account restore and (in local-first mode) invoicing sync across devices
- Optional OFAC / sanctions screening (off by default; enable via
COMPLIANCE_SCREENING_ENABLED - see docs/OFAC_COMPLIANCE.md) for operators who accept fiat (e.g. Stripe to bank account) and need geo/list checks
Business invoicing (Pro+)
- Companies, contacts, issued documents: invoices, proformas, quotes, orders, delivery notes, credit notes, drafts, recurring profiles
- Stock items and warehouses; company branding and e-mail settings
- Expenses with attachments; browser Excel import; ISDOC extract and bulk PDF import via ephemeral server bridge
- Bank payment matching (CSV / CAMT.053) and optional b-mail inbound (docs/BANK_PAYMENT_MATCHING.md)
- Structured exports: ISDOC and Peppol BIS UBL files
- WooCommerce plugin: connect shop, draft/issue documents, integration inbox (docs/WOOCOMMERCE.md)
- Bitcoin pay links on issued invoices (BTCPay checkout); subscription billing can auto-issue paid invoices into a billing company
Slovak eFaktura status: a complete provider integration has not been verified. Satflux is currently not presented as a ready solution for mandatory Slovak e-invoicing. UBL export alone does not deliver an invoice. Further SK eFaktura development is paused pending a provider decision and complete integration verification. Existing integration code and settings are retained; see docs/SK_EFAKTURA.md.
Local-first invoicing (v2)
When VITE_INVOICING_LOCAL_FIRST=true and INVOICING_LOCAL_FIRST=true, core invoicing data lives in the browser (Evolu SQLite, E2EE). Optional relay sync via VITE_EVOLU_RELAY_URL. Server APIs remain for PDF render, e-mail, e-faktura, BTCPay bridges, and one-time import from server for legacy PostgreSQL data.
Rollout guide: docs/INVOICING_LOCAL_FIRST_ROLLOUT.md. Module overview: docs/BUSINESS_INVOICING.md.
Tech stack
| Layer | Stack |
|---|
| Backend | Laravel 12, PHP 8.3+, Sanctum (SPA cookie auth), PostgreSQL, Redis |
| HTTP client | Laravel HTTP / Greenfield-style integration with BTCPay |
| Frontend | Vue 3, TypeScript, Vite, Tailwind CSS, Pinia, Vue Router, vue-i18n (EN / SK / ES) |
| Local-first | Evolu (@evolu/vue, @evolu/web) for invoicing SQLite + E2EE relay sync |
| Hybrid UI | Inertia.js (@inertiajs/vue3) where used alongside the SPA |
| Realtime | Laravel Reverb (optional; see env / deployment) |
| Dev / prod | Docker Compose (docker-compose.yml) - nginx, php-fpm, postgres, redis |
Prerequisites
- Docker and Docker Compose
- Node.js 22.13.0+ within 22.x, or 24.0.0+ and npm (frontend dev / build and native SQLite tests; see
package.json engines)
Local setup
-
Clone the repository
-
Environment file
cp .env.example .env
-
Configure .env - database, BTCPAY_BASE_URL, BTCPAY_API_KEY, webhooks, invoicing flags, etc. For local SPA auth over HTTP:
SANCTUM_STATEFUL_DOMAINS=localhost,localhost:8000,localhost:8080,127.0.0.1,127.0.0.1:8000,127.0.0.1:8080
SESSION_DOMAIN=
SESSION_SECURE_COOKIE=false
SESSION_SAME_SITE=lax
Local-first invoicing (optional): set VITE_INVOICING_LOCAL_FIRST=true, INVOICING_LOCAL_FIRST=true, and rebuild the frontend (npm run build).
-
Start containers
docker-compose up -d
-
PHP dependencies
docker-compose exec php composer install
-
Application key
docker-compose exec php php artisan key:generate
-
Migrations
docker-compose exec php php artisan migrate
-
Node dependencies
npm install
-
Frontend
- Development (Vite HMR):
npm run dev
- Production assets:
npm run build
-
After changing .env or config
docker-compose exec php php artisan optimize:clear
Development URLs (typical Docker setup)
- App / API base:
http://localhost:8080
- API prefix:
/api
- PostgreSQL:
localhost:5432 (per compose mapping)
- Redis:
localhost:6379 (per compose mapping)
This is the beginning of the README. Read the rest at the original. Read the full README ↗
