2
0
Fork 0
mirror of https://github.com/tmiland/Nginx-Maintenance-Mode synced 2024-04-24 19:05:25 +02:00
Easily toggle on or off maintenance mode with nginx
Go to file
Tommy Miland dfdfff915f
Update README.md
2022-05-08 09:48:45 +00:00
img Update maintenance.png 2019-04-03 07:45:00 +02:00
.gitattributes Initial commit 2019-03-28 17:36:38 +01:00
CNAME Create CNAME 2019-04-02 12:40:20 +00:00
LICENSE Initial commit 2019-03-28 17:36:38 +01:00
README.md Update README.md 2022-05-08 09:48:45 +00:00
_config.yml Set theme jekyll-theme-slate 2019-04-02 12:34:49 +00:00
error_pages.conf Added Bonus 2019-04-02 16:27:45 +02:00
error_pages_content.conf Added Bonus 2019-04-02 16:27:45 +02:00
maintenance-page.conf Create maintenance-page.conf 2019-03-28 19:53:28 +01:00
maintenance.sh Update maintenance.sh 2021-01-28 14:54:07 +00:00

Nginx Maintenance Mode

           _   __      _
          / | / /___ _(_)___  _  __
         /  |/ / __ `/ / __ \| |/_/
        / /|  / /_/ / / / / />  <
       /_/ |_/\__, /_/_/ /_/_/|_|
    	      /____/
    __  ___      _       __
   /  |/  /___ _(_)___  / /____  ____  ____ _____  ________
  / /|_/ / __ `/ / __ \/ __/ _ \/ __ \/ __ `/ __ \/ ___/ _ \
 / /  / / /_/ / / / / / /_/  __/ / / / /_/ / / / / /__/  __/
/_/  /_/\__,_/_/_/ /_/\__/\___/_/ /_/\__,_/_/ /_/\___/\___/

GitHub release licence Bash

Easily toggle on or off maintenance mode with nginx

Screenshots

screenshot

Installation

Download and execute the script:

$ git clone https://github.com/tmiland/Nginx-Maintenance-Mode.git
$ cd Nginx-Maintenance-Mode
$ cp -rp ./maintenance-page.conf /etc/nginx/snippets/
$ git clone https://github.com/tmiland/server-error-pages.git /etc/nginx/html/server-error-pages
$ cp -rp /etc/nginx/html/server-error-pages/_site/maintenance-page.html /etc/nginx/html/server-error-pages/_site/maintenance-page_off.html
$ chmod +x maintenance.sh

Add to server directive

server {

## Nginx Maintenance Mode
include snippets/maintenance-page.conf;

}

Optionally

$ ln -s /path/to/Nginx-Maintenance-Mode/maintenance.sh /usr/bin/maintenance

Check for errors

$ nginx -t 
  • Add to each virtual server in /etc/nginx/sites-available you want to enable maintenance mode on.
  • Else, add to nginx.conf.

Usage

$ ./maintenance.sh [hostname] [on/off]

Optionally

$ maintenance [hostname] [on/off]

*** Note: [hostname] must match the hostname in your.hostname.com.conf/nginx.conf ***

server {
	server_name your.hostname.com;
  }
  • When maintenance mode is toggled on, maintenance-page_off.html will be copied to $server_name-maintenance-page_on.html. E.g: your.hostname.com-maintenance-page_on.html
  • This way you can use this with multiple virtual servers, and easily toggle on/off maintenance mode individiually for each site.
  • Toggle off, deletes $server_name-maintenance-page_on.html

Advanced usage

$ ./maintenance.sh my.hostname.com on
$ ./maintenance.sh my-other.hostname.com on
$ ./maintenance.sh hostname.com on
$ ./maintenance.sh my.hostname.com off
$ ./maintenance.sh my-other.hostname.com off
$ ./maintenance.sh hostname.com off

Logic in maintenance-page.conf


if (-f /etc/nginx/html/server-error-pages/_site/$server_name-maintenance-page_on.html)
{
  return 503;
}
error_page 503 @maintenance;
location @maintenance
{
  rewrite ^(.*)$ /$server_name-maintenance-page_on.html break;
  root /etc/nginx/html/server-error-pages/_site;
}

  • If your.hostname.com-maintenance-page_on.html exists, error 503 is returned.
  • If not, operation is back to normal.

Added Bonus

Add support for custom error pages

*** This will add the error pages included in the repo ***

$ cp -rp ./error_pages.conf /etc/nginx/snippets/
$ cp -rp ./error_pages_content.conf /etc/nginx/snippets/

Add to server directive

*** Final configuration should look like this: ***

server {

## Nginx Maintenance Mode
include snippets/maintenance-page.conf;
## Custom Error Pages
include snippets/error_pages.conf;

}

Scheduled maintenance

Example shell script:

Name the script, someting like: pg_backup_cron.sh

#!/usr/bin/env bash

# Turn on maintenance mode
/path/to/Nginx-Maintenance-Mode/maintenance.sh hostname.com on
# Run database backups
/path/to/pgbackup/pg_backup.sh
# Turn off maintenance mode
/path/to/Nginx-Maintenance-Mode/maintenance.sh hostname.com off
exit 0

Add job to cron:

$ crontab -e
@daily bash /path/to/pgbackup/pg_backup_cron.sh > /dev/null 2>&1 #Automated PostgreSQL Backup on Linux

Used in this example: pgbackup - Automated PostgreSQL Backup on Linux

Why maintenance mode is important

  • Helps your SEO rankings

As recommended by Google, Maintenace Mode is using the 503 service unavailable result code, which tells search engine crawlers that the downtime is temporary.

Credits

Donations

Buy Me A Coffee

  • PayPal me
  • [BTC] : 33mjmoPxqfXnWNsvy8gvMZrrcG3gEa3YDM

Web Hosting

Sign up for web hosting using this link, and receive $100 in credit over 60 days.

DigitalOcean

Disclaimer

*** Use at own risk ***

License

MIT License Image

MIT License