|  WBCE CMS Home | Imprint | Privacy | Sitemap | 

Modules

A module is an add-on for WBCE CMS which offers additional functionality for the backend and/or frontend of your WBCE CMS powered website. Modules are shipped as zip-files and can be found for example at the add-on repository of WBCE CMS and other sources (e.g., GitHub).

Install module
  1. Download the zip file of the module you wish to install from trustworthy sources.
    (Please be aware that downloading from unknown sites is a high risk. Not only could the zip file contain viruses to infect your computer, but the modules themselves might contain malicious code which could open a backdoor for hackers or misuse your server for sending out spam.)
    Please notice that modules which are not maintained and outdated might not work properly or could even break your whole site.
  2. Click on the "Browse" button and select the zip file you have downloaded. You do not have to unzip it on your local PC, this will be done in the install process. (WBCE CMS can handle GitHub Zip files too).
  3. If you are updating an already installed module it might be useful to set the option "overwrite newer files".
  • If you do not set this option, you might get a mix-up of newer and older module files. Basically it means that if a module is installed, it gets (according to the server settings) the date when it was installed, so the real module date gets lost. If an update "thinks" it is older and does not overwrite the existing files, you may see the information "update successful" although no or not enough files were updated.
  • If you do set this option, you might loose any customizing you have done to the module, for example changes to the frontend.css or any other files which belong to the module, because all of them are overwritten with the default state of the file from the installation package. So to minimize the risks it's a good idea to backup the module you wish to update by downloading the module files by FTP or with the AFE.

After considering all these points, you can click on the install button and a "Successful" message is displayed if everything worked well. You can now use this module when adding pages or sections, if it's a frontend module, or you can find it at the admin tools page (which is alphabetically sorted).

Uninstall module

If you don't need a module any longer, it's a good idea to remove it - the less files are stored on the server, the less possible security flaws exist.

You cannot uninstall a module which is still in use on one or more pages or sections, so you will get an error message (including a list of pages where the module is still in use) when trying to remove it. You have to delete all sections where the module is used first before you can uninstall it. (If the page trash is active, it's not enough to put pages which use the module into the trash bin, they have to be erased completely.)

Attention: Removing a module means the complete loss of any changes you have made on the module immediately, since all files and database entries are removed. There is no undo option, so please be careful when uninstalling any module.

Module details

Here you find the information which is stored in the info.php of the module. It is the module author's responsibility to keep this information up-to-date and complete.

Advanced

Beneath the advanced options of the add-on page, there exists another advanced view for modules which is displayed when you click on the button on the top right in the module view. By doing so, some input fields and helpful messages are displayed, which you should read and consider seriously.

You should only use these options if you encountered trouble with the usual install/uninstall/update routines of WBCE CMS. The message in red letters is really important. So please don't blame us if you erase the contents of all WYSIWYG sections from the database by executing "install.php" for the WYSIWYG module.