Patching: Difference between revisions From Online Manual

Jump to: navigation, search
mNo edit summary
No edit summary
Line 2: Line 2:


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 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. If you want to convert to SMF from another Forum software, please see the instructions for [[Converting]] to SMF.
If you want to install a Forum from scratch, please see the instructions on [[Installing]] SMF.


{{ambox|type=notice
{{ambox|type=notice
Line 10: Line 10:


==Back up Your Forum==
==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.
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 page [[backup]].'''
'''For more details on backing up your forum, please see the [[backup]] page.'''


===Back up Your Files===
===Back up Your Files===
Line 20: Line 20:
===Download the patch through the admin panel===
===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!'''".
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]].
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]].


===Download the patch from SMF website===
===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.
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 [http://custom.simplemachines.org/upgrades/ Upgrades] download page on the SMF website and download the patch you need.<br />
Go to the [http://custom.simplemachines.org/upgrades/ Upgrades] download page on the SMF website and download the patch you need.<br />
Line 29: Line 29:
You need to download the patch where ''v1'' is the version of your SMF installation.
You need to download the patch where ''v1'' is the version of your SMF installation.


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 />
Once downloaded the patch to your computer, go to: ''Administration > Main > Package manager > [[Package manager#Download Packages|Download Packages]]'' and [[Package manager#Upload a Package|upload]] the patch.<br />
Than select the link '''Install Mod'''.
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.
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. Once you have done this, you need to go to Package Manager to apply it.


==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 />
In the new page you will be notified of any problems. If no errors are reported, selecting the button "Install Now" will start the actual patching procedure.<br />
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.



Revision as of 10:41, 4 January 2015

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 could 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.

Patching an SMF forum can be done in three quick and simple 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 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: Administration > Main > Package manager > Download Packages and upload the patch.
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. Once you have done this, you need to go to Package Manager to apply it.

Finishing the Patching procedure

In the new 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



Advertisement: