Installing Modules

From ExponentCMS Docs

Jump to: navigation, search

Edit Menu

  • Icon_Geting_Started_20px.png Getting Started
  • What is Exponent?
    An overview of Exponent including Features, Roadmap, License and a link to a test drive Demo.
  • Exponent Terminology
    An explanation of Exponent User and System Terminology to help you understand how Exponent works.
  • Installing Exponent
    A guide to Installing Exponent including System Requirements, Downloading, Uploading, Database, Install Wizard and Troubleshooting.
  • Installing Themes
    A guide to adding Themes to change the look of your Exponent website.
  • Installing Modules
    A guide to adding Modules to extend functionality of your Exponent website.
  • Configuring Exponent
    A guide to Configuring your Exponent site after installation.
  • Migrating Exponent
    A guide to Migrating an existing Exponent installation to a new server.
  • Upgrading Exponent
    A guide to Upgrading existing Exponent installations.
Edit Menu

Image:Icon_Geting_Started_40px.png Installing Modules

This page contains a guide to Adding a Module to an Exponent installation.

Contents

Automatic Module Installation Icon_Warning_20px.png

Exponent has an Upload New Module feature which allows for the automatic installation of extra Modules. In order to use this feature you must ensure your directory permissions are set to 755 for: 

/datatypes/                            (folder)
/datatypes/definitions/                (folder)
/subsystem/lang/eng_US/datatypes/      (folder)
/subsystem/lang/eng_US/modules/        (folder)

You may also need to change permissions on other folders, depending on which files the module you are installing needs to write to the server. Exponent will prompt you to do this before the installation completes.

Once you've ensured your file permissions are set correctly, do the following:

  1. Login to your Exponent website and goto Admin Control Panel > Manage Modules.
  2. Click on the Upload New Module link in the top section.
  3. Browse your local computer to select the Module Archive file and then click Install.
  4. If all your file permissions are ok and the module you are trying to install doesn't already exist, then just click Install and the installation will complete.
  5. Return to Admin Control Panel > Manage Modules.
  6. Locate the module you have just installed and click Activate Module to make it available to the Container module.

Note: On some web servers it may be necessary to set these folders to 777 in order to use this feature. Remember to set the permissions back to 755 after installation is complete to protect your site!

Manual Module Installation Icon_Warning_20px.png

You can also manually install Exponent CMS Modules as follows:

  1. Download the Module archive and extract it to your local hard drive.
  2. Upload the Module Files via FTP to your Exponent CMS website:
    1. Datatype Files — these files control the Edit pages of the module. Copy to: 
       /datatypes/                            (folder)
    2. Datatype Definition Files — these files contain the database table definitions. Copy to: 
       /datatypes/definitions/                (folder)
    3. Module Folder — this is the actual module, including class, actions and views. Copy to: 
       /subsystem/lang/eng_US/datatypes/      (folder)
    4. Subsystem Files — these files are included with some Modules and contain the language specific information. Copy to: 
       /subsystem/lang/eng_US/modules/        (folder)
    5. Additional Files — some Modules include extra files such as extra subsystems or javascript libraries. This varies from module to module so see the ReadMe file which should be included with all Modules if you are unsure.
  3. Goto Admin Control Panel > Install Tables to install the module's tables into the database.
  4. Goto Admin Control Panel > Manage Modules.
  5. Locate the module you have just installed and click Activate Module to make it available to the Container module.

Note: when manually installing an Exponent Module, the database tables are NOT created until you initiate the Install Tables admin function.


Example Image Gallery Lightbox Installation Icon_Warning_20px.png

Below is an example of the files contained within the Image Gallery Lightbox module.

Datatype Files 

/datatypes/imagegallery_gallery.php                  (file)
/datatypes/imagegallery_image.php                    (file)

Definition Files 

/datatypes/definitions/imagegallery_gallery.php      (file)
/datatypes/definitions/imagegallery_image.php        (file)

Module Files 

/modules/imagegallerymodule/                         (folder)

Subsystem Files & Folders 

/subsystems/lang/eng_US/modules/imagegallerymodule   (folder)


Image:Icon_Resources_20px.png Getting Started Resources

Retrieved from "http://docs.exponentcms.org/Installing_Modules"
Personal tools