These are the generic instructions for installing and upgrading any XOOPS module.

Generally, installing and upgrading any XOOPS module is easy. Just put the files in the modules directory and install it or upgrade it using the Modules Administration applet in System Administration. However, if you're like me and customize your installations (as XOOPS is designed) with template and language changes, then these instructions make it easier to keep those customizations.

TEST and BACKUP

No matter what — fresh install, upgrade, or whatever — TEST THE MODULE ON A DEVELOPMENT SITE FIRST. Also, it's best if you install it and test it on a development installation of your current production site to make sure it works and doesn't cause any other problems, do configurations, templates, etc., etc. However, it IS possible to just install a module on production sites and such, quickly turn off its permissions to all but admin, then move forward from there; but it's generally NOT recommended. Finally, before applying to a production site, backup your files and your database so you can restore it if necessary.

Fresh Install

Special Instructions

Some modules have special instructions to follow. You'll usually find it in a docs folder, an install.txt or readme.txt file. Look around and make sure there aren't any special instructions. If you can't find anything that looks fairly obvious, then it's likely not needed. If there are special instructions, it's likely a file replacement, new extra files, and/or an upgrade script to run, file uploads to configure, etc. If replacing any core XOOPS files, then you'll want to compare the files first and integrate depending upon your needs. Read them and comprehend.

Upload Module Files

Generally, unzip or gunzip and untar the files into the modules directory. If you don't have shell access, get a better host. But, seriously, FTP the files to the module directory after unzipping on your computer.

Install Module in Administrator

Go to the Administration Menu (yeah, you'll have to login as a superuser). Scroll to the bottom of the page and find the module you wish to install. Click the install icon, and on the confirmation page, click the affirmative button. Hopefully after all the information shows, you get a success message.

You're done. Use the module.

Upgrade

This process may be overkill for your needs, but it has a number of considerations for keeping the customizations of an institutionalized installation of XOOPS during the inevitable upgrades and updates to the web application.

Code/Language Files Compare/Integration

This is only necessary if you've made any custom code changes (I do occassionally, but only as absolutely necessary). This is a way to also easily check language changes (now manageable using AltSys module) as well as the template files. Compare your current module files against the original release. Check the new module to see if the changes have been integrated and integrate as appropriate and necessary after testing the module in a test site.

Special Instructions/Upload Module Files

Same process as for a fresh install. Use those above, then come back here.

If using FCKeditor and you have module specific settings, upload/install and integrate the new FCKeditor module configs as appropriate.

Save Template Files

Copy the base (file) templates set (using AltSys) to another templates setdifferent from the current template set in use (I name it using the old version). I use the AltSys module to manage templates (and you should too if you don't). Tthis process makes it easier to see which templates changed and where to allow you to integrate those changes into your new templates as desired. I make extensive template changes to the modules, usually, but the updates typically have some new functionality to display unless it's just a bug-fix update.

Update Module in Administration

Go to the Administration Menu (yeah, you'll have to login as a superuser). Find the module you wish to update. Click the update icon, and on the confirmation page, click the affirmative button. Hopefully after all the information shows, you get a success message.

Integrate Templates/Language Changes

Using the compare steps above integrate the new changes to the templates and language files into yours (or vice-versa) as appropriate.

You're done. Use the module.