Kayak

Kayak is a wrapper around docker-compose, based on Vessel. By default, the following containers are started: Apache/php7.0, MariaDB, PhpMyAdmin. The /wp_html directory is the web root which is mapped to the apache/php container. A Dockerfile is included for apache2/wordpress (Dockerfile). This adds a few extra things to the wordpress image, such as wp-cli. You can start the containers with:

kayak start

How to install WordPress

Before installing WordPress you need to create a .env file, kayak do it for you with

kayak init

just edit the .env file and then install WordPress with:

kayak install

If the installation fails due to a database connection error, simply wait a minute and try again. Most of the times mysql just needs a while to get up and running.

Structure

Everything you might want to commit is already prepared for you in the root directory: both the themes and plugins folders are created and wired to the internal wp-content directory inside the Wordpress container.

When you start the containers for the first time, an entrypoint script is launched in order to fix some chown issues on the themes and plugins folder.

This might take a while, as it needs to configure Apache, Wordpress and MySQL before fixing the permissions.

Wordpress URL and Ports

Kayak binds to port 80 and 3306 on your machine, so you can simply go to http://localhost in your browser. Please make sure you don't have other services running under those ports.

Traefik proxy

If you want to run multiple kayak instances, you should use a proxy. We provide a working configuration for traefik and a ready to use compose file. Just set

PROXY=true

in your .env file and we'll take care of everything. ** Please note that we use default local domains for wordpress, so your application will be ready on https://sitename.wp.test **

WP-Cli

WP-CLI is a set of command-line tools for managing WordPress installations. You can update plugins, configure multisite installs and much more, without using a web browser. To use wp-cli just type:­

kayak wp  

Wordmove

Kayak comes with Wordmove available in a separate container, thanks to the Docker Image currently maintained by @welaika. This way, you do not need to install Ruby nor Wordmove on your local machine.

Attention: in order to be able to use Wordmove with Kayak, you do need to:

1. Specify the MOVEFILE_PATH variable inside your .env file.

2. Start creating your movefile from movefile.yml, as it comes configured for Wordmove to work with variables specified in .env file. You may modify the sql_adapter to either one of your choice, but wpcli should work fine in most cases and it's already configured inside the Wordmove container.

To use Wordmove, simply run:

kayak wordmove [your wordmove parameters]

Take a look at Welaika's Wordmove project here.

TIP: you can configure your movefile to accept environment variables described in .env using the syntax:

<%= ENV['YOUR_ENV_VAR_NAME'] %>

Database dump

you can dump the database anytime you want with a line:

kayak dump > dump.sql

If you need to restore it or import a colleague's database dump you can simply run:

kayak import

assuming that the dump file is called dump.sql

Share your local WordPress with others

Sometimes you want to share your local WordPress install with a colleague or a client to let them see what you're working on. Meet kayak serve.

kayak serve

kayak uses ngrok.io to create a tunnel and a WordPress plugin (relative-url) to make everything work. When you stop ngrok (CTRL-C), kayak deactivates relative-url plugin to let you work as usual.

Credits

Kayak is heavily based on Chris Fidao Vessel