Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pothi/wordpress-nginx

WordPress specific Nginx configuration templates and best practices!
https://github.com/pothi/wordpress-nginx

centos debian nginx ubuntu wordpress wordpress-nginx

Last synced: 10 days ago
JSON representation

WordPress specific Nginx configuration templates and best practices!

Awesome Lists containing this project

README 

        
# WordPress Nginx Configuration Templates



WordPress specific Nginx configurations, tweaks, and much more!



## Features



There are multiplpe advantages of using this repo as your go-to nginx configuration.



+ Correct use of `if` statement because [ifisevil](https://www.nginx.com/resources/wiki/start/topics/depth/ifisevil/).

+ SSL / LetsEncrypt / Certbot compatible.

+ Multisite support.

+ Contains ready-to-use [sample vhost entries](https://github.com/pothi/wordpress-nginx/tree/main/sites-available).

+ Continuously updated sample configurations with best practices.

+ IPv6 is supported out of the box.

+ Cloudflare support.

+ [WebP](https://developers.google.com/speed/webp/) support.



## Available templates / vhost entries



+ WP Super Cache plugin (with support for SSL and separate mobile cache)

+ WP Rocket cache plugin (SSL and / or mobile supported out of the box)

+ WP Fastest Cache plugin (SSL and / or mobile supported out of the box)

+ Multisite (sub-domain and sub-directory)

+ Varnish with Nginx for SSL termination.

+ Custom error pages.

+ [Catchall template](https://github.com/pothi/wordpress-nginx/blob/main/sites-available/catchall.conf).



## Performance



+ All static content have maximum expiration headers.

+ SSL session cache is enabled by default.

+ Brotli compression support.

+ Open file cache support.

+ Server-level 301 support (for http => https, non-www => www, etc).

+ [Autoptimize](https://wordpress.org/plugins/autoptimize/) support.



## Security



+ Support for [strong dhparam](https://weakdh.org/).

+ TLSv1 and other insecure protocols are disabled by default.

+ Mitigate [httpoxy](https://httpoxy.org/) vulnerability.

+ [HSTS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security) support.

+ Security headers to fit most sites (no CSP, though, as it varies depending on the site).

+ All hidden and backup files are forbidden by default.

+ Passes most security features in [Sonar Scanner](https://sonarwhal.com/scanner/).

+ Gets 'A+' grade in [Qualys SSL Labs](https://www.ssllabs.com/ssltest/).



## Compatibility



Tested with the following servers...



+ Debian 12 (Bookworm)

+ Debian 11 (Bullseye)

+ Debian 10 (Buster)

+ Debian 9 (Stretch)

+ Ubuntu 22.04 LTS (Jammy Jellyfish)

+ Ubuntu 20.04 LTS (Focal Fossa)

+ Ubuntu 18.04 LTS (Bionic Beaver)

+ Ubuntu 16.04 LTS (Xenial Xerus)



Tested with the following Nginx versions...

+ Stable verisons 1.12.x, 1.14.x, , 1.18.x, 1.20.x

+ Mainline versions 1.13.x, 1.15.x, 1.19.x



For RPM based distros (Fedora, Redhat, CentOS and Amazon Linux AMI), the configuration mentioned in the repo is likely to work. Additional steps may be needed, though. See below for some details!



### Changes on CentOS (and on rpm based distros in general)



CentOS has a different file naming convention, yet simple directory structure, when compared to Debian derivatives. Let me describe them and I'd let you decide upon how you'd want to structure your files and name those files.



+ The configuration for default sites are named as `default.conf` and `ssl.conf` in `/etc/nginx/conf.d/`.

+ There is no `sites-available` or `sites-enabled` folder.

+ The file `/etc/nginx/fastcgi_params` in Debian is named as `/etc/nginx/fastcgi.conf` in CentOS.



## How to Deploy



*Short answer*: Use [WordPress in a box](https://github.com/pothi/wp-in-a-box). It sets up your server with all the goodies, including this repo!



*Long answer*:



Note: For all the steps mentioned below, __sudo__ or __root__ privilege is required!



Step #1 - Install Nginx



You may use [the official Nginx repo](https://nginx.org/en/linux_packages.html) or just use the Nginx package that comes with the OS. Both would work fine! I will leave the decision to you. Since, the installation process varies across Operating Systems, please refer the official installation guide to complete this step.



If you prefer to use the Nginx packages that comes with the OS, you may need to run the following...



`sudo apt install nginx`



or



`sudo yum install nginx`



Step #2 - Please backup your existing configuration files. Probably, have `/etc` under version control!



```bash

TIMESTAMP=$(date +%F_%H-%M-%S)

mkdir ~/nginx-backup-$TIMESTAMP

sudo cp -a /etc/nginx ~/nginx-backup-$TIMESTAMP

```



Step #3 - Copy this repo to your server.



```bash

git clone https://github.com/pothi/wordpress-nginx.git ~/git/wordpress-nginx

sudo cp -a ~/git/wordpress-nginx/* /etc/nginx/

sudo mkdir /etc/nginx/sites-enabled &> /dev/null

sudo cp /etc/nginx/nginx.conf /etc/nginx/

```

Further steps varies depending on your particular requirement:



+ you may edit /etc/nginx/conf.d/lb.conf and update the upstream block for 'fpm' (one-off process; done automatically if you use [WordPress in a LEMP Box](https://github.com/pothi/wp-in-a-box))

+ then you may do the following for each vhost (domain), depending on your environment...



```bash

WP_DOMAIN=example.com

WP_ROOT=/path/to/wordpress/for/example.com

sudo cp /etc/nginx/sites-available/example.com.conf /etc/nginx/sites-available/$WP_DOMAIN.conf

sudo sed -i 's:/home/username/sites/example.com/public:'$WP_ROOT':gp' /etc/nginx/sites-available/$WP_DOMAIN.conf

sudo sed -i 's/example.com/'$WP_DOMAIN'/g' /etc/nginx/sites-available/$WP_DOMAIN.conf

cd /etc/nginx/sites-enabled/

sudo ln -s ../sites-available/$WP_DOMAIN.conf

sudo nginx -t && sudo systemctl restart nginx

```



### About me



+ I specialize in hosting (high-traffic) WordPress / PHP sites.

+ I'm one of the top contributors for the tag [Nginx in ServerFault](https://serverfault.com/users/102173/pothi-kalimuthu?tab=profile).

+ Have released couple of WordPress Plugins, one of them is specifically for high performance WordPress sites... [https://profiles.wordpress.org/pothi#content-plugins](https://profiles.wordpress.org/pothi#content-plugins).

+ Have two _active_ blogs... [Tiny WordPress Insights](https://www.tinywp.in/) and [Tiny Web Performance Insights](https://www.tinywp.com/).



### Can you implement it on my server?



Yes. I offer paid support and can implement it on your server. Minimum fee is USD50. Please [contact me](mailto:[email protected]) for any queries in this regard.



### Have questions or just wanted to say hi?



Please ping me on [Twitter](https://twitter.com/pothi]) or [send me a message](https://www.tinywp.in/contact/).



If you find this repo useful, please spread the word! Suggestions, discussion on best practices, bug reports, future requests, forks are always welcome!