Horilla HRMS

Important

2.0 is now this repository’s default branch. Use it to run or deploy Horilla (a plain git clone checks it out). To contribute code, branch from and open PRs against dev/v2.0 — GitHub still pre-selects 2.0 as the PR base, so switch it manually. v1 (1.0/master) is deprioritized, with fixes considered case-by-case rather than on a guaranteed schedule. Full details → Discussion #1127.

A comprehensive, free, and open-source Human Resource Management System (HRMS) designed to streamline HR operations and enhance organizational efficiency.

🚀 Features

Core HR Modules

• 👥 Employee Management - Centralized workforce data with LDAP integration
• 🎯 Recruitment - End-to-end hiring process from job posting to onboarding
• 📋 Onboarding & Offboarding - Structured workflows for employee lifecycle
• ⏰ Attendance & Time Tracking - Biometric integration and automated check-in/out
• 🏖️ Leave Management - Policy enforcement, approvals, and balance tracking
• 💰 Payroll - Automated salary processing, tax calculations, and compliance
• 📊 Performance Management - Goal setting, reviews, and continuous feedback
• 🏢 Asset Management - Track and manage company resources
• 🎫 Helpdesk - Centralized HR support and ticketing system

📋 Table of Contents

• Which Branch Do I Want?
• Quick Start
• Installation
• Deployment
• Contributing
• Security
• Support
• License

🌳 Which Branch Do I Want?

• 2.0 (default) — the latest stable v2 snapshot. This is what a plain git clone gives you. Use it to run or deploy Horilla.
• dev/v2.0 — the active integration branch. If you want to contribute code, branch from and open PRs against this, not 2.0.
• 1.0/master — v1, now deprioritized (fixes considered case-by-case, no guaranteed schedule). Not deleted, but no longer where active development happens.

See Discussion #1127 for full background on this transition.

⚡ Quick Start

Using Docker (Recommended)

# Clone the repository (defaults to the stable 2.0 branch)
git clone https://github.com/horilla/horilla-hr.git
cd horilla-hr

# Start with Docker Compose
docker-compose up -d

# Access the application
open http://localhost:8000

Manual Installation

# Clone and setup (defaults to the stable 2.0 branch)
git clone https://github.com/horilla/horilla-hr.git
cd horilla-hr

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Setup environment
cp .env.dist .env
# Edit .env with your configuration

# Initialize database
python manage.py migrate
python manage.py compilemessages
python manage.py collectstatic

# Run development server
python manage.py runserver

🛠 Installation

For detailed installation instructions, configuration guides, and platform-specific setup instructions, please visit our comprehensive documentation:

📖 Complete Installation Guide → docs.horilla.com/technical/v2.0/

Our documentation includes:

• Step-by-step installation for all supported platforms
• Database configuration guides
• Environment setup instructions
• Production deployment best practices
• Troubleshooting common issues
• Advanced configuration options

🚀 Deployment

For production deployment guides including Nginx, Apache, and cloud platforms:

📖 Deployment Guide → docs.horilla.com/technical/v2.0/doc/deployment/nginx-gunicorn

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

# Fork and clone your fork
git clone -b dev/v2.0 https://github.com/YOUR_USERNAME/horilla-hr.git
cd horilla-hr

# Add upstream remote
git remote add upstream https://github.com/horilla/horilla-hr.git

# Create feature branch
git checkout -b feature/your-feature-name

# Install development dependencies
pip install -r requirements.txt

# Submit pull request

Note: 2.0 is the repo default, so GitHub pre-selects it as your PR base. Before submitting, change the base branch to dev/v2.0 — that's where active development and reviews happen, not 2.0.

Code Standards

• Follow PEP 8 for Python code
• Use Black for code formatting
• Write tests for new features
• Update documentation for user-facing changes

🔒 Security

Security Features

• 🔐 Authentication & Authorization - Role-based access control
• 🛡️ Data Protection - Encrypted sensitive data storage
• 🔍 Audit Trails - Comprehensive activity logging
• 🚫 Input Validation - XSS and injection protection
• 🔒 Session Security - Secure session management

Reporting Security Issues

Please report security vulnerabilities via GitHub Private Vulnerability Reporting, not email. Do not create public GitHub issues for security vulnerabilities. See SECURITY.md for full details.

Security Best Practices

• Always use HTTPS in production
• Regularly update dependencies
• Use strong passwords and enable 2FA
• Monitor logs for suspicious activities

📞 Support

Community Support

• 📖 Documentation: docs.horilla.com
• 💬 GitHub Discussions: GitHub Discussions
• 🐛 Bug Reports: GitHub Issues
• ✨ Feature Requests: GitHub Issues

Professional Support

For enterprise support, custom development, and consulting services:

• 📧 Email: support@horilla.com
• 🌐 Website: www.horilla.com

📄 License

This project is licensed under the LGPL-2.1 License - see the LICENSE file for details.

Made with ❤️ by the Horilla Team

⭐ Star us on GitHub | 🐛 Report Bug | 💡 Request Feature