Environments
Purpose
This page documents the environments used by the Maqsafy platform and the rules for managing environment-specific configuration.
Environment Types
| Environment | Purpose | Notes |
|---|---|---|
| Production | Live environment used by real users | No testing should be performed directly on this environment |
| Staging / Test | Pre-production testing environment | Used to validate releases before production |
| Local Development | Developer machine environment | Used for development and debugging |
Production Environment
| Item | Value |
|---|---|
| Environment Name | Production |
| Purpose | Live system for schools, parents, students, operators, and administrators |
| Access | Restricted |
| Debug Mode | Disabled |
| Real User Data | Yes |
Staging / Test Environment
| Item | Value |
|---|---|
| Environment Name | Staging / Test |
| Purpose | Testing new releases before production |
| Access | Internal team only |
| Debug Mode | Controlled |
| Real User Data | No, unless explicitly approved and anonymized |
Local Development Environment
| Item | Value |
|---|---|
| Environment Name | Local |
| Purpose | Development and debugging |
| Access | Developer machine |
| Debug Mode | Enabled only locally |
| Real User Data | No |
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
.envfiles 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
| Check | Production | Staging | Local |
|---|---|---|---|
| Application URL configured | Yes | Yes | Yes |
| Database connection configured | Yes | Yes | Yes |
| Redis configured | Yes | Preferred | Optional |
| Queue workers running | Yes | Yes | Optional |
| Debug mode disabled | Yes | Preferred | No |
| Backups enabled | Yes | Optional | No |
Notes
Document environment differences clearly, but never include actual secrets, private keys, production credentials, or internal access tokens.