The project is the base to fork to create new projects using craft cms. The repository contains the
- docker configuration for craft container
- docker-compose configuration to run the craft+mysql enviroment
- base schema customization of the craft installation
- apache configuration
- base template for craft frontend
- utility scripts to start/stop the enviroment
- utility scripts to import/export craft schema changes
The following is the directory layout
/
bin/ - contains scripts to start/stop the development environment
docker/ - contains the configuration/scripts/resources for docker
craft/ - definition of the container for CraftCMS
adminer/ - php mysql frontend
conf/
apache2/ - apache2 configuration files for CraftCMS
logs/
apache2/ - apache2 logs
scripts/ - scripts used to setup/update the container (CMD/ENTYPOINTS)
config/ - CraftCMS config folder
plugins/ - CraftCMS plugins folder
templates/ - CraftCMS templates folder
public/ - CraftCMS public folder
the craft cms image is available here
To publish an updated image of CraftCMS container to docker hub do the folowing:
# cd into the docker/craft folder of the base project
cd docker/craft
# build a new image (this is going to be the 'latest' tag)
docker build -t welance/craft .
# list the images and pick up the id of the images just built
docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
welance/craft latest 18cd3db3e7df About a minute ago 114 MB
<none> <none> be09b9e54c3d About an hour ago 113 MB
...
# login to docker hub
docker login --username=yourhubusername
# tag your image (other than 'latest')
docker tag 18cd3db3e7df welance/craft:2.6
# push the image
docker push welance/craft
the following is a selection of docker commands that may be handy when working with docker, for full reference consult the docker documentation
- list installed images:
docker images - list untagged images (DANGLING)
docker images --filter "dangling=true - remove all untagged images
docker rmi $(docker images -f "dangling=true" -q) - remove all images
docker rmi $(docker images -q) - list running containers
docker ps - list all containers
docker ps --all - stop all running containers
docker stop $(docker ps -q) - open a shell into the craft container
docker exec -it [CONTAINER_ID/CONTAINR_NAME] /bin/sh
The following is the standard workflow to use with the projects using craft/docker for development
create a fork of the latest release of the base repo : https://github.com/welance/welance-craft-starter
first make sure that you have docker installed and running, you can download docker from here.
run the bin/setup.sh script. the script will ask for
- customer number
- project number
- slack channel
- site name
- local host/url
- npm target dir (where npm should run)
and will generate the following files:
./bin/config.sh
./bin/schema-import.sh
./bin/schema-export.sh
./bin/local-start.sh
./bin/local-stop.sh
./bin/local-teardown.sh
./docker/docker-compose.yml
./bin/staging-start.sh
./bin/staging-stop.sh
./bin/staging-teardown.sh
./docker/docker-compose-staging.yml
./bin/make_release.sh
after the setup is completed the command will crate and launch the containers.
!!! ATTENTION !!! customer and project number are used to setup the containers environment, they cannot be easily changed once the project is on-going.
commit the chagnes to the repository, in particular the changes reated to:
to start and stop the system the command bin/local-start.sh and bin/local-stop.sh can be used.
Once the containers are started the following ports are available:
- 80 for http
- 443 https with a self signed certificate
The default credentials (user/pass) for mysql are craft/craft.
The development phase of the project will involve 3 main resources:
- the
templatesfolder - the
condfig/schema.yaml - the
pluginsfolder
The staging enviroment is setup using the technique described here and the docker image from here.
The staging environment is composed by a nginx-proxycontainer that registers automatically the new containers that are started having the environment variable VIRTUAL_HOSTset.
To run the proxy crate on the target server a docker-compose.yml file with the content posted below,
and start it with the command docker-compose up -d
Content docker-compose.yml for the proxy:
version: '2'
services:
nginx-proxy:
image: jwilder/nginx-proxy
container_name: nginx-proxy
network_mode: bridge
ports:
- "80:80"
volumes:
- /var/run/docker.sock:/tmp/docker.sock:ro
When the proxy is up you can run the containers using the project scripts:
bin/staging-start.shbin/staging-stop.shbin/staging-teardown.sh
the script make-release.sh can be used to create a zip with all resources required for release
Once the project is finished to remove the resources associated with the project (containers and data)
the bin/local-teardown.shscript is provided.
Since the database use in the containers is not accessible from outside docker a database web interface is provided to dump/load/edit the database directly. The interface of the database is Adminer and is available via http or https.
The urls are:
The parameters to log in are:
- System: MySQL
- Server: database
- Username: craft
- Password: craft
- Database: craft
The website apache configuration is stored in ./docker/craft/conf/apache2/conf.d/welance.conf.
The welance.conf contains all the settings for the installation to work and should be taken as a reference
for production installation. By default .htaccess is DISABLED, because.
Changes to the apache configuration require to restart the environment (bin/local-stop.sh, bin/local-start.sh) to be enabled.
Docker: the project folder must be located in one of the Docker File Sharing paths. You can add a folder (for example the mamp one) by edit the prefernces of your docker installation
CraftCMS: if you log in using HTTPS login with HTTP fails. This has someting to do with sessions and CSRF protection. To solve the issue clear the browser application data and retry.
Adminer: if you log in using HTTPS login with HTTP fails. This has someting to do with sessions and CSRF protection. To solve the issue clear the browser application data and retry.
for other enquiries contact enrico@welance.de
the certificate shipped with the project has been created using:
localhost:/# openssl req -x509 -nodes -days 1825 -newkey rsa:2048 -keyout welance.ssl.key -out welance.ssl.crt
Generating a 2048 bit RSA private key
....................+++
....................................................................+++
writing new private key to 'welance.ssl.key'
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) []:DE
State or Province Name (full name) []:Berlin
Locality Name (eg, city) []:Berlin
Organization Name (eg, company) []:Welance
Organizational Unit Name (eg, section) []:
Common Name (eg, fully qualified host name) []:
Email Address []:info@welance.de
The project (docker/scripts/procedures/etc.) has been realized by Andrea Giacobino from a request of Enrico Icardi.