PREREQUISITES
System Requirements
Oh My School can be deployed manually (from source) or containerized using Docker. Depending on your choice of deployment, ensure your environment meets the corresponding requirements below.
Deployment from Source (Manual)
To install and run Oh My School directly on your server, you will need:
- PHP 8.4 or newer
- MySQL 8.0+ or MariaDB 10.6+
- Composer 2 (for PHP dependency management)
- Node.js 20+ with Bun (for frontend compilation)
- Web Server (e.g., Nginx, Apache, Caddy, or PHP-FPM)
Deployment using Docker
To run the containerized version (recommended for quick setups and isolated dependencies), you will need:
- Linux Server (Ubuntu 20.04 LTS or newer is recommended)
- Docker and Docker Compose installed
- At least 1GB of RAM (2GB recommended for high-traffic days)
- A registered domain name (for configuring SSL/TLS in production)
Still have questions?
If you could not find what you were looking for, the community is here to help on GitHub Discussions.
Ask the Community