Por dónde empezar¶
Tu camino depende de qué quieras hacer:
Quiero integrar qrsgen en mi sistema¶
→ Ve directo a API · Quickstart. Tienes el flujo provision → QR → primer mensaje en 20 líneas de curl.
Después, lee:
- API · Convenciones para auth y HMAC.
- API · Mensajes para el detalle del
WebhookPayload. - API · Lifecycle webhooks para los eventos que tu sistema debe recibir.
Si usas n8n o Python, hay recetas listas en Integrations.
Quiero entender cómo funciona internamente¶
→ Arquitectura cubre los flujos, las tablas y la concurrencia.
Empieza por el overview, después Bootstrap para entender el ciclo de arranque, y luego los flujos INCOMING y OUTGOING.
Quiero desplegarlo¶
→ Deployment con la opción que prefieras:
- Imagen GHCR pre-built (recomendado).
- Build local desde el repo.
- Binario nativo.
Después configura el stack Swarm con las variables de entorno y opcionalmente expón la telemetría pública.
Quiero operarlo en producción¶
→ Operations tiene el runbook completo:
- Diagnóstico rápido — health, instances, mensajes, ban-risk.
- Procedimientos comunes — re-pareado, restart, billing.
- Troubleshooting — errores típicos y cómo resolverlos.
- Alerting — reglas Prometheus sugeridas.
Quiero entender el modelo de seguridad¶
→ Security describe las 7 capas con su modelo de amenaza, configuración y verificación. Empieza por el overview.
Glosario¶
Integrar: conectar qrsgen a tu sistema externo (orquestador, app, CRM) mediante su API HTTP.
Quickstart: receta corta para arrancar de cero. La de qrsgen va desde provision hasta el primer mensaje en 5 pasos.
Lifecycle webhook: callback HTTP que tu sistema recibe cuando algo
relevante ocurre en una instancia. Configurable per-instancia vía
events_webhook_url.
Stack swarm: forma de despliegue de qrsgen basada en Docker Swarm
con docker-compose.yml. Es el modo de referencia.
Runbook: documento operativo con procedimientos paso a paso para operar el sistema en producción.
Modelo de amenaza: análisis de qué ataques son realistas y cómo los mitiga el sistema. qrsgen lo documenta como 7 capas defense-in-depth.