Installation

1. Installation Overview

1. Install the package via Composer
2. Choose your environment (Local or Docker)
3. Run the installation command

2. Step 1 — Install via Composer

Recommended

The stable release is recommended for most users and production environments. It provides a reliable and well-tested foundation.

composer require icebearsoft/kitukizuri

Optional — Beta / Development Release

The beta release includes the latest features and improvements. It is recommended for experienced developers who want early access to new functionality and are comfortable working with potential breaking changes.

composer require icebearsoft/kitukizuri:dev-master

Not sure which version to choose?
Use the stable release. You can switch to the beta version later if needed.

3. Step 2 — Choose Your Installation Mode

• Option A: Docker-based Installation (Recommended)
• Option B: Local Installation (Advanced)

Option A — Docker-based Installation (Recommended)

php artisan krud:set-docker

Option B — Local Installation (Advanced)

Manual installation is intended for developers who prefer to manage their local environment and system dependencies directly.

Note: If you are not sure which prerequisites apply to your setup, the Docker-based installation is strongly recommended.

Core Requirements

These requirements are necessary for any manual installation of KituKizuri

• PHP 8.x
• Node.js (LTS or newer) — required for frontend tooling and asset compilation
• PHP extensions
• • pdo_mysql
  • zip
  • bcmath
  • soap (required for certain integrations)

Optional Capabilities

Only install these dependencies if the corresponding feature is enabled.

MongoDB Support
Required only if MongoDB integration is enabled.

• PHP extension: mongodb (via PECL)

Active Directory / LDAP Integration
Required only if authentication via Active Directory is enabled.

• PHP extension: ldap
• System library: libldap

4. Step 3 — Run the Installer

Once your environment is ready, complete the installation by running the installer command.

• Docker-based installation (Option A):
  If you selected the Docker-based setup, this command must be executed inside the PHP container to ensure all dependencies and services are correctly available.
• Manual installation (Option B): If you selected the manual setup, run this command directly from your local environment.

php artisan krud:install

During this step, an interactive installation wizard will be executed to guide you through the required configuration.

For a detailed explanation of each option, see Krud Configuration Wizard.

5. Step 4 — UI Configuration

As the final step, configure the visual styles of the application by running the UI configuration command

php artisan krud:ui-config

This command guides you through the setup of the visual appearance of the application, allowing you to define the base styling and UI preferences used across the project.

Once this step is completed, the initial installation of KituKizuri is finished and the application is ready for further development.

Default Administrator Account

After the installation is completed, a default administrator account is created to allow initial access to the platform.

• Username: admin
• Password: temp,123

Important: These credentials are intended for initial access only. It is strongly recommended to change the default password immediately after logging in.

This administrator account provides full access to the system and can be used to configure users, roles, permissions, and initial application settings.

Installation Completed

At this point, KituKizuri has been successfully installed and configured. You can now log in using the administrator account, review the initial configuration, and begin building your application.