Readme and Configuration Updates

Changes to reflect new names for install, setup and update script.
Happy Easter 🐰
This commit is contained in:
Mitchell Krog 2017-04-16 11:29:55 +02:00
parent ec94393e27
commit c31997d4f6
6 changed files with 90 additions and 18 deletions

View file

@ -1,5 +1,12 @@
# CHANGELOG - Nginx Bad Bot Blocker
### 2017-04-16
- Happy Easter !!! :rabbit:
- New setup-ngxblocker script contributed by Stuart Cardall @itoffshore. The script will try to insert the new configuration below any existing includes in your config files. If the search string is not found the inserts are made at the end of the start search range. Thank you @itoffshore for this contribution.
- installnginxblocker.sh renamed to install-ngxblocker for consistency
- updatenginxblocker.sh renamed to update-ngxblocker for consistency
- Readme and Configuration File Updates
### 2017-04-11
- Introduced Repo Email Notification Mailing List
- Please subscribe your email address to the mailing list at **https://groups.google.com/forum/#!forum/nginx-ultimate-bad-bot-blocker**

View file

@ -15,11 +15,37 @@ Please make sure you are subscribed to notifications to be notified when the blo
**If you miss one step you will get an nginx EMERG error. This is normally a result of not downloading either blockbots.conf, ddos.conf, whitelist-ips.conf, whitelist-domains.conf or blacklist-user-agents.conf into your /etc/nginx/bots.d folder. If any of the include files are missing Nginx will EMERG and will not reload.**
#### AUTO INSTALLATION INSTRUCTIONS
## AUTO INSTALLATION INSTRUCTIONS
To Make Sure you copy all the correct files you can now use a simple bash setup script for copying the files into the correct nginx folders for you:
See: https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/installnginxblocker.sh
**Please Note:** the bash installer script does not carry out STEP 7 of the manual configuration instructions for you. YOU MUST edit any vhosts files yourself and manually add the entries in STEP 7 or the blocker will not actually be protecting any sites.
See: https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/install-ngxblocker
See: https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker
These two shell scripts will
A) (install-ngxblocker) download all the required files to the correct folders.
B) (setup-ngxblocker) will try to insert the new configuration below any existing includes in your config files
To use these scripts download them to your /usr/sbin directory as follows
`cd /usr/sbin`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/install-ngxblocker -O install-ngxblocker`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker -O setup-ngxblocker`
make both files executable
`sudo chmod +x install-ngxblocker`
`sudo chmod +x setup-ngxblocker`
Run the install script first
`sudo ./install-ngxblocker`
Then run the setup script
`sudo ./setup-ngxblocker`
## MANUAL INSTALLATION INSTRUCTIONS
@ -183,7 +209,7 @@ Updating to the latest version is now as simple as:
`cd /etc/nginx/conf.d`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/conf.d/globalblacklist.conf`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/conf.d/globalblacklist.conf -O globalblacklist.conf`
`sudo nginx -t`
@ -195,7 +221,7 @@ And you will be up to date with all your whitelisted domains included automatica
See the latest auto updater bash script at:
https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/updatenginxblocker.sh
https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/update-ngxblocker
With great thanks to Stuart Cardall (https://github.com/itoffshore) for improving on it to be truly universal to other distro's.

View file

@ -125,9 +125,35 @@ For bot's or spiders that you still want to allow but want to limit their visita
## AUTO INSTALLATION INSTRUCTIONS
To Make Sure you copy all the correct files you can now use a simple bash setup script for copying the files into the correct nginx folders for you:
See: https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/installnginxblocker.sh
**Please Note:** the bash installer script does not carry out STEP 7 of the manual configuration instructions for you. YOU MUST edit any vhosts files yourself and manually add the entries in STEP 7 or the blocker will not actually be protecting any sites.
See: https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/install-ngxblocker
See: https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker
These two shell scripts will
A) (install-ngxblocker) download all the required files to the correct folders.
B) (setup-ngxblocker) will try to insert the new configuration below any existing includes in your config files
To use these scripts download them to your /usr/sbin directory as follows
`cd /usr/sbin`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/install-ngxblocker -O install-ngxblocker`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker -O setup-ngxblocker`
make both files executable
`sudo chmod +x install-ngxblocker`
`sudo chmod +x setup-ngxblocker`
Run the install script first
`sudo ./install-ngxblocker`
Then run the setup script
`sudo ./setup-ngxblocker`
## MANUAL INSTALLATION INSTRUCTIONS
@ -291,7 +317,7 @@ Updating to the latest version is now as simple as:
`cd /etc/nginx/conf.d`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/conf.d/globalblacklist.conf`
`sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/conf.d/globalblacklist.conf -O globalblacklist.conf`
`sudo nginx -t`
@ -301,9 +327,11 @@ And you will be up to date with all your whitelisted domains included automatica
# AUTO UPDATING:
See my latest auto updater bash script at:
See the latest auto updater bash script at:
https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/updatenginxblocker.sh
https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/update-ngxblocker
With great thanks to Stuart Cardall (https://github.com/itoffshore) for improving on it to be truly universal to other distro's.
Relax now and sleep better at night knowing your site is telling all those baddies they are FORBIDDEN !!!

View file

@ -9,14 +9,19 @@
# Use this script only once and thereafter use the Auto Update Bash Script updatenginxblocker.sh
# THIS INSTALL SCRIPT **ONLY** COPIES THE NECESSARY FILES FOR NGINX DIRECT FROM THE REPO
# THIS INSTALL SCRIPT ONLY COPIES THE NECESSARY FILES FOR NGINX DIRECT FROM THE REPO
### The installer script does not carry out STEP 6 of the configuration instructions for you.
### You must manually edit any vhost files with the includes in STEP 6 or it will not actually be protecting any sites.
### READ: https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/blob/master/CONFIGURATION.md
# Save this file as /bin/installnginxblocker.sh
# Make it Executable chmod +x /bin/installnginxblocker.sh
# Run it from the command line using sudo /bin/installnginxblocker.sh
### You can now use a setup script contributed by Stuart Cardall to automatically do all the includes for you
### See - https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker
# Save this file as /usr/sbin/install-ngxblocker
# sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/install-ngxblocker -O install-ngxblocker
# Make it Executable chmod +x /usr/sbin/install-ngxblocker
# Run it from the command line using sudo /bin/install-ngxblocker
# LETS INSTALL NOW
@ -33,4 +38,8 @@ sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bo
exit 0
# PLEASE READ CONFIGURATION INSTRUCTIONS
# https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/blob/master/CONFIGURATION.md
# https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/blob/master/CONFIGURATION.md
# PLEASE SEE SETUP SCRIPT TO DO THE NECESSARY INCLUDES FOR YOU
### You can now use a setup script contributed by Stuart Cardall to automatically do all the includes for you
### See - https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker

View file

@ -12,8 +12,10 @@
# PLEASE READ UPDATED CONFIGURATION INSTRUCTIONS BEFORE USING THIS
# Save this file as /usr/sbin/updatenginxblocker
# Make it Executable chmod 700 /usr/sbin/updatenginxblocker
# Save this file as /usr/sbin/update-ngxblocker
# cd /usr/sbin
# sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/update-ngxblocker -O update-ngxblocker
# Make it Executable chmod 700 /usr/sbin/update-ngxblocker
# RUN THE UPDATE
# Here our script runs, pulls the latest update, reloads nginx and emails you a notification
@ -81,4 +83,4 @@ exit $?
# Add this as a cron to run daily / weekly as you like
# Here's a sample CRON entry to update every day at 10pm
# 00 22 * * * /usr/sbin/updatenginxblocker
# 00 22 * * * /usr/sbin/update-ngxblocker