Open Source Install Guide | Docker

There are two web environment available:

  1. Docker (preferred)
  2. Drupal core's quick-start

It's not necessary to run OpenLucius in one of these environments, you can also run your own, custom web environment.

1. Docker install

The OpenLucius project provides a ready made Docker environment, there are a few steps you have to take to get it up and running.

a) Rename .env.example to .env

And change variables in .env if you wish.

b) Generate SSL certificate

You can also find these 'SSL instructions' in:

/docker/docs/configure-https.md

Generate key by copy/pasting the command from configure-https.md:

docker generate key

Grant access to the key, for MacOS, double click on the generated cert.crt file:

docker cert file

After you double clicked the cert.crt file:

  1. Your Keychain Access window will open;
  2. In there find the 'openlucius.local' domain, double click on that;
  3. The screen underneath will open;
  4. In that screen choose 'always trust' for SSL:

SSL trust macos docker

When you close the Keychain Access window, it will ask you for your password to confirm permission, that's normal behaviour.

1.2. Add openlucius.local to your host file

This is documented in:

/docker/docs/configure-https.md

You can add it via the provided command, or add it manual in your hosts file:

sudo nano /etc/hosts

Make sure this is added and it's saved:

add local domain to host file macos

Then, to be sure, flush local dns cache:

sudo dscacheutil -flushcache

and

sudo killall -HUP mDNSResponder
1.3. Docker-compose up

To get the Docker environment up and running, from the project root enter in a terminal enter:

docker-compose up

==> Browse to https://openlucius.localhost

Enjoy! :)

(!) The mysql database in this Docker environment is not persistent by default, so make sure you create backups whenever you think is needed (!)

2.1 Drupal core's quick-start

You can quickly install OpenLucius with help of Drupal core's quick-start. You'll get it up and running in no time, but we did no testing in this environment, so currently it's not our preferred way of installing but very handy to take a quick peek. More info on Drupal's quick start here

From a terminal execute this command:

php your_project_folder/web/core/scripts/drupal quick-start openlucius --no-interaction

You should see something like the image underneath, your default browser will automatically open a tab with ready to test Drupal / OpenLucius.

Drupal quick start openlucius