Before You Begin
This guide walks you through installing OpenEduCat on a Linux server and completing the initial configuration. By the end, you will have a working instance with sample data that you can explore and evaluate.
The entire process takes about 45 minutes for someone comfortable with Linux server administration. If you prefer a managed experience, you can request a demo and we will set up a trial instance for you.
System Requirements
Minimum Hardware
- CPU: 2 cores (4 cores recommended)
- RAM: 4 GB (8 GB recommended for production)
- Storage: 20 GB SSD (more for production, depending on document storage needs)
- Network: Stable internet connection for initial setup and package downloads
Software Prerequisites
- Operating System: Ubuntu 22.04 LTS or 24.04 LTS (recommended), Debian 11+, or CentOS 9+
- Python: 3.10 or higher
- PostgreSQL: 14 or higher
- Node.js: 18 LTS or higher (for asset compilation)
- Git: For cloning the repository
- wkhtmltopdf: 0.12.6+ (for PDF report generation)
Supported Browsers
The web interface works with all modern browsers: Chrome 90+, Firefox 90+, Safari 15+, and Edge 90+. Mobile browsers on iOS and Android are also supported.
Step 1: Prepare the Server
Start with a fresh Ubuntu 22.04 server. Update the system packages and install the prerequisites.
Update your system packages to the latest versions. Then install the required system dependencies: Python 3 with pip and development headers, PostgreSQL server, Node.js, Git, and the various libraries needed for image processing and PDF generation (including wkhtmltopdf, libxml2, libxslt, libjpeg, and libfreetype).
Create a dedicated system user for running the OpenEduCat service. This follows the security best practice of not running application services as root.
Step 2: Configure PostgreSQL
Set up a PostgreSQL database user for OpenEduCat. The database user should have the createdb privilege so that OpenEduCat can manage its own databases. This is standard for open-source ERP applications.
Configure PostgreSQL to accept local connections from the OpenEduCat user using password authentication. You will need to update the pg_hba.conf file to allow this.
Step 3: Install OpenEduCat
Clone the OpenEduCat repository from GitHub. The repository includes the core platform along with the OpenEduCat modules.
Set up a Python virtual environment to isolate OpenEduCat's dependencies from the system Python installation. Install all required Python packages from the requirements file.
Step 4: Configure the Application
Create a configuration file that tells OpenEduCat how to connect to the database, where to store files, and what network interface and port to listen on.
Key configuration parameters include: - db_host and db_port: PostgreSQL connection details (usually localhost and 5432) - db_user and db_password: The PostgreSQL user you created - addons_path: Comma-separated list of directories containing OpenEduCat modules - data_dir: Directory for file storage (attachments, session data) - http_port: The port the web server listens on (default 8069) - admin_passwd: Master password for database management operations
For production deployments, you should also configure: - workers: Number of worker processes (typically 2 per CPU core) - proxy_mode: Set to True if running behind a reverse proxy (nginx, Apache) - db_maxconn: Maximum database connections per worker
Step 5: Initialize the Database
Run the OpenEduCat server with the database initialization flag to create your first database. This process creates the database schema, installs the base modules, and sets up the initial administrator account.
The initialization takes a few minutes. You will see log output indicating which modules are being installed. Once you see "HTTP service (werkzeug) running on 0.0.0.0:8069," the server is ready.
Step 6: First Login
Open your web browser and navigate to your server's IP address on port 8069. You will see the OpenEduCat login page.
Log in with the administrator credentials you configured. After logging in for the first time, you will be presented with the module installation wizard. Here you can select which OpenEduCat modules to install.
Recommended Initial Modules
For evaluation purposes, install these modules first: - OpenEduCat Core: The foundation module (required) - Student Management: Student records and profiles - Admission Management: Application and enrollment workflows - Course Management: Programs, courses, and curricula - Attendance Management: Tracking and reporting - Examination Management: Exams, grading, and transcripts - Fee Management: Billing and payment tracking
You can always install additional modules later as you explore the platform.
Step 7: Load Sample Data
OpenEduCat includes sample data modules that populate the system with realistic test data. This is invaluable for evaluation because it lets you see how the system looks and works when fully populated.
Install the sample data module from the Apps menu. After installation, you will have sample students, courses, faculty, fee structures, and academic terms to work with.
Step 8: Set Up a Reverse Proxy (Production)
For production deployments, you should place a reverse proxy (nginx is recommended) in front of OpenEduCat to handle SSL termination, static file serving, and load balancing.
Configure nginx to proxy requests to the OpenEduCat backend on port 8069, serve static files directly for better performance, and terminate SSL using your certificate. Enable the proxy_mode setting in your OpenEduCat configuration so that the application correctly handles headers from the reverse proxy.
Next Steps
With your OpenEduCat instance running, explore these areas:
- Browse the modules: Navigate through Student Management, Admissions, Courses, and other installed modules to understand the data model and workflows.
- Configure your academic structure: Set up academic years, terms, departments, and programs that match your institution.
- Set up user roles: Create user accounts with appropriate access levels for different staff roles.
- Test the student portal: Create a student account and experience the platform from the student's perspective.
- Explore integrations: Review the API documentation and test connections with your existing systems.
For comprehensive documentation, visit the OpenEduCat documentation portal. If you need implementation assistance, our team can help with planning, migration, customization, and training.
Download OpenEduCat to get started today.
