Skip to content

MukurtuCMS/Mukurtu-CMS

Repository files navigation

Mukurtu CI Tests

Mukurtu Logo

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.

Usage

Beginning with version 4, Mukurtu CMS has been implemented as a Drupal installation profile. Drupal should be installed as normal, with the Mukurtu CMS installation profile added to your composer.json file.

There is an available Mukurtu CMS project template with a composer.json preconfigured to download the Mukurtu CMS installation profile.

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

External Dependencies

  • Requires pdftotext to be installed on the hosting system for PDF text extraction to function.

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 GitHub page or contact us via mukurtu.org. Unsolicited pull requests will likely not receive attention at this point in development.

Quick start for Personal Testing & Evaluation

There are two easy methods to create a local installation of Mukurtu CMS:

DDEV

Mukurtu CMS can be installed locally using DDEV.

  • Download and install DDEV
  • Create and navigate to a new folder (e.g., 'mukurtu'):
mkdir mukurtu && cd mukurtu
wget https://raw.githubusercontent.com/MukurtuCMS/Mukurtu-CMS-v4-Project-Template/main/composer.json
  • Initialize the ddev project for Drupal 9:
ddev config --project-type=drupal9 --docroot=web --create-docroot
  • Configure Drupal's file_private_path setting by creating a folder (outside of /web) and editing sites/default/settings.php and setting it to the absolute path of your new private folder.
  • Start ddev:
ddev start
  • Run composer install:
ddev composer install
  • You may be prompted to add your GitHub token. Follow the on-screen instructions for public repositories.
  • Launch your new ddev project:
ddev launch
  • You should now see the standard Drupal 9 installer, configured to use the Mukurtu installation profile
  • Default admin credentials are admin/admin

Gitpod

Mukurtu CMS is configured to work with Gitpod, a cloud based development environment.

Open in Gitpod