How to Install, Update or Remove an Extension

My little contributions to the phpBB 3.1.x and 3.2.x world. Please read the note on Version Numbering to ensure you download the correct Extension version.
Administrator
Site Admin
Posts: 254
Joined: Tue Nov 18, 2014 11:30 am

How to Install, Update or Remove an Extension

Post by Administrator » Fri Mar 25, 2016 11:54 am

Installing an Extension


Inside your phpBB board's directory is an "ext" folder. This is the location where all extensions are stored. Every extension follows the same folder hierarchy in which extensions are grouped into folders by the author's vendor name. If you downloaded my extension named "googlesearch" then it would be uploaded to "ext/hifikabin/googlesearch". Any other extensions created by me would also be stored in "ext/hifikabin/". For example:
  • phpBB/
    • ext/
      • hifikabin/
        • googlesearch
        • obscurecontactus
      • phpbb/
        • boardannouncements
        • boardrules
1. Download and unzip
  • Once you have downloaded an extension, you will need to unpackage it on your computer, as extensions are typically available in the compressed "zip" file format.

    In Windows, to unzip the extension, simply double click it from Windows Explorer view (for instance, if you downloaded the extension to My Documents, you would open My Documents and double click the file). Proceed to click "Extract all files" under the address bar (Windows Vista, 7 and 8) or under the Folder Tasks menu (Windows XP) from within the Explorer window and follow the prompts.

    On Mac, zipped files are automatically unzipped upon download by Safari (this setting can be disabled by unticking "Open safe files" in Safari's preferences) and can be accessed through the downloads list.
2. Upload to your board
  • To upload files, open your favourite FTP client (such as FileZilla, CuteFTP, SmartFTP, etc - even some internet web browsers have this capability) and log in to your account. Generally your publicly accessible files will be in an area named "public_html" or similar. Navigate to your board folder. In this example we will look at transferring the "hifikabin/googlesearch" extension. You would need to navigate to the "ext/" directory once you are in your board folder.

    Drag the folder "hifikabin/googlesearch" to the "ext" folder in your FTP client. Normally there will be a small folder icon within the FTP client (this may vary from client to client) followed by the name of the directory - this is where you should be dragging the file to. If there is already an "hifikabin" folder inside your "ext" folder, then just copy the "googlesearch" folder to "ext/hifikabin/".
3. Enable
  • Once the extension has been uploaded, navigate in the board's ACP to Customise -> Manage extensions. You should see your recently uploaded extension listed under "Disabled Extensions". Simply click its "Enable" button and installation is complete!
Updating an Extension


Updating an extension is a simple process that can be completed in a few simple steps with minimal disruption to your board. The following steps assume you have already downloaded and un-zipped a new version of an existing extension running on your board.

1. Disable
  • Disabling an extension will effectively turn it off, removing it from your board. If the extension is critical to your board's functionality, it would be safest to disable your board before performing this update process.
2. Delete extension files
  • Using your FTP program delete the extension's files from the filesystem. In most cases you can simply delete the extension's entire directory, which will remove all of its files from your filesystem.
3. Upload new extension files
  • Using your FTP program upload the new extension files (or the entire extension directory) to the correct location.
4. Enable
  • Once the extension has been uploaded, navigate in the board's ACP to Customise -> Manage extensions. You should see your recently uploaded extension listed under "Disabled Extensions". Simply click its "Enable" button and the update is complete!
Removing an Extension


Sometimes it is necessary to remove an extension. phpBB allows you to disable an extension and to permanently delete it from your board.

1. Disable
  • Disabling an extension will effectively turn it off, removing it from your board. However, all modifications made to your database are still intact, so you can re-enable the extension without losing any of its stored settings and data. To disable an extension, simply click its "Disable" button in the Extensions Management page.
2. Delete data
  • To delete the extension, click the "Delete Data" button in the Extensions Management page after the extension has already been disabled. This is a destructive move that will delete any settings and data used by the extension from the database. (If you re-enable the extension at this point, it will be as if it were being installed for the first time.) Once you have deleted the data you can safely use your FTP program to delete the extension's folder from the "ext" directory.