Mukurtu CMS

To learn more about Mukurtu CMS and the larger Mukurtu community, visit mukurtu.org.

Note: This version of Mukurtu CMS is currently under active development and is subject to daily change. Only use for testing and feedback purposes.

Requirements

• The necessary database server, web server, and PHP installed that meet modern Drupal requirements
• Composer
• 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
# Optional but recommended: install pdftotext inside the DDEV container:
echo "RUN sudo apt -qq update; sudo apt install poppler-utils -y;" > .ddev/web-build/Dockerfile.pdftotext
ddev start
ddev composer create mukurtu/mukurtu-template:dev-main
ddev drush si --site-name=Mukurtu --account-name=admin --account-pass=admin
ddev launch

• 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.

• 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 mukurtu/mukurtu-template:dev-main .

• 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.

Post-installation Steps

Set up private files

Access control in Mukurtu depends on the Drupal private file system. You must configure the file_private_path setting in settings.php.

• Create a folder outside the web directory, such as private_files.
• Open sites/default/settings.php and modify the $settings['file_private_path'] line, such as the following:

// Specify a private files path.
$settings['file_private_path'] = '../private_files';

• Clear your site cache by visiting admin/config/development/performance within your Mukurtu site and clicking "Clear all caches".
• Confirm the private files directory is found by visiting admin/config/media/file-system within your Mukurtu site.

Install pdftotext

The ability to parse PDFs is dependent on the pdftotext command line tool. This can be installed in ddev with:

echo "RUN sudo apt -qq update; sudo apt install poppler-utils -y;" > .ddev/web-build/Dockerfile.pdftotext
ddev restart

Or, if hosting your own server with:

sudo apt install poppler-utils

Contributing

Mukurtu CMS v4 is extremely unstable and under active development. If you wish to contribute, please first discuss it with us by starting an issue or discussion on the Mukurtu CMS issue tracker or contact us via mukurtu.org.

For more information on developing and contributing to Mukurtu CMS, visit the GitHub wiki for developer documentation.