Packages: Difference between revisions

The Package Manager in an SMF forum allows an administrator to apply modifications to the code without needing to manually edit any of the code. It allows easy, efficient install, update and deletion of modifications and security patches. Accessed from the "Main" section of the Administration Center.

Browse Packages is the landing page of the Package Manager, initially providing an overview of new packages available, and the Simple Machines voted package of the month, both these sections are live from the Simple Machines Community site, failure to load the required information will be displayed in the event www.simplemachines.org cannot be reached.

Packages will be listed in a table in the "Browse Packages" section, any package uploaded to "/Packages" will be displayed in the table. Links will appear beside the packages depending on functions available to those packages. If a package is already installed an "[Uninstall] button will be displayed, similarly if a package can be installed but is not, an [Install] button will be shown, selecting this will guide through an install or uninstall process. A [list Files] button is available for all properly packaged packages, selecting this will display a list of all files included with the package. [Delete] is also available to remove the package and its entry on this page, where possible SMF will remove the files.

"Advanced" is displayed in a small text link at the bottom of the page, selecting this will bring up the version emulation function. This allows an administrator to fake the SMF version, allowing them to test the compatibility of a package with a certain version of SMF. Enter a number and select "Save" to change the configuration. It can be undone at any time by selecting "Revert".

Location

The package manager can be found in the SMF admin panel. Just look for this image. You can also use the admin menu to get to the package manager.

Menu Structure

Main
- Packages

Uploading a Package

To upload a package browse to your package manager. From there go to Download Packages. You can also use the menu at the top of the administration center to get there faster.

Menu Structure

Main
- Packages
  - Download Packages

From there scroll down until you see a area labeled Upload a Package. Click the browse button and browse to the location on you computer you stored the package. After selecting your package press the Upload button.

Installing a Package

If you previously uploaded a package and didn't install it then you can go to the main package page to install it. If you just finished uploading then a option to install the package should appear. In any matter click install for the package you want to install. From there the package might give you some more information about what you are about to install. If all is ok continue the installation, but if you see any errors do not install the package unless you are sure about the errors.

Uninstall a Package

To uninstall a package go to the SMF Package Manager.

Menu Structure

Main
- Packages

From there scroll down until you see the Package you wish to uninstall. Click [Uninstall], from there you should be redirected to a page that will display information about the package uninstall.

At the top if the package has any information associated with it stored in the database you may see this message "Remove all data associated with this modification.". Check the check box if you wish to remove any information associated with the package in the database. If you do not plan on installing this package again then it is a good idea to check this box to remove unused information from the database.

Scrolling down you should see a list telling you if the operation will execute successfully. If there are any errors do not continue the uninstall unless you know what you are doing. If there are not any errors then continue by pressing the "Uninstall Now" button at the bottom of the list.

Deleting a Package

Deleting a package is as easy as browsing on over to the SMF Package Manager.

Menu Structure

Main
- Packages

From there scroll down the list until you see the package you wish to delete and inspect. If the package says uninstall beside it then there is a good chance that package is still installed. You may want to uninstall this package before deleting it, if you do not uninstall the package first the changes the package made to SMF will still be present after deleting.

Will now you need to delete the package, it is as easy as pressing the [Delete] link in the package list beside the package. Template:Package Manager

As an administrator

Main

Configuration

Forum

Members

Maintenance

Miscellaneous

@@ Line 7: / Line 7: @@
 "Advanced" is displayed in a small text link at the bottom of the page, selecting this will bring up the version emulation function. This allows an administrator to fake the SMF version, allowing them to test the compatibility of a package with a certain version of SMF. Enter a number and select "Save" to change the configuration. It can be undone at any time by selecting "Revert".
 == Location ==
- [[Image:Smf_package_link.png]]
+[[Image:Smf_package_link.png]]
 The package manager can be found in the SMF admin panel. Just look for this image. You can also use the admin menu to get to the package manager.

Navigation

Search

Tools