readme: proofread 503 functionality section

This commit is contained in:
Asif Bacchus 2018-10-22 00:27:02 -06:00
parent c1e369c2c8
commit 6b60020411

View File

@ -349,7 +349,7 @@ ## 503 functionality
This script includes an entire section dedicated to copying an html file to act This script includes an entire section dedicated to copying an html file to act
as an error 503 notification page. Error 503 is by definition "service as an error 503 notification page. Error 503 is by definition "service
temporarily unavailable" which is exactly the case for your Mailcow server temporarily unavailable" which is exactly the case for your Mailcow server
during a backup since it is in maintenance mode and no logins are permitted. during a backup since the mail-flow containers have been disabled.
The script copies whatever file is defined by the *'-5'* parameter (or the The script copies whatever file is defined by the *'-5'* parameter (or the
default located at *'scriptpath/503.html'*) to whatever path is defined as the default located at *'scriptpath/503.html'*) to whatever path is defined as the
@ -377,7 +377,7 @@ #### NGINX
return 503; return 503;
} }
... ...
error_page 530 @backup error_page 503 @backup
location @backup { location @backup {
root /usr/share/nginx/html; root /usr/share/nginx/html;
rewrite ^(.*)$ /503.html break; rewrite ^(.*)$ /503.html break;
@ -387,10 +387,10 @@ #### NGINX
This tells NGINX that if it finds the file *'503.html'* at the path This tells NGINX that if it finds the file *'503.html'* at the path
*'/usr/share/nginx/html'* (webroot on reverse proxy) then return an error code *'/usr/share/nginx/html'* (webroot on reverse proxy) then return an error code
503. Next, rewrite any url to *'domain.tld/503.html'* and thus, display the 503. Upon encountering a 503 error, rewrite any url to *'domain.tld/503.html'*
custom 503 error page. On the other hand, if it can't find 503.html at the path and thus, display the custom 503 error page. On the other hand, if it can't
specified (i.e. the script has deleted it because the backup is completed), then find 503.html at the path specified (i.e. the script has deleted it because the
go about business as usual. backup is completed), then go about business as usual.
#### Apache #### Apache