Table of Contents

• Table of Contents
• wp-shelltools
• Donate
• Install
  • Requirements
  • 1 - Clone Repository
  • 2 - Add to PATH
  • 3 - Run the script
• Help
• Directories
• Advanced Documentation
• Debugging
• Future Features
• ToDo
• Resources

wp-shelltools

The goal of this project is to make it easy to manage and maintain WordPress servers using shell scripting. This repository was original named gp-tools, but decided to make it provider agnostic

You might find that there are still tools and functions that have gridpane or gp in their name. This will change when it becomes a priority.

Donate

If you like any of the scripts or tools, please consider donating to help support the development of these tools.

Install

Requirements

• You need root, otherwise this makes no sense.
• You need git (apt-get install git)

1 - Clone Repository

You want to clone the repository somewhere on your server or local machine. I recommend using your home directory under /bin as typical shells such as bash and zsh will look for executables in this directory.

git clone https://github.com/managingwp/wp-shelltools $HOME/bin/wp-shelltools

2 - Add to PATH

If you're not installing it in a location that your shell looks for executables, you will need to add the path you chose to your PATH variable. You can do this by adding the following line to your ~/.bashrc or ~/.zshrc file etc.

export PATH=$PATH:$HOME/bin/wp-shelltools

3 - Run the script

You can run the script by typing wpst.sh or wpst in your terminal.

wpst.sh

Help

Simply run the following command to get a list of available tools

wp-shelltools help

Here's a list of all commands

-- Loading wp-shelltools - v0.0.1

wp-shelltools help
-----------------------------------
  help goaccess        - Process GridPane logs with goaccess
  help backups         - List backups for all sites on the server.
  help plugins         - Lists WordPress plugins on all websites on a GridPane Server
  help logcode         - Look for specifc HTTP codes in web server logfiles and return top hits.
  help gpcron          - List sites using GP Cron
  help mysqlmem        - GridPane monit memory calculation
  help logs            - tail or show last lines on all GridPane logs.

Examples:
 --
  wp-shelltools goaccess
  wp-shelltools log

Directories

• dawn-mover - GridPane's prime-mover recoded but broken, it's a mess.
• docs - Advanced documentation.
• tests - any test data.
• unfinished - code that is untested or needs to be moved into core.

Advanced Documentation

Below is help for the advanced tools.

• wpst-goaccess
• gp-api
• gp-plugins
• attackscan.sh
• dawn-mover

Debugging

Add a .debug file to any directory to get debug information.

Future Features

• Check Log Sizes - debug.log is a culprit in disk usage. Find all occurances and print out size.
• MySQL Database Checks - Check for anomiles, myisam, large table sizes, large databases.
• MySQL Database Report - Largest Databases + more.
• CLI to API - A CLI to the GridPane API.

ToDo

• Go through unfinished directory code.
• Better documentation
• Place some scripts into functions or separate files not inside root for a cleaner directory structure and code management.
• goaccess: Add filtering for 403 forbidden as they're blocked and not resource intensive

Resources

• Managing WP - WordPress Articles and more!
• Managing WordPress - Created and managed by me.
• Managing WordPress Discord - Come and chat about WordPress