Before you can start using WordPatch, you need to configure it. WordPatch relies on having database and filesystem access in order to be able to reliably apply modifications to your files.

1. Navigate to the WordPatch dashboard from the WordPress admin panel sidebar. If you are asked to login, simply use your WordPress admin user credentials. This is a security feature of WordPatch and you can find out more about why it happens here.

2. Once you’re in the WordPatch dashboard, press the Get Started Now button in the WordPatch Quick Start panel.

Configuring the Database

The first thing you will need to configure is database access. Most of the configuration options will be automatically filled out for you, but you will need to enter your database user password. Make sure that the settings here match your WordPress installation. For more details on the various configuration options, refer to this article.

1. After you’ve made sure everything is correctly filled in, press Next to let WordPatch validate your settings. If everything worked, you will be prompted to confirm your selections and continue to the next wizard.

Configuring the Filesystem

Similarly to configuring the database, most fields will be automatically filled in. WordPatch provides several different mechanisms to access the filesystem. Which method is best for you depends on your configuration, hosting environment, and security needs. For the purposes of this tutorial, we’ll assume that the default (Direct Filesystem Access) method is configured correctly. If you need more in-depth information on the available filesystem access methods and how to configure them, refer to this article.

1.  After you review the configuration settings, press Next. 

Generating the Rescue Script

The Rescue Script is an important piece when it comes to the way WordPatch works, and it also serves as a secure environment that you can use to manage your installation. For more information on what the Rescue System is and what it does, refer to this article.

In this wizard, you are only able to configure the path of the rescue script. For most shared hosts (or otherwise restricted environments), it is important that the rescue script is publicly accessible (for example, from a web browser across the internet). For more information, read The WordPatch Update Process.

1. Press Next to generate your rescue script.

2. Review the generated rescue script contents and then click Next.

Activating WordPatch

In order to use WordPatch, you need a valid and active license and an activation key. If you don’t already have a license, you can purchase a subscription from the JointByte store (there’s also a limited-time 1-month free trial). You can find your activation key by logging into the JointByte store and then navigating to My Account -> My Subscription. For more information on how to manage your WordPatch license, refer to this article.

1. Enter your activation key and press Next to activate WordPatch.

2. If the license was activated successfully, you will see this confirmation page.

Configuring the Mailer

The last step before being able to use WordPatch is configuring the mailer, which allows WordPatch to notify you after mods have finished running.

1. Click the Select Mailer dropdown and select the mailer you wish to use. Among the various standard options (e.g., SMTP and PHP's built-in mail function), we also offer our own JointByte mailer, a mailer service we offer for free to all our subscribers. For more information on the various options, refer to this article.

2. Enter the To Address. This is the recipient e-mail address that will be receiving notifications and alerts about WordPatch mods and other critical emails.

3. After you are finished configuring your mailer settings, click Next to validate your settings. 

3. After WordPatch has verified that everything works correctly, WordPatch is now ready to use.

Now it’s time to start using WordPatch by creating your first mod.