minthcm

MintHCM is an open-source Human Capital Management system with features that cover recruitment, time management, onboarding and offboarding, calendar, leave management, resources booking, travel and expenses, workplace management, analytics, and roles & permissions management. The API is designed to be similar to SuiteCRM, with MintHCM-specific differences documented in the project's guides. To get started, deploy MintHCM via Docker (or your preferred environment), then access the web interface to configure your database, users, and security settings. Use the built-in administration tools to manage employees, positions, departments, and permissions, and leverage the API to integrate with external systems for recruitment, payroll, and analytics. The server exposes endpoints for CRUD operations on core entities (employees, roles, events, leaves, calendars, and resources) and offers authentication, data retrieval, and action workflows typical of a CRM-like HR platform.

Prerequisites:

• Docker installed on your host (or use a compatible container runtime)
• Access to a database (or let the container configure an embedded DB if supported by the image)
• Basic familiarity with environment variables for configuring the database and application

Installation steps (Docker):

1. Create a dedicated directory for MintHCM data and configuration.
2. Create a docker-compose.yml (optional) or pull and run the image directly.
3. Configure environment variables for the database connection and app settings.
4. Start the container and complete initial setup from the web interface.

Example using Docker command directly:

docker run -d \
  --name minthcm \
  -p 80:80 \
  -e DB_HOST=localhost \
  -e DB_USER=minthcm_user \
  -e DB_PASSWORD=your-db-password \
  -e DB_NAME=minthcm_db \
  -e APP_ENV=production \
  -e APP_DEBUG=false \
  minthcm/minthcm

Post-install:

• Visit http://localhost to access the MintHCM web interface.
• Create an admin user and configure SMTP, security, and authentication settings.
• Import or configure your initial data (departments, roles, employees) and connect external systems as needed.

Tips and common issues:

• Ensure your host database is reachable from the MintHCM container and that credentials match the environment variables.
• If the web interface cannot be reached, check container logs for PHP/Apache errors and confirm ports are properly mapped.
• Review network and firewall settings to allow API access from your integration endpoints.
• Regularly back up the database and exported data; MintHCM follows typical CRM data models, so standard backup strategies apply.
• For API usage, refer to the MintHCM API guide for authentication methods, rate limits, and entity schemas. If migrating from another CRM, plan a mapping strategy for employees, roles, and activities.
• Localization and translations can be extended via Crowdin bundles integrated with the app.