Patching is moving from an earlier version of SMF to the next version in the same series (e.g. from 2.0 to 2.0.1). This process will only work if the part of code inserted by the patching has not already been changed (i.e. no mods have changed it).
A similar procedure to update the forum is Updating.
If you are moving up more than one version in the same series, (e.g. 1.1.10 to 1.1.13) you could repeat patching for each version update. If patching reports errors and/or you have mods installed then you should use the Upgrading procedure. If you want to install a Forum from scratch, please see the instructions on Installing SMF. If you want to convert to SMF from another Forum software, please see the instructions for Converting to SMF.
 |
Please note that patches are usually not provided for development versions of SMF (betas and release candidates (RC). |
Patching an SMF forum is easy! It can be done in three quick and simple steps:
Backup your forum
Before starting the patching process, a backup should be taken. This includes, specifically, the database as it contains all the members, posts and other items in the forum. This protects the forum from accidental damage and any issues from updating. Although extensive testing is always carried out, sometimes unforeseen issues develop. Therefore, having a backup is crucial. The patching tool can backup all your files before it runs, but the database is not backed up and however the best practice is to have a full backup available.
For more details on backing up your forum, please see the page backup.
Backup your files
Using an ftp client access your forum directory and download all the files and directories present in there.
Back up the Database
This is crucial. You MUST backup your database. If you don't, there's no way, at all, that you can revert back to v1.x of your forum, should you not be able to upgrade to v2, for some reason.
It's highly recommended that you backup from your site's CPanel, or equivalent, as the SMF backup doesn't work, with some servers.
Back up a database using SMF
To backup the database from SMF's Admin section, navigate to Forum Maintenance (Administration Center > Maintenance > Forum Maintenance). On the database section, save the data and the structure. Then, compress the file. Select "Download" and wait for the database to complete the download completely. Note: It is recommended if you use this method to verify that the backup is complete by opening the file and checking the last line. If the file is not complete and has an error please try one of the other methods to backup your database.
Back up a database using PHPMyAdmin
PHPMyAdmin gives the option to export a database, from the initial page, select the "Export" option and follow the instructions. Select your SMF database. These are different based on host.
Back up a database using a control panel
If your hosting service provides a control panel interface, this can be used to back up a database. Selecting the "Backups" or "Backups Wizard" options should take you to a page, prompting you to back up your database. With different hosts, these options may have different titles.
Obtaining the patch
Download the patch through the admin panel
When you enter SMF's Administration Center if a patch has been released you will be notified through a box "Update Available!". Selecting the link present in this box SMF will automatically download the patch from the Simple Machines website and will bring you to the package manager.
Download the patch from SMF website
In certain cases is necessary to manually upload the patch to your server before applying it. In these cases the first thing to do is download the patch.
Go to the Upgrades download page on the SMF website and download the patch you need.
Patch names are in the form "SMF v1 to v2" where v1 is the starting version of SMF (i.e. the current version of your forum) and v2 is the version your forum will be after the application of the patch.
You need to download the patch where v1 is the version of your SMF installation.
Once downloaded the patch to your computer, go to: Admin > Main > Package Manager > Download Packages and upload the patch.
Than select the link Install Mod.
In some cases, the upload to Packages may be corrupted when you attempt this. In this case, you can upload the file (Still archived) to your Packages directory, using your FTP client. Then go to Package Manager to apply it.
Finishing the Patching procedure
In the new page you will be notified of any problem. If no errors are reported, selecting the button "Install Now" will start the actual patching procedure.
Once finished you will be informed that the package has been installed successfully.
