Skip to content

WordPress stack containers

Apache

New Apache image

Since Drupal stacks 5.2.0+ Apache image wodby/php-apache has been replaced with wodby/apache with $APACHE_VHOST_PRESET=php

Restarting apache as default user:

sudo httpd -k restart

See details about virtual host preset.

AthenaPDF

See AthenaPDF stack documentation.

Blackfire

You can profile your application via blackfire.io by following the next steps:

  • Enable blackfire probe extension by adding the environment variable PHP_BLACKFIRE=1 to PHP container
  • Enable blackfire agent service in your stack
  • Add environment variables BLACKFIRE_SERVER_ID and BLACKFIRE_SERVER_TOKEN to blackfire agent service with appropriate values from your blackfire.io profile
  • Add environment variables BLACKFIRE_CLIENT_ID and BLACKFIRE_CLIENT_TOKEN to PHP service with appropriate values from your blackfire.io profile
  • Install blackfire companion extension for Chrome or Firefox
  • Start profiling your app via the extension and see data from blackfire.io dashboard

Fore more details please refer to the blackfire official documentation

Crond

A duplicate of the main PHP container runs with crond (instead of FPM). You can customize crontab from [Instance] > Stack > Settings page.

Mailhog

If Mailhog service enabled and chosen as Mail delivery service at [Instance] > Stack > Settings all outbound email will be caught by the Mailhog. You can view and release these emails from Mailhog UI, the URL can be found from Domains tab. When release specify opensmtpd in SMTP server field if you want to release emails to the default Mail transfer agent (OpenSMTPD).

MariaDB

See MariaDB stack documentation.

Memcached

You can check the status of memcached and its hits by running the following command.

watch "echo stats | nc 127.0.0.1 11211"

Nginx

New Nginx image

Since WordPress stacks 5.2.0+ nginx image wodby/wordpress-nginx has been replaced with wodby/nginx with $NGINX_VHOST_PRESET=wordpress

Restarting nginx as default user:

sudo nginx -s reload

Default virtual host preset: wordpress

Do not gzip pages in WordPress

We already gzip content on Nginx side and it works faster. Having double gzip may cause issues.

Custom config

If the default config and available environment variables are not enough for your customizations you can replace the config with your own:

  1. Copy /etc/nginx/conf.d/php.conf to your codebase, adjust to your needs
  2. Deploy code with your config file
  3. Add new environment variable NGINX_CONF_INCLUDE for nginx service, the value should the path to your *.conf file (e.g. /var/www/html/nginx.conf)

Custom config

If the default wordpress config and available environment variables are not enough for your customizations you can replace the config with your own:

  1. Copy /etc/nginx/conf.d/wordpress.conf to your codebase, adjust to your needs
  2. Deploy code with your config file
  3. Add new environment variable NGINX_CONF_INCLUDE for nginx service, the value should the path to your *.conf file (e.g. /var/www/html/nginx.conf

Mod pagespeed

Nginx comes with mod_pagespeed which is disabled by default. To enable it add NGINX_PAGESPEED=on environment variable to Nginx service.

Node.js

Light-weight node.js container to help you build your application's frontend. The containers comes without any global pre-installed packages, you can add them by running yarn global add PACKAGE or by running yarn in a directory with your package.json file.

OpenSMTPD

See OpenSMTPD stack documentation.

PHP

  • PHP can be configured with the following environment variables
  • Available php extensions
  • Composer pre-installed with a default global package hirak/prestissimo:^0.3 to download dependencies in parallel

Environment variables

Variables availability

Environment variables provided by Wodby are always available in PHP even if PHP_FPM_CLEAR_ENV set to no.

In addition to global environment variables, we provide the following variables in PHP container that you can use in your post-deployment scripts or settings files:

Variable Description
$APP_ROOT /var/www/html by default
$HTTP_ROOT e.g. /var/www/html/web
$CONF_DIR /var/www/conf by default
$WODBY_APP_NAME My app
$WODBY_HOST_PRIMARY example.com
$WODBY_URL_PRIMARY http://example.com
$WODBY_HOSTS [ "example.com", "dev.example.org.wod.by" ]

Deprecated variables:

Variable Instead use
$WODBY_APP_ROOT $APP_ROOT
$WODBY_APP_DOCROOT $HTTP_ROOT
$WODBY_CONF $CONF_DIR
$WODBY_DIR_CONF $CONF_DIR

Files directory permissions

Public files directory (symlink to /mnt/files/public) that used for uploads owned by www-data user (PHP-FPM user) by default and the default container user (wodby) has no writing permissions. So if you run a command that creates files in a public directory you will get insufficient permissions error. You can fix this problem by giving writing permissions for files directory to the owner's group (user wodby is a member of www-data group) by using one of the helper scripts:

sudo files_chmod /mnt/files/public

When you manually import files under wodby user you should change files ownership to www-data user to let PHP-FPM create new files in directories, run the following command to change the ownership:

sudo files_chmod /mnt/files/public

Helper scripts scope

files_chmod and files_chown are the only sudo commands available to wodby user and can be applied only to directories under /mnt/files .

For mode details about users and permissions in PHP container see https://github.com/wodby/php#users-and-permissions

Codebase directory permissions

The codebase owned by the default wodby (uid/gid 1000) user. If you need to give writing permissions to PHP-FPM (www-data user with uid/gid 82) to a directory outside on public files directory you can either access a container as root user or change it from the host server (single-server infrastructure):

chown -R 1000:82 /srv/wodby/instances/[INSTANCE_UUID]/app/path-to-directory
chmod -R 775 /srv/wodby/instances/[INSTANCE_UUID]/app/path-to-directory

NewRelic

You can add NewRelic APM monitoring for PHP by adding environment variables PHP_NEWRELIC_ENABLED=1 and PHP_NEWRELIC_LICENSE with your license number to PHP-FPM container. Application name will be automatically set to [Wodby Application Name] - [Wodby Instance Name], if you want to change it, use PHP_NEWRELIC_APPNAME.

Profiling

Must know before using profiler

  • Both XHProf and Xdebug profiling decreases performance and increases resources usage, especially xdebug. Try to avoid using in production
  • Traces files take a lot of disk space and may cause out of disk space very quickly

XHProf

Enable XHProf extension (from Tideways) by adding the environment variable $PHP_XHPROF=1 to your PHP container.

Use the following example snippet to profile your code:

// Start profiling.
if (extension_loaded('tideways_xhprof')) {
    tideways_xhprof_enable(TIDEWAYS_XHPROF_FLAGS_MEMORY | TIDEWAYS_XHPROF_FLAGS_CPU);
}

// Code which should be profiled.
// ...

// Store profile.
if (extension_loaded('tideways_xhprof')) {
    $xhprof_out = '/mnt/files/private/xhprof';

    if (!file_exists($xhprof_out)) {
        mkdir($xhprof_out);
    }

    file_put_contents(sprintf('%s/%s.%s.xhprof', $xhprof_out, uniqid(), 'web'), serialize(tideways_xhprof_disable()));
}

Once traces files generated you can view and analyze your traces via XHProf viewer

Xdebug profiler

Enable XDebug profiling by adding the following environment variables to your PHP container:

PHP_XDEBUG: 1
PHP_XDEBUG_PROFILER_ENABLE: 1
PHP_XDEBUG_PROFILER_ENABLE_TRIGGER: 1
PHP_XDEBUG_PROFILER_ENABLE_TRIGGER_VALUE: 1

Add XDEBUG_PROFILE=1 param to GET or POST request (or set a cookie) you want to profile. Xdebug will generate profile files in /mnt/files/xdebug/profiler. Click Update in Webgrind to access the new information. See https://xdebug.org/docs/profiler to learn more about xdebug profiling.

Once traces files generated you can view and analyze your traces via Webgrind

Xdebug (remote)

Follow these steps to debug your application instance remotely with xdebug:

  1. Enable xdebug for your instance from [Instance] > Stack > Settings
  2. Set up forwarding for xdebug: copy Xdebug SSH tunnel command from [Instance] > Stack > PHP and run on your local machine
  3. Make sure you have your IDE xdebug listener running on port 9000
  4. Start debugging in IDE
  5. Start your browser debug helper plugin (Chrome or Firefox) and open the page you want to debug

Xdebug (local)

Debugging web requests

  1. Uncomment these lines for PHP service in your docker-compose file
    PHP_XDEBUG: 1                 
    PHP_XDEBUG_DEFAULT_ENABLE: 1
    
  2. Restart containers (make)
  3. Start debugging in IDE
  4. Start your browser debug helper plugin (Chrome or Firefox) and open the page you want to debug. Alternatively, enable auto start by adding PHP_XDEBUG_REMOTE_AUTOSTART=1

Debugging CLI requests

  1. Enable Xdebug as described in the previous section
  2. Uncomment the following environment variables for PHP service in your composer file
    PHP_XDEBUG_REMOTE_CONNECT_BACK: 0    
    PHP_IDE_CONFIG: serverName=my-ide
    
  3. Configure your IDE
  4. Perform configuration as described below depending on your OS and Docker version:
Linux, Docker
  1. Uncomment PHP_XDEBUG_REMOTE_HOST: 172.17.0.1 for PHP service (if you have docker 18.03+ you can specify host.docker.internal instead of the IP address)
  2. Restart containers (make)
macOS, Docker
  1. Uncomment PHP_XDEBUG_REMOTE_HOST: 10.254.254.254 for PHP service (just a random IP that very likely won't be used by anything else).
  2. Restart containers (make)
  3. You also need to have loopback alias with IP from above. You need this only once and that settings stays active until logout or restart:
    sudo ifconfig lo0 alias 10.254.254.254
    
  4. To add the loopback alias after a reboot, add the following contents to /Library/LaunchDaemons/docker4drupal.loopback.plist:
    <plist version="1.0">
      <dict>
        <key>Label</key>
        <string>Default Loopback alias</string>
        <key>ProgramArguments</key>
        <array>
          <string>/sbin/ifconfig</string>
          <string>lo0</string>
          <string>alias</string>
          <string>10.254.254.254</string>
          <string>netmask</string>
          <string>255.255.255.0</string>
        </array>
        <key>RunAtLoad</key>
        <true/>
      </dict>
    </plist>
    
Windows
  1. Uncomment PHP_XDEBUG_REMOTE_HOST: 10.0.75.1 for PHP service (default IP of Docker NAT).
  2. Restart containers (make)
  3. Allow listen connection for your IDE in Windows Firewall > Allow an app ..

Also, you might need to add the following lines to your hosts file (see related github issue):

0.0.0.0         localhost
10.0.75.1       localhost

IDE configuration

You must additionally configure your IDE to debug CLI requests.

PHPStorm
  1. Open Run > Edit Configurations from the main menu, choose Defaults > PHP Web Page in the left sidebar
  2. Click to [...] to the right of Server and add a new server
    • Enter name my-ide (as specified in PHP_IDE_CONFIG)
    • Enter any host, it does not matter
    • Check Use path mappings, select path to your project and enter /var/www/html in the right column (Absolute path on the server)
  3. Choose newly created server in "Server" for PHP Web Page
  4. Save settings

WP CLI

PHP container comes with pre-installed WP CLI.

Redirects

If you need to make a redirect from one domain to another you can do it by customizing configuration files of nginx or by adding the snippets below to your wp-config.php file.

Redirect from one domain to another:

if (isset($_SERVER['WODBY_ENVIRONMENT_TYPE']) && $_SERVER['WODBY_ENVIRONMENT_TYPE'] == 'prod' && php_sapi_name() != "cli") {
    if ($_SERVER['HTTP_HOST'] == 'redirect-from-domain.com') {
      header('HTTP/1.0 301 Moved Permanently');
      header('Location: http://redirect-to-domain.com' . $_SERVER['REQUEST_URI']);
      exit();
    }
}

Redirect from multiple domains:

if (isset($_SERVER['WODBY_ENVIRONMENT_TYPE']) && $_SERVER['WODBY_ENVIRONMENT_TYPE'] == 'prod' && php_sapi_name() != "cli") {
    $redirect_from = array(
      'redirect-from-domain-1.com',
      'redirect-from-domain-2.com',
    );

    if (in_array($_SERVER['HTTP_HOST'], $redirect_from)) {
      header('HTTP/1.0 301 Moved Permanently');
      header('Location: http://redirect-to-domain.com' . $_SERVER['REQUEST_URI']);
      exit();
    }
}

PostgreSQL

See PostgreSQL stack documentation.

Redis

You can configure Redis via environment variables that listed at https://github.com/wodby/redis. See Redis stack for more details.

Integration:

  1. Install and activate redis plugin
  2. Go to redis plugin settings page and click "enable object cache" button

Rsyslog

Rsyslog can be used to stream your applications logs. It's similar to using syslog, however there's no syslog in PHP container (one process per container). Rsyslog will stream all incoming logs to a container output.

You can use Monolog with SyslogUdpHandler to stream logs to rsyslog

SSHd

A duplicate of PHP container runs with SSH daemon (instead of FPM). You can find access information on [Instance] > Stack > SSH

Public SSH keys from your Wodby profile will be added automatically for all users that have access to an instance.

Varnish

New Varnish image

Since WordPress stacks 5.2.0+ Varnish image wodby/wordpress-varnish has been replaced with wodby/varnish and $VARNISH_CONFIG_PRESET=wordpress

Integration:

  1. Go to App instance > Stack > Varnish in Wodby dashboard and copy automatically generated value of $VARNISH_PURGE_KEY
  2. Install and activate Varnish Caching plugin in your WordPress website
  3. On the plugin cache settings configure as shown below:
    Varnish Caching plugin settings
  4. Copy/paste the key to Purge key in plugin setting
  5. Save all plugin settings changes

For more details see Varnish stack documentation

Webgrind

Webgrind allows you view and analyze Xdebug profiler output and generate call graphs for visualisation.

XHProf viewer

XHProf viewer allows you view and analyze XHProf traces output and generate call graphs for visualisation.