Files
QRForge-selfhosted/README.md
T
dillard 96e2e5f475 Correct README wording for role-based access and VIP edition
The 'user' role description implied OSS users can get per-account
create rights - that's a VIP-only feature. Also replaced the VIP
edition blurb with clearer wording about what the subscription
actually unlocks.
2026-07-12 09:36:40 +02:00

3.4 KiB

QRForge

Self-hosted, open-source QR code generator.

QRForge creates and manages static and dynamic QR codes from a clean, responsive control panel. It's a security-hardened, actively maintained fork of the original PHP Dynamic Qr code project by Giandonato Inverso, built on AdminLTE.

  • Try it free: qr.ensembia.com - fully functional OSS test instance. Self-service signup isn't live yet, so log in with the temporary shared demo account admin / admin in the meantime.
  • Commercial VIP edition: the ability to give sub-users the ability to create QR codes as well, from their own (sub)account. If you have a bigger organisation, having more users being able to create new QR codes delegates your workload. To fund our open-source project, a small fee (€49/year subscription per organisation ("tenant")) is requested for this. www.qrforge.eu.
  • Self-host it yourself: this repository, MIT-licensed.

Features

  • Dynamic QR codes with a database-backed URL shortener
    • Create, edit, delete, enable/disable the redirect
    • Download any time, bulk download/delete
    • Batch-generate from a CSV file
  • 16 static QR code types: Text, Email, Phone, SMS, WhatsApp, Skype, Location, vCard, Event/calendar, Bookmark, WiFi (incl. WPA3), PayPal, Bitcoin, 2FA, App Link (Android intent / universal links), Bluetooth
  • QR code styling: 6 export formats, foreground/background color, 4 precision levels, 10 sizes, optional label text below the code (custom font + size), optional icon shown above the code, save/load your own style presets
  • Address search (OpenStreetMap Nominatim) for Location QR codes
  • Built-in QR scanner (camera or image upload, decodes entirely client-side)
  • Installable as a PWA
  • Role-based access: super (full access + user management), admin (scoped to their own codes and sub-users), user (read-only, with optional view toggles set by an admin; per-account create rights are a VIP-edition feature, not available in this OSS version)
  • Dashboard with QR/scan statistics and a 7-day activity chart
  • CSRF protection, login rate limiting, session hardening, audit log
  • Docker Compose setup, both a dev image and a production Nginx + PHP-FPM image

What is included

  • PHP 8.4 application source
  • Database schema + migrations
  • Docker Compose files (dev and production)
  • CSS/JS assets

Setup with Docker Compose

  1. Clone this repository.
  2. Copy .env.example to .env and set a real DATABASE_PASSWORD / MYSQL_ROOT_PASSWORD.
  3. Start the stack:
    docker compose up -d --build
    
  4. Open http://localhost and log in with superadmin / superadmin. You'll be required to set a new password on first login.

For a production deployment behind a reverse proxy, use docker-compose.prod.yml (Nginx + PHP-FPM) instead of the dev stack.

Credits

License

MIT - see LICENSE.