Drupal SideKick

Your Drupal development buddy

Setup

1. Install Docker

Follow-up on the official documentation how to get the latest Docker version for your platform - https://docs.docker.com/get-docker/

2. Clone this repository locally

Clone this repository somewhere on your computer, preferably on: /opt/sidekick

sudo mkdir /opt/sidekick
sudo chown <USER>:<USER> /opt/sidekick
git clone https://github.com/eaudeweb/sidekick /opt/sidekick
sudo chown -R 8983:8983 /opt/sidekick/data/solr

3. Customize services

You can copy example.override.yml to override.yml and customize it to your needs. Keep in mind that you can fully override: volumes and other aspects of service definition (either through override.yml OR .env file) Read more here and here.

4. Start the services

Example commands:

1. Start the default services: sudo ./service.sh up
2. Start the default services without blocking the console: sudo ./service.sh up -d
3. Start Solr services: sudo ./service.sh --profile solr up
4. Stop services: sudo ./service.sh --profile solr stop (use the same profile to close all services)

Services

Enabling and disabling services: By default there is only a single service enabled: MailHog. In the sections below, each service is described in detail. If you want to use a certain service you can use the --profile switch. The following profiles are defined:

• all - Start all available services
• solr - Start Apache Solr servers
• mariadb - Start MariaDB servers
• tomcat - Start Tomcat servlet container
• varnish - Start Varnish containers

MailHog

Description: The MailHog service creates a SMTP local server to send emails and receive emails. It does not send real emails and therefore if it runs locally on port 25 - it avoids sending real emails when doing local mailing tests. All emails sent can be seen in an Webmail UI available at http://localhost:8025.

Warning: Make sure you stop your sendmail if you decide to run it on port 25:

systemctl stop sendmail
systemctl disable sendmail
systemctl stop postfix
systemctl disable postfix

Configuration:

• You can change the default listening ports locally by adding environment variables in an .env file in this folder.

Example:

MAILHOG_SMTP_PORT=1025
MAILHOG_HTTP_PORT=8000

Apache Solr

These services are listening on local TCP/IP ports 8983 and 8984. Make sure there is no conflict with other services. Below are instructions how to manage Solr cores.

To create a new Solr core

See below commands to create a new core. Replace NEWCORENAME with the actual name

sudo su -
cd /opt/sidekick/data/solr/7/cores/
mkdir -p NEWCORENAME/conf
cd /opt/sidekick/data/solr/7/cores/NEWCORENAME/conf/
touch /opt/sidekick/data/solr/7/cores/NEWCORENAME/core.properties
# Download and copy Drupal core template from http://drupal.localhost/admin/config/search/search-api/server/solr/solr_configset/config-zip (solr_x.y_config.zip) to conf/
cp ~/Desktop/solr_7.x_config.zip .
unzip solr_7.x_config.zip
sudo chown -R 8983:8983 /opt/sidekick/data/solr/7/cores/NEWCORENAME
docker compose restart solr7

MariaDB

Description: MariaDB with in-memory storage for very fast queries. All database data is stored in tmpfs and therefore lost when the container is restarted.

Configuration: See examples in example.override.yml to customize MariaDB configuration options by mounting additional .cnf files

Populate database with data: If you place SQL scripts in the ./data/mariadb/ directory they are always executed during server startup. Therefore you can place database dumps but they must start with database creation and selection statements like this:

CREATE DATABASE project_db CHARACTER SET UTF8MB4;
USE project_db;

Apache Tomcat

Description: Apache Tomcat 7 container for Java Web applications.

Varnish

Description: Varnish for implementing caching strategy for projects.

Configuration: You can mount custom VCL files, see exampl

FAQ

2. How to see docker logs

You can look for errors while contaiers are starting.

docker logs --tail=100 --follow solr7