Documentation Index

July 11, 2026 · View on GitHub

Central index for all cakephp-verification plugin documentation.

Getting started

TopicFile
README (overview, features, quick start)../README.md
Installation (plugin setup, database columns, migrations)installation.md
Configuration referenceconfiguration.md
Environment variables (single source of truth)env.md

Guides

TopicFile
Verification flows (setup, login, OTP choice)verification_flow.md
Email verification & Email OTPemail_verification.md
SMS OTPsms_verification.md
TOTP (authenticator app)totp_verification.md
Enable / disable individual stepsverificator_enable_disable.md

Integration

TopicFile
UsersController actionsusers_controller.md
VerificationComponentverification_component.md
VerificationHelperverification_helper.md

API reference (internals)

TopicFile
API indexapi/index.md
OTP storage — rate limiting, lockout, cache configapi/otp_storage.md
Sodium encryption driverapi/sodium_crypto.md
AES-256-GCM encryption driverapi/aes_gcm_crypto.md
SMS transport — custom transport implementationapi/sms_transport.md
Custom verification step (verificator interface)api/verificator_interface.md