skills.rest
orangehrm
orangehrmOFFICIAL
Explore all skills by this author →
WebsiteGitHub

dev-environment

Configure Docker-based OrangeHRM development environments with standardized setup guidance.

1.1k|746|Updated Jan 5, 2017
Search Tags:#troubleshooting#php#docker#local-development#dev-environment#mariadb#orangehrm
One-click install
npx skills add https://github.com/orangehrm/orangehrm --skill dev-environment-orangehrm
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dev-environment
Source: https://github.com/orangehrm/orangehrm/tree/main/.agents/skills/dev-environment
Command: npx skills add https://github.com/orangehrm/orangehrm --skill dev-environment-orangehrm

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates the tedious, error-prone process of manually configuring a local development environment for OrangeHRM, which requires coordinating multiple PHP versions, database services, and container orchestration without installing dependencies directly on the host machine.

Core Features & Use Cases

  • Docker Environment Setup: Guides developers through configuring the companion orangehrm-os-dev-environment repo, including selecting the lowest supported PHP version, setting up LOCAL_SRC mounting, and adding required /etc/hosts entries.
  • Common Task Guidance: Covers running PHP/Composer/Yarn commands inside containers, accessing the dev database, switching between PHP and database versions, and accessing the app over HTTP/HTTPS.
  • Troubleshooting Support: Provides step-by-step resolution for common failures including host port conflicts, container crashes, database connection errors, mount misconfigurations, and drift between the reference guide and the companion repo.
  • Use Case: A new OrangeHRM contributor can get a working local dev stack running in minutes, and experienced developers can quickly resolve stack failures without digging through compose file documentation.

Quick Start

Use the dev-environment skill to walk you through setting up your local OrangeHRM Docker development stack and resolve any container or connectivity issues you encounter.

Frequently Asked Questions about dev-environment

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up a local OrangeHRM development environment using Docker?▼

To set up a local OrangeHRM Docker dev environment, configure the companion repository by selecting the lowest supported PHP version, mounting LOCAL_SRC, and adding required /etc/hosts entries for correct container orchestration and database connectivity.

Why does my OrangeHRM Docker container crash or fail to connect to the MariaDB database?▼

OrangeHRM Docker container crashes or database connection errors often stem from host port conflicts, incorrect /etc/hosts configuration, or mount misconfigurations, which can be resolved using standardized troubleshooting steps for the dev stack.

Can I switch between different PHP and MariaDB versions for OrangeHRM compatibility testing?▼

You can switch between supported PHP and database versions for OrangeHRM compatibility testing by adjusting the Docker configuration within the companion dev environment repository to target specific container images.

What is the best way to run Composer and Yarn commands inside the OrangeHRM Docker containers?▼

The best way to run Composer and Yarn commands for OrangeHRM is executing them directly inside the running Docker containers, ensuring all dependencies match the configured PHP version without installing them on the host machine.

Do I need to manually edit /etc/hosts to access OrangeHRM over HTTP and HTTPS locally?▼

You need to manually add required entries to your /etc/hosts file to resolve local domains, enabling proper access to the OrangeHRM application over both HTTP and HTTPS within the Docker development stack.

What should I do if the OrangeHRM dev environment guide does not match the companion repository state?▼

If the OrangeHRM dev environment guide drifts from the companion repository state, align your local configuration with the repository's current state to eliminate inconsistencies and ensure correct Docker container orchestration.

Related Skills

Explore More Software Engineering Skills→
Nerfherder16Nerfherder16

docker-status

Diagnose Docker host and container health with Docker CLI access.

Community
Intermediate
orangehrmorangehrm
1.1k

dependencies

Manage PHP Composer and Yarn dependencies within the OrangeHRM Docker environment.

Official
Intermediate
orangehrmorangehrm
1.1k

compatibility

Align supported PHP, Composer, database, and CI version configurations across OrangeHRM environments.

Official
Intermediate
xxihxxih
1

docker-patterns

Configure and launch Docker Compose environments for local development.

Community
Intermediate