Wordpress
Install dev env
You must have docker-compose installed
You may have to change user ID in the docker-compose.yml and/or the wordpress url in config/parameters.yml
docker-compose up --build
Automatic deploy in production/preproduction/ci
Copy the code to your destination server and run the make install command. The command can also be run on a deployment server, which will install the dependencies and then transfer it to the prod/preprod server.
To handle parameters, a mapping of environment variables is defined in the composer.json this allow to populate the environment setting on deployments. This will create a config/parameters.yml file which will be read at runtime by the src/wp-config.php (which is copied in wp/ directory on deployments).
This line in the composer.json :
"database_wp_host": "DATABASE_WP_HOST",
means that you should have a environment variable DATABASE_WP_HOST when running make install.
Note that variables names in the composer.json starting with docker_ are only used for bootstrap purposes in a development docker environement.
If you're deploying using a home made tool, you should be able to do this:
#> export DATABASE_WP_HOST="my.production.database"
#> export DATABASE_WP_PORT="3306"
[... do this for all vars in composer.json...]
#> my_deploy_script.sh # must contain a "make install"
Add a plugin/theme
Go to https://wpackagist.org/ and search for a plugin/theme
Click on the version of the plugin to install
Copy/paste the generated line in composer.json in the require section
Add a plugin/theme
Go to https://wpackagist.org/ and search for a plugin/theme
Click on the version of the plugin to install
Copy/paste the generated line in composer.json in the require section
Add a custom plugin/theme
You should put your plugin/theme the src/ folder and add a copy command in the install section of Makefile like this:
install:
cp -R src/my-awesome-plugin wp/wp-content/plugins
cp -R src/my-awesome-theme wp/wp-content/themes
Automatic configuration of a plugin/theme
The best option to configure a plugin or a theme is to use wp-cli (included in this setup).
Create a folder in this repository src/plugins/<plugin name> and put a setup.sh file inside it. Then just add your commands for the autoconfiguration in this file. Thoses commands will be executed every time the container is restarted.
To test if your plugin can be used/configured with wp-cli, run the docker-compose, get inside the php container using a docker-compose run php bash , go to /app/wp and use wp-cli command : wp. YOU MUST BE INSIDE THE wp DIRECTORY (command pwd should show /app/wp).
Add a configuration in Wordpress via a define
If you need to add a parameter in the wp-config.php for your plugin, Follow these steps :
First, go to config/parameters.yml.dist (NEVER EVER MODIFY OR COMMIT THE parameters.yml file) and add your setting. You can use arrays or map, but for simplivity sake, you should stay with a flat key/value file.
Second, open composer.json and create the mapping in the extra:incenteev-parameters:env-map section. Usually, you should use for environment variable the same name as your setting in the parameters.yml.dist, but in uppercase.
Third, go to src/wp-config.php and add a line just before /** Absolute path to the WordPress directory. */. You line should look like this:
define('MY_PLUGIN_SETTING', $config['my_plugin_setting']);
Where my_plugin_setting is the setting you've added
Finally, run a make install, and voilà! You're done