Patching: Difference between revisions

Latest revision as of 09:53, 23 April 2022

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). If you are moving up more than one version in the same series, (e.g. 1.1.10 to 1.1.13) you must repeat patching for each version update.

If patching reports errors or if you need to move to a newer major version of SMF then you should use the Upgrading procedure. If you want to install a Forum from scratch, please see the instructions on Installing SMF.

Please note that patches are usually not provided for development versions of SMF (betas and release candidates (RC).

Patching an SMF forum can be done by following these steps:

Back up Your Forum

Before starting the upgrade 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 upgrading. Although extensive testing is always carried out, sometimes unforeseen issues develop. Therefore, having a backup is crucial. The upgrading tool can backup all database tables before it runs, but the files are not backed up and the best practice is to have a full backup available.

For more details on backing up your forum, please see the backup page.

Back up Your Files

Using an ftp client access your forum directory and download all the files and directories present in there.

Obtain 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 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 it 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 downloads page for patches on the SMF website and download the patch you need.
Once you have downloaded the patch to your computer, go to: Administration > Main > Package manager > Download Packages and upload the patch.
Click the link Install Mod.

Finishing The Patching Procedure

On the next page you will be notified of any problems. 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.

Useful FAQ

Installing and Upgrading

@@ Line 1: / Line 1: @@
-{{TOCright}}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 interested by the patching han not been changed (i.e. no mods changed it).
+{{TOCright}}{{:Patch (term)}} If you are moving up more than one version in the same series, (e.g. 1.1.10 to 1.1.13) you must repeat patching for each version update.
-A similar procedure to update the forum is [[Updating]].<br>
-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.
-{{ambox|type=notice
+If patching reports errors or if you need to move to a newer major version of SMF then you should use the [[Upgrading]] procedure.
+If you want to install a Forum from scratch, please see the instructions on [[Installing]] SMF.
+{{ambox|type=notice|small=yes
 |text=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:
+Patching an SMF forum can be done by following these steps:
-{{Back up|patching}}
+==Back up Your Forum==
+Before starting the upgrade 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 upgrading. Although extensive testing is always carried out, sometimes unforeseen issues develop. Therefore, having a backup is crucial. The upgrading tool can backup all database tables before it runs, but the files are not backed up and the best practice is to have a full backup available.
-==Obtaining the patch==
+'''For more details on backing up your forum, please see the [[backup]] page.'''
-===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 [http://www.simplemachines.org Simple Machines] website and will bring you to the [[package manager]].
-===Download the patch from SMF website===
+===Back up Your Files===
-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.
+Using an [[FTP_-_How_do_I_use_FTP|ftp client]] access your forum directory and download all the files and directories present in there.
-Go to the [http://custom.simplemachines.org/upgrades/ Upgrades] download page on the SMF website and download the patch you need.<br />
+==Obtain The Patch==
-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.<br />
+===Download The Patch through The Admin Panel===
-You need to download the patch where ''v1'' is the version of your SMF installation.
+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 will automatically download the patch from the [http://www.simplemachines.org Simple Machines] website and will bring you to the [[package manager]].
-Once downloaded the patch to your computer, go to: ''[[Administration Center|Admin]] > Main > [[Package Manager]] > [[Package Manager#Download Packages|Download Packages]]'' and [[Package Manager#Upload a Package|upload]] the patch.<br />
+===Download The Patch from SMF Website===
-Than select the link '''Install Mod'''.
+In certain cases it 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.
-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.
+*Go to the [http://custom.simplemachines.org/upgrades/ downloads] page for patches on the SMF website and download the patch you need.
+*Once you have downloaded the patch to your computer, go to: ''Administration > Main > Package manager > [[SMF2.0:Package manager#Download Packages|Download Packages]]'' and [[SMF2.0:Package manager#Upload a Package|upload]] the patch.
+*Click the link '''Install Mod'''.
-==Finishing the Patching procedure==
+==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.<br />
+On the next page you will be notified of any problems. 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.
-Once finished you will be informed that the package has been installed successfully.
 {{Upgrade FAQ}}
 {{Installing SMF}}

Navigation

Search

Tools