WordPress: Difference between revisions

From NixOS Wiki
imported>Onny
mNo edit summary
Klinger (talk | contribs)
m changed example from 21.11 to 24.05
 
(17 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[https://wordpress.org Wordpress] is a self-hosted content management web application, especially designed for blogging but also a good way to start creating your own website. It can be customized with themes and a built-in site editor and further extended with plugins.
[https://wordpress.org WordPress] is a self-hosted content management web application, especially designed for blogging but also a good way to start creating your own website. It can be customized with themes and a built-in site editor and further extended with plugins.
 
{{Note|Parts of this instruction and module are not yet stable and will be available in the upcoming NixOS 23.05 release.}}


== Installation ==
== Installation ==


A simple local setup of Wordpress can be enabled with the following setup
A simple local setup of WordPress can be enabled with the following setup


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
Line 11: Line 9:
</syntaxHighlight>
</syntaxHighlight>


Visit http://localhost to setup your new Wordpress instance. By default, a Mysql server is configured automatically so you won't have to setup the database backend.
Visit http://localhost to setup your new WordPress instance. By default, a Mysql server is configured automatically so you won't have to setup the database backend.


== Configuration ==
== Configuration ==


It is possible to configure the Wordpress <code>wp-config.php</code> file declarative using the <code>settings</code> option. See examples below and [https://developer.wordpress.org/apis/wp-config-php upstream documentation] for available settings.
It is possible to configure the WordPress <code>wp-config.php</code> file declarative using the <code>settings</code> option. See examples below and [https://developer.wordpress.org/apis/wp-config-php upstream documentation] for available settings.
   
   
=== Language ===
=== Language ===


The default language of the Wordpress module will be English. It is possible to enable additional language support for languages which are [https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=wordpressPackages.languages already packaged]. Using <code>settings</code> you can configure the default language. In this example, we're going to enable the German language.
The default language of the WordPress module will be English. It is possible to enable additional language support for languages which are [https://search.nixos.org/packages?channel=unstable&from=0&size=50&sort=relevance&type=packages&query=wordpressPackages.languages already packaged]. Using <code>settings</code> you can configure the default language. In this example, we're going to enable the German language.


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
Line 50: Line 48:
</syntaxHighlight>
</syntaxHighlight>


Consult the [https://translate.wordpress.org translation portal] of Wordpress for the specific country and language codes available. This example is using the code <code>de_DE</code> (Germany/German) in the source URL and also the <code>settings</code> part.
Consult the [https://translate.wordpress.org translation portal] of WordPress for the specific country and language codes available. This example is using the code <code>de_DE</code> (Germany/German) in the source URL and also the <code>settings</code> part.


=== Themes and plugins ===
=== Themes and plugins ===
Line 59: Line 57:
   themes = {
   themes = {
     inherit (pkgs.wordpressPackages.themes)
     inherit (pkgs.wordpressPackages.themes)
       twentytwentytwo;
       twentytwentythree;
   };
   };
   plugins = {
   plugins = {
     inherit (pkgs.wordpressPackages.plugins)
     inherit (pkgs.wordpressPackages.plugins)  
       antispam-bee
       antispam-bee
       opengraph;
       opengraph;
Line 69: Line 67:
</syntaxHighlight>
</syntaxHighlight>


Manually package a Wordpress theme or plugin can be accomplished like this:
Manually package a WordPress theme or plugin can be accomplished like this:


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
Line 95: Line 93:
</syntaxHighlight>
</syntaxHighlight>


You can package any available Wordpress extension, for example from the [https://wordpress.org/themes official theme] or [https://wordpress.org/plugins plugin repository]. Be sure to replace the ''name'', url and ''sha256'' part according to your desired extension.
You can package any available WordPress extension, for example from the [https://wordpress.org/themes official theme] or [https://wordpress.org/plugins plugin repository]. Be sure to replace the ''name'', url and ''sha256'' part according to your desired extension.


If you want to automatically enable and activate the ''responsive'' theme, add this <code>settings</code> line
If you want to automatically enable and activate the ''responsive'' theme, add this <code>settings</code> line
Line 114: Line 112:
   require_once ABSPATH . 'wp-admin/includes/plugin.php';
   require_once ABSPATH . 'wp-admin/includes/plugin.php';
   activate_plugin( 'akismet/akismet.php' );
   activate_plugin( 'akismet/akismet.php' );
'';
</syntaxHighlight>
=== Max upload filesize ===
The following example configuration changes the max upload filesize limit to 1GB for the WordPress instance with the hostname <code>localhost</code>. Change the [[phpfpm]] pool name according to your hostname.
<syntaxHighlight lang="nix">
services.phpfpm.pools."wordpress-localhost".phpOptions = ''
  upload_max_filesize=1G
  post_max_size=1G
'';
'';
</syntaxHighlight>
</syntaxHighlight>
Line 119: Line 128:
=== Mail delivery ===
=== Mail delivery ===


Mail clients like [[Msmtp]] can be used to configure mail delivery for Wordpress. This can be useful for sending registration mails or notifications for new comments etc.
Mail clients like [[Msmtp]] can be used to configure mail delivery for WordPress. This can be useful for sending registration mails or notifications for new comments etc.


By default Wordpress will use the sender mail <code>wordpress@example.org</code> where ''example.org'' is the primary domain name configured for the Wordpress instance. By installing and using the plugin [https://wordpress.org/plugins/static-mail-sender-configurator/ static-mail-sender-configurator] it is possible to declaratively configure and change the sender address, for example to <code>noreply@example.org</code>.
By default WordPress will use the sender mail <code>wordpress@example.org</code> where ''example.org'' is the primary domain name configured for the WordPress instance. By installing and using the plugin [https://wordpress.org/plugins/static-mail-sender-configurator/ static-mail-sender-configurator] it is possible to declaratively configure and change the sender address, for example to <code>noreply@example.org</code>.


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
Line 148: Line 157:
=== Upgrading ===
=== Upgrading ===


Wordpress automatically performs an database and software upgrade as soon as a new package version is installed. Major version upgrades of the <code>pkgs.wordpress</code> package are performed between every new NixOS release. In case you wish to switch to a newer major Wordpress version while staying on your latest NixOS version, you can choose between Wordpress package versions available in the repository.
WordPress automatically performs an database and software upgrade as soon as a new package version is installed. Major version upgrades of the <code>pkgs.wordpress</code> package are performed between every new NixOS release. In case you wish to switch to a newer major WordPress version while staying on your latest NixOS version, you can choose between WordPress package versions available in the repository.


For example switch to Wordpress 6.1 while the default Wordpress package version for NixOS 22.11 is 6.0
For example switch to WordPress 6.4 while the default WordPress package version for NixOS 24.05 is 6.5


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
services.wordpress.sites."example.org" = {
services.wordpress.sites."example.org" = {
   package = pkgs.wordpress6_1;
   package = pkgs.wordpress6_4;
};
};
</syntaxHighlight>
</syntaxHighlight>
Line 160: Line 169:
=== Using wp-cli ===
=== Using wp-cli ===


wp-cli is a command line tool to configure and manage Wordpress instances. The following example command creates a administration account with the name <code>test</code> and the password <code>test123</code>
wp-cli is a command line tool to configure and manage WordPress instances. The following example command creates a administration account with the name <code>test</code> and the password <code>test123</code>


<syntaxHighlight lang="bash">
<syntaxHighlight lang="bash">
Line 166: Line 175:
</syntaxHighlight>
</syntaxHighlight>


Change the home directory <code>/var/lib/wordpress/example.org</code> according to your instance domain name. The Wordpress root directory is specified with <code>--path</code> and can be found in the generated web server configuration.
Change the home directory <code>/var/lib/wordpress/example.org</code> according to your instance domain name. The WordPress root directory is specified with <code>--path</code> and can be found in the generated web server configuration.


== Tips and tricks ==
== Tips and tricks ==
Line 172: Line 181:
=== Force https-URLs behind reverse proxy ===
=== Force https-URLs behind reverse proxy ===


In case you're running Wordpress behind a reverse proxy which offers a SSL/https connection to the outside, you can force Wordpress to use the https protocol
In case you're running WordPress behind a reverse proxy which offers a SSL/https connection to the outside, you can force WordPress to use the https protocol


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
Line 190: Line 199:
'''Meta information'''
'''Meta information'''


The Wordpress plugin [https://wordpress.org/plugins/wordpress-seo Yoast SEO] helps you to configure meta information of your Wordpress page. You can install it like this
The WordPress plugin [https://wordpress.org/plugins/wordpress-seo Yoast SEO] helps you to configure meta information of your WordPress page. You can install it like this


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
services.wordpress.sites."example.org" = {
services.wordpress.sites."example.org" = {
   plugins = [ pkgs.wordpressPackages.plugins.wordpress-seo ];
   plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      wordpress-seo;
  };
};
};
</syntaxHighlight>
</syntaxHighlight>


After enabling the plugin in the Wordpress admin interface, finish the first-time installation wizard of Yoast SEO. In most cases the free features offered by the plugin should be sufficient, so you won't have to register or enable any premium extensions. Other integrations which are not needed can be disabled in ''Yoast SEO -> Integrations''.
After enabling the plugin in the WordPress admin interface, finish the first-time installation wizard of Yoast SEO. In most cases the free features offered by the plugin should be sufficient, so you won't have to register or enable any premium extensions. Other integrations which are not needed can be disabled in ''Yoast SEO -> Integrations''.


It's worth tweaking settings in ''Yoast SEO -> Search Appearance''. Especially configuring a social image and organization logo including name and description is useful if your page gets shared and indexed.
It's worth tweaking settings in ''Yoast SEO -> Search Appearance''. Especially configuring a social image and organization logo including name and description is useful if your page gets shared and indexed.
Line 206: Line 218:
'''Picture compression'''
'''Picture compression'''


Your website gets better ranking for search engines if it is optimized to load fast. The Wordpress plugin [https://wordpress.org/plugins/webp-express webp-express] compresses your existing and future images automatically into a modern efficient image format and reduces their file size.
Your website gets better ranking for search engines if it is optimized to load fast. The WordPress plugin [https://wordpress.org/plugins/webp-express webp-express] compresses your existing and future images automatically into a modern efficient image format and reduces their file size.


Following example installs the plugin and adds an additional writeable directory to the Wordpress package, otherwise the plugin will fail due to permission issues. This hack only works for one specific instance, in this example for ''example.org''. Replace the site name on all occurrences.
Following example installs the plugin and adds an additional writeable directory to the WordPress package, otherwise the plugin will fail due to permission issues. This hack only works for one specific instance, in this example for ''example.org''. Replace the site name on all occurrences.
<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
services.wordpress.sites."example.org" = {
services.wordpress.sites."example.org" = {
   plugins = [ pkgs.wordpressPackages.plugins.webp-express ];
   plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      webp-express;
  };
};
};


Line 229: Line 244:
</syntaxHighlight>
</syntaxHighlight>


In the Wordpress administrator interface go to ''Settings -> WebP Express''. One possible configuration which is suitable for the NixOS module could be
In the WordPress administrator interface go to ''Settings -> WebP Express''. One possible configuration which is suitable for the NixOS module could be


* Scope: Uploads only (we cannot convert theme files)
* Scope: Uploads only (we cannot convert theme files)
Line 245: Line 260:
'''Lazy load images'''
'''Lazy load images'''


Using the Wordpress plugin [https://wordpress.org/plugins/jetpack Jetpack], it is possible to enable lazy loading of images. That means, images only visible in the current view of the web browser are loaded. This will speed up initial page load.
Using the WordPress plugin [https://wordpress.org/plugins/jetpack Jetpack], it is possible to enable lazy loading of images. That means, images only visible in the current view of the web browser are loaded. This will speed up initial page load.


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
services.wordpress.sites."example.org" = {
services.wordpress.sites."example.org" = {
   plugins = [ pkgs.wordpressPackages.plugins.jetpack ];
   plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      jetpack;
  };
};
};
</syntaxHighlight>
</syntaxHighlight>


After enabling the plugin, in the Wordpress admin interface go to ''Jetpack -> Settings -> Performance'' and ensure that lazy loading of Images is enabled. Note that Jetpack comes with a lot of optional modules which should be disabled if not used. On the same page go to ''Debug'' in the bottom menu and click on the last link offering the list of all modules. Disable all modules you don't need instead of ''Lazy Images''.   
After enabling the plugin, in the WordPress admin interface go to ''Jetpack -> Settings -> Performance'' and ensure that lazy loading of Images is enabled. Note that Jetpack comes with a lot of optional modules which should be disabled if not used. On the same page go to ''Debug'' in the bottom menu and click on the last link offering the list of all modules. Disable all modules you don't need instead of ''Lazy Images''.   


'''Webserver text compression'''
'''Webserver text compression'''


Compressing text served by the web server enhances page loading times. This example enables text compression on the webserver [[Nginx]]. Please refer upstream documentation in case you're going to use a different web server for your Wordpress setup.
Compressing text served by the web server enhances page loading times. This example enables text compression on the webserver [[Nginx]]. Please refer upstream documentation in case you're going to use a different web server for your WordPress setup.


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
Line 272: Line 290:
'''Minify and merge Javascript and CSS'''
'''Minify and merge Javascript and CSS'''


Page load can further optimized by minify and merge Javascript and CSS files. The plugin [https://wordpress.org/plugins/merge-minify-refresh merge-minify-refresh] can be used to achieve this. The following example installs the plugin and creates an additional directory required for the plugin to work. This hack is specified for one specific instance for the domain ''example.org'' (replace all occurrences with your preferred domain name). Don't forget to enable the plugin in the Wordpress admin interface.
Page load can further optimized by minify and merge Javascript and CSS files. The plugin [https://wordpress.org/plugins/merge-minify-refresh merge-minify-refresh] can be used to achieve this. The following example installs the plugin and creates an additional directory required for the plugin to work. This hack is specified for one specific instance for the domain ''example.org'' (replace all occurrences with your preferred domain name). Don't forget to enable the plugin in the WordPress admin interface.


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
services.wordpress.sites."example.org" = {
services.wordpress.sites."example.org" = {
   plugins = [ pkgs.wordpressPackages.plugins.merge-minify-refresh ];
   plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      merge-minify-refresh;
  };
};
};


Line 303: Line 324:
=== Security hardening ===
=== Security hardening ===


By enabling these two plugins, your Wordpress login is protected by a simple numeric captcha and the xml-rpc api, used by alternative Wordpress clients, gets disabled.
By enabling these two plugins, your WordPress login is protected by a simple numeric captcha and the xml-rpc api, used by alternative WordPress clients, gets disabled.


<syntaxHighlight lang="nix">
<syntaxHighlight lang="nix">
Line 356: Line 377:
Please note that this exposes sensible information about your server setup therefore this option should not be enabled in production.
Please note that this exposes sensible information about your server setup therefore this option should not be enabled in production.


[[Category:Services]]
== Known issues ==
 
There are some known issues regarding the WordPress module on NixOS
 
* Some plugins assume an absolute persistent path which Nix doesn't provide https://github.com/NixOS/nixpkgs/issues/210895
* The wp-content root nor the plugin directories are writeable which prevents some plugins to work https://github.com/NixOS/nixpkgs/issues/150951
* The wordpressPackages set misses translation files for themes and plugins. This means only the English interface will be available https://github.com/helsinki-systems/wp4nix/issues/2
* Plugins and themes are managed by the NixOS module. Manually updating or installing them through the WordPress web interface is not supported at the moment
 
[[Category:Server]]
[[Category:Web Applications]]
[[Category:Web Applications]]

Latest revision as of 15:47, 4 June 2024

WordPress is a self-hosted content management web application, especially designed for blogging but also a good way to start creating your own website. It can be customized with themes and a built-in site editor and further extended with plugins.

Installation

A simple local setup of WordPress can be enabled with the following setup

services.wordpress.sites."localhost" = {};

Visit http://localhost to setup your new WordPress instance. By default, a Mysql server is configured automatically so you won't have to setup the database backend.

Configuration

It is possible to configure the WordPress wp-config.php file declarative using the settings option. See examples below and upstream documentation for available settings.

Language

The default language of the WordPress module will be English. It is possible to enable additional language support for languages which are already packaged. Using settings you can configure the default language. In this example, we're going to enable the German language.

services.wordpress.sites."localhost" = {
  languages = [ pkgs.wordpressPackages.languages.de_DE ];
  settings = {
    WPLANG = "de_DE";
  };
};

Alternatively you can package your own language files following this example:

{ pkgs, ... }: let

  wordpress-language-de = pkgs.stdenv.mkDerivation {
    name = "wordpress-${pkgs.wordpress.version}-language-de";
    src = pkgs.fetchurl {
      url = "https://de.wordpress.org/wordpress-${pkgs.wordpress.version}-de_DE.tar.gz";
      hash = "sha256-dlas0rXTSV4JAl8f/UyMbig57yURRYRhTMtJwF9g8h0=";
    };
    installPhase = "mkdir -p $out; cp -r ./wp-content/languages/* $out/";
  };

in {

  services.wordpress.sites."localhost".languages = [ wordpress-language-de ];

}

Consult the translation portal of WordPress for the specific country and language codes available. This example is using the code de_DE (Germany/German) in the source URL and also the settings part.

Themes and plugins

Themes and plugins which are already packaged can be integrated like this:

services.wordpress.sites."localhost" = {
  themes = {
    inherit (pkgs.wordpressPackages.themes)
      twentytwentythree;
  };
  plugins = {
    inherit (pkgs.wordpressPackages.plugins) 
      antispam-bee
      opengraph;
  };
};

Manually package a WordPress theme or plugin can be accomplished like this:

let

wordpress-theme-responsive = pkgs.stdenv.mkDerivation rec {
  name = "responsive";
  version = "4.7.9";
  src = pkgs.fetchzip {
    url = "https://downloads.wordpress.org/theme/responsive.${version}.zip";
    hash = "sha256-7K/pwD1KAuipeOAOLXd2wqOUEhwk+uNGIllVWzDHzp0=";
  };
  installPhase = "mkdir -p $out; cp -R * $out/";
};

in {

  services.wordpress.sites."localhost" = {
    themes = {
      inherit wordpress-theme-responsive;
    };
  };

}

You can package any available WordPress extension, for example from the official theme or plugin repository. Be sure to replace the name, url and sha256 part according to your desired extension.

If you want to automatically enable and activate the responsive theme, add this settings line

settings = {
  WP_DEFAULT_THEME = "responsive";
};

In case you want to automatically enable and activate the plugin, in this example akismet, you can add following to extraConfig

extraConfig = ''
  if ( !defined('ABSPATH') )
    define('ABSPATH', dirname(__FILE__) . '/');
  require_once(ABSPATH . 'wp-settings.php');
  require_once ABSPATH . 'wp-admin/includes/plugin.php';
  activate_plugin( 'akismet/akismet.php' );
'';

Max upload filesize

The following example configuration changes the max upload filesize limit to 1GB for the WordPress instance with the hostname localhost. Change the phpfpm pool name according to your hostname.

services.phpfpm.pools."wordpress-localhost".phpOptions = ''
  upload_max_filesize=1G
  post_max_size=1G
'';

Mail delivery

Mail clients like Msmtp can be used to configure mail delivery for WordPress. This can be useful for sending registration mails or notifications for new comments etc.

By default WordPress will use the sender mail wordpress@example.org where example.org is the primary domain name configured for the WordPress instance. By installing and using the plugin static-mail-sender-configurator it is possible to declaratively configure and change the sender address, for example to noreply@example.org.

services.wordpress.sites."example.org" = {
  plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      static-mail-sender-configurator;
  };
  extraConfig = ''
      // Enable the plugin 
      if ( !defined('ABSPATH') )
        define('ABSPATH', dirname(__FILE__) . '/');
      require_once(ABSPATH . 'wp-settings.php');
      require_once ABSPATH . 'wp-admin/includes/plugin.php';
      activate_plugin( 'static-mail-sender-configurator/static-mail-sender-configurator.php' );
  '';
  settings = {
    # Change sender mail address
    WP_MAIL_FROM = "noreply@localhost";
  };
};

Maintenance

Upgrading

WordPress automatically performs an database and software upgrade as soon as a new package version is installed. Major version upgrades of the pkgs.wordpress package are performed between every new NixOS release. In case you wish to switch to a newer major WordPress version while staying on your latest NixOS version, you can choose between WordPress package versions available in the repository.

For example switch to WordPress 6.4 while the default WordPress package version for NixOS 24.05 is 6.5

services.wordpress.sites."example.org" = {
  package = pkgs.wordpress6_4;
};

Using wp-cli

wp-cli is a command line tool to configure and manage WordPress instances. The following example command creates a administration account with the name test and the password test123

sudo -u wordpress HOME=/var/lib/wordpress/example.org nix run nixpkgs#wp-cli -- --path=/nix/store/wxzcmjfkyk5nfk7vidzbz1mz28wnfl5b-wordpress-example.org-6.1.1/share/wordpress user create test test@example.org --role=administrator --user_pass=test123

Change the home directory /var/lib/wordpress/example.org according to your instance domain name. The WordPress root directory is specified with --path and can be found in the generated web server configuration.

Tips and tricks

Force https-URLs behind reverse proxy

In case you're running WordPress behind a reverse proxy which offers a SSL/https connection to the outside, you can force WordPress to use the https protocol

services.wordpress.sites."localhost" = {
  settings = {
    # Needed to run behind reverse proxy
    FORCE_SSL_ADMIN = true;
  };
  extraConfig = ''
    $_SERVER['HTTPS']='on';
  '';
};

Search engine optimization (SEO)

Meta information

The WordPress plugin Yoast SEO helps you to configure meta information of your WordPress page. You can install it like this

services.wordpress.sites."example.org" = {
  plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      wordpress-seo;
  };
};

After enabling the plugin in the WordPress admin interface, finish the first-time installation wizard of Yoast SEO. In most cases the free features offered by the plugin should be sufficient, so you won't have to register or enable any premium extensions. Other integrations which are not needed can be disabled in Yoast SEO -> Integrations.

It's worth tweaking settings in Yoast SEO -> Search Appearance. Especially configuring a social image and organization logo including name and description is useful if your page gets shared and indexed.

SEO optimization can be performed page wise. In the page editor you'll find SEO analysis and tips on the right pane.

Picture compression

Your website gets better ranking for search engines if it is optimized to load fast. The WordPress plugin webp-express compresses your existing and future images automatically into a modern efficient image format and reduces their file size.

Following example installs the plugin and adds an additional writeable directory to the WordPress package, otherwise the plugin will fail due to permission issues. This hack only works for one specific instance, in this example for example.org. Replace the site name on all occurrences.

services.wordpress.sites."example.org" = {
  plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      webp-express;
  };
};

nixpkgs.overlays = [
  (self: super: {
    wordpress = super.wordpress.overrideAttrs (oldAttrs: rec {
      installPhase = oldAttrs.installPhase + ''
        ln -s /var/lib/wordpress/example.org/webp-express $out/share/wordpress/wp-content/webp-express
      '';
    });
  })
];

systemd.tmpfiles.rules = [
  "d '/var/lib/wordpress/example.org/webp-express' 0750 wordpress wwwrun - -"
];

In the WordPress administrator interface go to Settings -> WebP Express. One possible configuration which is suitable for the NixOS module could be

  • Scope: Uploads only (we cannot convert theme files)
  • Destination folder: Mingled (save webp converted images in the same place as original files)
  • File extension: Set to ".webp"
  • Destination structure: Image roots
  • Disable all .htaccess rules (doesn't apply for any web server)
  • Convert on upload: yes (future uploads will be converted to webp file format)
  • Alter HTML: Replace image URLs (we'll only reference compressed webp images on the page)
  • Reference webps that haven't been converted yet: Yes
  • How to replace: The complete page

Further click on Bulk convert to convert all existing images.

Lazy load images

Using the WordPress plugin Jetpack, it is possible to enable lazy loading of images. That means, images only visible in the current view of the web browser are loaded. This will speed up initial page load.

services.wordpress.sites."example.org" = {
  plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      jetpack;
  };
};

After enabling the plugin, in the WordPress admin interface go to Jetpack -> Settings -> Performance and ensure that lazy loading of Images is enabled. Note that Jetpack comes with a lot of optional modules which should be disabled if not used. On the same page go to Debug in the bottom menu and click on the last link offering the list of all modules. Disable all modules you don't need instead of Lazy Images.

Webserver text compression

Compressing text served by the web server enhances page loading times. This example enables text compression on the webserver Nginx. Please refer upstream documentation in case you're going to use a different web server for your WordPress setup.

services.nginx.extraConfig = ''
  gzip on;
  gzip_vary on;
  gzip_comp_level 4;
  gzip_min_length 256;
  gzip_proxied expired no-cache no-store private no_last_modified no_etag auth;
  gzip_types application/atom+xml application/javascript application/json application/ld+json application/manifest+json application/rss+xml application/vnd.geo+json application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/bmp image/svg+xml image/x-icon text/cache-manifest text/css text/plain text/vcard text/vnd.rim.location.xloc text/vtt text/x-component text/x-cross-domain-policy;
'';

Minify and merge Javascript and CSS

Page load can further optimized by minify and merge Javascript and CSS files. The plugin merge-minify-refresh can be used to achieve this. The following example installs the plugin and creates an additional directory required for the plugin to work. This hack is specified for one specific instance for the domain example.org (replace all occurrences with your preferred domain name). Don't forget to enable the plugin in the WordPress admin interface.

services.wordpress.sites."example.org" = {
  plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      merge-minify-refresh;
  };
};

nixpkgs.overlays = [
  (self: super: {
    wordpress = super.wordpress.overrideAttrs (oldAttrs: rec {
      installPhase = oldAttrs.installPhase + ''
        ln -s /var/lib/wordpress/example.org/mmr $out/share/wordpress/wp-content/mmr
      '';
    });
  })
];

systemd.tmpfiles.rules = [
  "d '/var/lib/wordpress/example.org/mmr' 0750 wordpress wwwrun - -"
];

Useful online tools

There are some resources which might be useful to check the SEO score of your page

Security hardening

By enabling these two plugins, your WordPress login is protected by a simple numeric captcha and the xml-rpc api, used by alternative WordPress clients, gets disabled.

services.wordpress.sites."example.org" = {

  plugins = {
    inherit (pkgs.wordpressPackages.plugins)
      disable-xml-rpc
      simple-login-captcha;
  };
  extraConfig = ''
      // Enable the plugin 
      if ( !defined('ABSPATH') )
        define('ABSPATH', dirname(__FILE__) . '/');
      require_once(ABSPATH . 'wp-settings.php');
      require_once ABSPATH . 'wp-admin/includes/plugin.php';
      activate_plugin( 'disable-xml-rpc/disable-xml-rpc.php' );
      activate_plugin( 'simple-login-captcha/simple-login-captcha.php' );
  '';
};

Troubleshooting

Enable logging

To enable logging add the following lines to settings and extraConfig

services.wordpress.sites."localhost" = {
  settings = {
    WP_DEBUG = true;
    WP_DEBUG_LOG = true;
  };
  extraConfig = ''
    ini_set( 'error_log', '/var/lib/wordpress/localhost/debug.log' );
  '';
};

Since the default location to the folder wp-content is not writable, we redirect the log file path to /var/lib/wordpress/localhost/debug.log. All error messages will be stored there. Change the folder name localhost to the name of your site.

In case you want to print error messages directly in your browser, append following line

services.wordpress.sites."localhost" = {
  extraConfig = ''
    @ini_set( 'display_errors', 1 );
  '';

Please note that this exposes sensible information about your server setup therefore this option should not be enabled in production.

Known issues

There are some known issues regarding the WordPress module on NixOS