Skip to main content

Environments

Purpose​

This page documents the environments used by the Maqsafy platform and the rules for managing environment-specific configuration.

Environment Types​

EnvironmentPurposeNotes
ProductionLive environment used by real usersNo testing should be performed directly on this environment
Staging / TestPre-production testing environmentUsed to validate releases before production
Local DevelopmentDeveloper machine environmentUsed for development and debugging

Production Environment​

ItemValue
Environment NameProduction
PurposeLive system for schools, parents, students, operators, and administrators
AccessRestricted
Debug ModeDisabled
Real User DataYes

Staging / Test Environment​

ItemValue
Environment NameStaging / Test
PurposeTesting new releases before production
AccessInternal team only
Debug ModeControlled
Real User DataNo, unless explicitly approved and anonymized

Local Development Environment​

ItemValue
Environment NameLocal
PurposeDevelopment and debugging
AccessDeveloper machine
Debug ModeEnabled only locally
Real User DataNo

Environment Variables​

Environment-specific configuration should be managed through .env files or a secure configuration mechanism.

APP_ENV=production
APP_DEBUG=false
APP_URL=https://example.com

DB_HOST=your-db-host
DB_DATABASE=your-database
DB_USERNAME=your-user
DB_PASSWORD=your-password

CACHE_DRIVER=redis
QUEUE_CONNECTION=redis
SESSION_DRIVER=redis

Environment Rules​

  • Do not store real passwords inside documentation.
  • Do not commit .env files to Git.
  • Do not use production customer data in local development.
  • Sensitive values must be documented as placeholders only.
  • Production access must be restricted to authorized team members only.
  • Any change in production environment configuration must be reviewed before deployment.

Required Checks Per Environment​

CheckProductionStagingLocal
Application URL configuredYesYesYes
Database connection configuredYesYesYes
Redis configuredYesPreferredOptional
Queue workers runningYesYesOptional
Debug mode disabledYesPreferredNo
Backups enabledYesOptionalNo

Notes​

Document environment differences clearly, but never include actual secrets, private keys, production credentials, or internal access tokens.