Gallery3:User guide:Modules:Installing and upgrading - Gallery Codex
Personal tools

Gallery3:User guide:Modules:Installing and upgrading

From Gallery Codex

Previous chapter: What are modules? Back to the user guide main page Next chapter: Configuring modules


Installing and upgrading modules

Where can I find modules?

Most modules can be found on gallerymodules.com (many thanks to dmolavi for setting up this page) or on the codex page Gallery 3 Modules.

How to install a module

Every module has it's own folder in the "gallery3/modules" folder. Installing is as easy as uploading the module folder and activating the module

  1. Download the module(s) you want to add to your Gallery 3 installation.
  2. Extract the compressed archive and upload the module folder (e.g. "mymodule") to the "modules" folder in your Gallery 3 installation folder. If you are looking at your file manager or ftp client, you end up with something that looks like:
    "gallery3/modules/mymodule/module.info"
    It should not look like: "gallery3/modules/mymodule/mymodule/module.info" or "gallery3/modules/mymodule.zip"
  3. Browse to your Gallery 3 page and go to "Login -> Admin -> Modules"
  4. Select all modules you want to install / activate and click on "Update" at the bottom of the page

Important: It is recommended to install modules one by one so that one of the modules breaks your installation you will know which one it is. In case this has happened to you please scroll down to "Troubleshooting modules" on this page.

How to update modules

  1. Download the updated version of the module
  2. Go to "Login -> Admin -> Maintenance" and click on "Turn on maintenance mode"
  3. Rename the old module folder of your Gallery 3 installation folder (e.g. to "mymoduleold")
  4. Extract the compressed archive and upload the module folder to the "modules" folder of your Gallery 3 installation folder
  5. Delete the old folder (in our example "mymoduleold")
  6. Browse to your Gallery 3 page and add "/upgrader" to the site URL (e.g. http://www.example.com/gallery3/index.php/upgrader)
  7. Follow the instructions on the screen
  8. Browse to your Gallery 3 page to see if everything is working
  9. Go to "Login -> Admin -> Maintenance" and click on "Turn off maintenance mode"



How to uninstall modules

  1. Browse to your Gallery 3 page and go to "Login -> Admin -> Modules"
  2. De-select all modules you want to uninstall and click "Update" at the bottom of the page
  3. Delete the module folder from the "modules" folder of your Gallery 3 installation. Do not delete the whole modules folder but only the folder of the module you want to uninstall



Troubleshooting

Most modules are written by members of the Gallery 3 community on a best effort basis and without charging anyone anything for the development, maintenance and support of the modules. Please keep this in mind when you have problems with a module.

If you have problems with any module please go to the codex page of the module (Gallery 3 Modules) and check for any information on support. Most module owners have a forum thread to support you and get feedback on their modules.

If you can't find anything on the codex page please search in the Gallery forum to see if other users have the same problem.

If a module completely breaks your Gallery 3 installation (meaning you cannot even access the admin area anymore to deactivate the module) you can simply delete the module folder in your "modules" folder of you Gallery 3 installation. Again: please do not delete the whole modules folder but only the folder of the module in question.


Previous chapter: What are modules? Back to the user guide main page Next chapter: Configuring modules
Retrieved from "http://codex.galleryproject.org/index.php?title=Gallery3:User_guide:Modules:Installing_and_upgrading&oldid=27104"