mukurtu / mukurtu-template

4.0.2 2026-09-15 14:19 UTC

Requires

• drupal/gin_lb: ^3.0@beta
• drupal/og: ^1.x-dev
• drupal/term_reference_change: ^2.0@beta
• mukurtu/mukurtu: ^4.0

Requires (Dev)

• drupal/core-dev: *
• drupal/devel: *
• drupal/devel_php: *
• phpspec/prophecy-phpunit: ^2

Conflicts

• drupal/drupal: *

GPL-3.0-or-later

Published on Packagist.org on 2026-09-15 14:19 UTC

README

This template only covers getting a Mukurtu site's code and database in place. For the full Mukurtu repository and information, see Mukurtu CMS.

The template has its own version numbers, which are not the Mukurtu version. Any 4.x template installs the newest Mukurtu 4.x release. To see your site's Mukurtu version, check the Mukurtu Dashboard.

Requirements

• The necessary database server, web server, and PHP installed that meet modern Drupal requirements
  • PHP 8.4 or later is required.
  • Currently MariaDB or MySQL is supported. PostGRES is not.
  • The Mukurtu Team does our internal work with nginx. Apache SHOULD work fine, but we have not tested it extensively.
• Composer
• To generate PDF thumbnails, poppler-utils must be installed on the server.
• To generate thumbnails for uploaded video files, FFmpeg must be installed on the server.
• For local development, we encourage using Docker and DDEV (which includes composer)

Install Mukurtu with DDEV

Using DDEV is the easiest way to get up and running with Mukurtu locally.

• Download and install DDEV
• Make a new folder in which to work and initialize a DDEV project inside it. Run the following commands to download and install Mukurtu.

mkdir mukurtu
cd mukurtu
ddev config --project-type=drupal --docroot=web
ddev start
ddev composer create-project mukurtu/mukurtu-template:^4.0
ddev drush si --site-name=Mukurtu --account-name=admin --account-pass=admin
ddev launch

Note: This template includes drupal/devel and drupal/devel_php in require-dev, so they install by default unless you pass --no-dev to composer create-project. Mukurtu no longer enables Devel automatically, so both packages sit inert on disk until you turn them on. devel_php specifically provides an execute-PHP capability, so enable it deliberately.

• If planning to develop on the Mukurtu CMS installation profile, follow the additional installation steps to connect a Git checkout to the new project.

Installing Mukurtu CMS with Composer

If installing directly on a web host that has a command line interface, you can install Mukurtu via composer.

Database requirement: Create your database using the utf8mb4 character set and utf8mb4_general_ci collation. Using plain utf8 can cause issues with content that includes characters outside the Basic Multilingual Plane (e.g. emoji). This follows Drupal's recommendation for MySQL/MariaDB:

CREATE DATABASE mukurtu CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;

• First, install composer. If you do not have it already, it can be downloaded into a directory with the following:

wget https://raw.githubusercontent.com/composer/getcomposer.org/main/web/installer -O - -q | php -- --quiet
# Ideally, move composer into an executable path such as /usr/local/bin/composer.
# But for use only within the current directory, just rename it.
mv composer.phar composer

• Install Mukurtu through composer with the following commands:

mkdir mukurtu
cd mukurtu
composer create-project --no-dev mukurtu/mukurtu-template:^4.0 .

Note: --no-dev leaves out drupal/devel and drupal/devel_php, which a production site does not need. devel_php can run arbitrary PHP. Leave out --no-dev only on a development site.

• Set your web server to serve the "web" folder (e.g. mukurtu4/web)
• Install Drupal as normal by opening the site in your web browser, the Mukurtu profile distribution will automatically be used.

After Installing

This template only covers getting a Mukurtu site's code and database in place. For post-installation setup (private files, pdftotext), updating an existing site, and troubleshooting, see the Mukurtu CMS README.