schooltool Installation Guide Installation Guide

schooltool is a free and open-source student information. SchoolTool provides student information system

Hardware Requirements:

CPU: 1 core minimum

RAM: 1GB minimum

Storage: 5GB for data

Network: HTTP/HTTPS

Operating System:

Linux: Any modern distribution (RHEL, Debian, Ubuntu, CentOS, Fedora, Arch, Alpine, openSUSE)

macOS: 10.14+ (Mojave or newer)

Windows: Windows Server 2016+ or Windows 10

FreeBSD: 11.0+

Network Requirements:

Port 7080 (default schooltool port)

None

Dependencies:

See official documentation for specific requirements

System Access: root or sudo privileges required

This guide supports installation on:

RHEL 8/9 and derivatives (CentOS Stream, Rocky Linux, AlmaLinux)

Debian 11/12

Ubuntu 20.04/22.04/24.04 LTS

Arch Linux (rolling release)

Alpine Linux 3.18+

openSUSE Leap 15.5+ / Tumbleweed

SUSE Linux Enterprise Server (SLES) 15+

macOS 12+ (Monterey and later)

FreeBSD 13+

Windows 10/11/Server 2019+ (where applicable)

bash

# Install EPEL repository if needed
sudo dnf install -y epel-release

# Install schooltool
sudo dnf install -y schooltool

# Enable and start service
sudo systemctl enable --now schooltool

# Configure firewall
sudo firewall-cmd --permanent --add-port=7080/tcp
sudo firewall-cmd --reload

# Verify installation
schooltool --version

bash

# Update package index
sudo apt update

# Install schooltool
sudo apt install -y schooltool

# Enable and start service
sudo systemctl enable --now schooltool

# Configure firewall
sudo ufw allow 7080

# Verify installation
schooltool --version

bash

# Install schooltool
sudo pacman -S schooltool

# Enable and start service
sudo systemctl enable --now schooltool

# Verify installation
schooltool --version

bash

# Install schooltool
apk add --no-cache schooltool

# Enable and start service
rc-update add schooltool default
rc-service schooltool start

# Verify installation
schooltool --version

bash

# Install schooltool
sudo zypper install -y schooltool

# Enable and start service
sudo systemctl enable --now schooltool

# Configure firewall
sudo firewall-cmd --permanent --add-port=7080/tcp
sudo firewall-cmd --reload

# Verify installation
schooltool --version

bash

# Using Homebrew
brew install schooltool

# Start service
brew services start schooltool

# Verify installation
schooltool --version

bash

# Using pkg
pkg install schooltool

# Enable in rc.conf
echo 'schooltool_enable="YES"' >> /etc/rc.conf

# Start service
service schooltool start

# Verify installation
schooltool --version

bash

# Using Chocolatey
choco install schooltool

# Or using Scoop
scoop install schooltool

# Verify installation
schooltool --version

bash

# Create configuration directory
sudo mkdir -p /etc/schooltool

# Set up basic configuration
# See official documentation for detailed configuration options

# Test configuration
schooltool --version

bash

# Enable service
sudo systemctl enable schooltool

# Start service
sudo systemctl start schooltool

# Stop service
sudo systemctl stop schooltool

# Restart service
sudo systemctl restart schooltool

# Check status
sudo systemctl status schooltool

# View logs
sudo journalctl -u schooltool -f

bash

# Enable service
rc-update add schooltool default

# Start service
rc-service schooltool start

# Stop service
rc-service schooltool stop

# Restart service
rc-service schooltool restart

# Check status
rc-service schooltool status

bash

# Enable in /etc/rc.conf
echo 'schooltool_enable="YES"' >> /etc/rc.conf

# Start service
service schooltool start

# Stop service
service schooltool stop

# Restart service
service schooltool restart

# Check status
service schooltool status

bash

# Using Homebrew services
brew services start schooltool
brew services stop schooltool
brew services restart schooltool

# Check status
brew services list | grep schooltool

powershell

# Start service
net start schooltool

# Stop service
net stop schooltool

# Using PowerShell
Start-Service schooltool
Stop-Service schooltool
Restart-Service schooltool

# Check status
Get-Service schooltool

See the official documentation for advanced configuration options.

nginx

upstream schooltool_backend {
    server 127.0.0.1:7080;
}

server {
    listen 80;
    server_name schooltool.example.com;
    return 301 https://$server_name$request_uri;
}

server {
    listen 443 ssl http2;
    server_name schooltool.example.com;

    ssl_certificate /etc/ssl/certs/schooltool.example.com.crt;
    ssl_certificate_key /etc/ssl/private/schooltool.example.com.key;

    location / {
        proxy_pass http://schooltool_backend;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

apache

<VirtualHost *:80>
    ServerName schooltool.example.com
    Redirect permanent / https://schooltool.example.com/
</VirtualHost>

<VirtualHost *:443>
    ServerName schooltool.example.com
    
    SSLEngine on
    SSLCertificateFile /etc/ssl/certs/schooltool.example.com.crt
    SSLCertificateKeyFile /etc/ssl/private/schooltool.example.com.key
    
    ProxyRequests Off
    ProxyPreserveHost On
    
    ProxyPass / http://127.0.0.1:7080/
    ProxyPassReverse / http://127.0.0.1:7080/
</VirtualHost>

haproxy

frontend schooltool_frontend
    bind *:80
    bind *:443 ssl crt /etc/ssl/certs/schooltool.pem
    redirect scheme https if !{ ssl_fc }
    default_backend schooltool_backend

backend schooltool_backend
    balance roundrobin
    server schooltool1 127.0.0.1:7080 check

bash

# Set appropriate permissions
sudo chown -R schooltool:schooltool /etc/schooltool
sudo chmod 750 /etc/schooltool

# Configure firewall
sudo firewall-cmd --permanent --add-port=7080/tcp
sudo firewall-cmd --reload

# Enable SELinux policies (if applicable)
sudo setsebool -P httpd_can_network_connect on

See official documentation for database configuration requirements.

bash

# Basic system tuning
echo 'net.core.somaxconn = 65535' | sudo tee -a /etc/sysctl.conf
echo 'net.ipv4.tcp_max_syn_backlog = 65535' | sudo tee -a /etc/sysctl.conf
sudo sysctl -p

bash

# Check service status
sudo systemctl status schooltool

# View logs
sudo journalctl -u schooltool -f

# Monitor resource usage
top -p $(pgrep schooltool)

bash

#!/bin/bash
# Basic backup script
BACKUP_DIR="/backup/schooltool"
DATE=$(date +%Y%m%d_%H%M%S)

mkdir -p "$BACKUP_DIR"
tar -czf "$BACKUP_DIR/schooltool-backup-$DATE.tar.gz" /etc/schooltool /var/lib/schooltool

echo "Backup completed: $BACKUP_DIR/schooltool-backup-$DATE.tar.gz"

bash

# Stop service
sudo systemctl stop schooltool

# Restore from backup
tar -xzf /backup/schooltool/schooltool-backup-*.tar.gz -C /

# Start service
sudo systemctl start schooltool

1. Service won't start:

bash

# Check logs
sudo journalctl -u schooltool -n 100
sudo tail -f /var/log/schooltool/schooltool.log

# Check configuration
schooltool --version

# Check permissions
ls -la /etc/schooltool

2. Connection issues:

bash

# Check if service is listening
sudo ss -tlnp | grep 7080

# Test connectivity
telnet localhost 7080

# Check firewall
sudo firewall-cmd --list-all

3. Performance issues:

bash

# Check resource usage
top -p $(pgrep schooltool)

# Check disk I/O
iotop -p $(pgrep schooltool)

# Check connections
ss -an | grep 7080

yaml

version: '3.8'
services:
  schooltool:
    image: schooltool:latest
    ports:
      - "7080:7080"
    volumes:
      - ./config:/etc/schooltool
      - ./data:/var/lib/schooltool
    restart: unless-stopped

Maintenance

bash

# RHEL/CentOS/Rocky/AlmaLinux
sudo dnf update schooltool

# Debian/Ubuntu
sudo apt update && sudo apt upgrade schooltool

# Arch Linux
sudo pacman -Syu schooltool

# Alpine Linux
apk update && apk upgrade schooltool

# openSUSE
sudo zypper update schooltool

# FreeBSD
pkg update && pkg upgrade schooltool

# Always backup before updates
tar -czf /backup/schooltool-pre-update-$(date +%Y%m%d).tar.gz /etc/schooltool

# Restart after updates
sudo systemctl restart schooltool

Regular Maintenance

bash

# Log rotation
sudo logrotate -f /etc/logrotate.d/schooltool

# Clean old logs
find /var/log/schooltool -name "*.log" -mtime +30 -delete

# Check disk usage
du -sh /var/lib/schooltool

Official Documentation: https://docs.schooltool.org/

GitHub Repository: https://github.com/schooltool/schooltool

Community Forum: https://forum.schooltool.org/

Best Practices Guide: https://docs.schooltool.org/best-practices

---

Note: This guide is part of the HowToMgr collection. Always refer to official documentation for the most up-to-date information.

1. Prerequisites

2. Supported Operating Systems

3. Installation

RHEL/CentOS/Rocky Linux/AlmaLinux

Debian/Ubuntu

Arch Linux

Alpine Linux

openSUSE/SLES

macOS

FreeBSD

Windows

Initial Configuration

Basic Configuration

5. Service Management

systemd (RHEL, Debian, Ubuntu, Arch, openSUSE)

OpenRC (Alpine Linux)

rc.d (FreeBSD)

launchd (macOS)

Windows Service Manager

Advanced Configuration

Reverse Proxy Setup

nginx Configuration

Apache Configuration

HAProxy Configuration

Security Configuration

Basic Security Setup

Database Setup

Performance Optimization

System Tuning

Monitoring

Basic Monitoring

9. Backup and Restore

Backup Script

Restore Procedure

6. Troubleshooting

Common Issues

Integration Examples

Docker Compose Example

Maintenance

Update Procedures

Regular Maintenance

Additional Resources

Related Education Guides

chamilo Installation Guide

gibbon Installation Guide

h5p Installation Guide