Module MemCached

Retour index
Documentation développeur

Retour index
Documentation Utilisateur

Informations

Module name
Editor / Editeur	NLTechno (www.nltechno.com) - http://www.dolistore.com/
Download or buy page / Page achat ou téléchargement
Status / Statut / Estado	Stable
Prerequisites / Prérequis	Dolibarr min version: 3.0.0    Dolibarr max version: {{{maxversion}}}
Last update date / Date mise à jour fiche / Fecha última actualización	2011-04-10
Note / Nota

Features

Allows Dolibarr to increase speed by using a cache server MemCached. Dolibarr use this cache to store result of redundant operation like reading language files. According to platform, speed increase can be between 15% and 40%.

Prerequisites

To install/use this module, you must before:

• Have a running memcached server and know its address (ex: localhost) and its port (ex: 11211).

Process to install such a server is not part of this documentation. See articles found on the Internet for this (Ie: Seer http://jehiah.cz/projects/memcached-win32/ to install a memcached server on Windows, see http://2bits.com/articles/installing-memcached-125-and-memcache-pecl-223-ubuntu-server.html for an installation on Ubuntu, ...)

• Have functions "memcache" or "memcached" activated into your PHP (Go into Dolibarr menu Home -> System information -> PHP to see if at least one PHP client (memcache or memcached) is available.

Again, if this functions are not available, search article on the Internet to see how to setup your PHP to support memcache ou memecached.

Installation

• Download archive file of module (.zip file) from web site www.dolistore.com or from any other source.

• Install module into the /custom folder of Dolibarr:
  • Go to Home - Setup - Modules - Deploy/install external app/module
  • Upload the file. Note: If it fails because upload from this page has been locked by your web hosting provider, you can manually unzip the file into the /custom directory from command line: Go into the /custom directory and uncompress file with command unzip modulefile.zip then check that the directory with the nameof the module is inside the /custom directory. If into a subdirectory, just move it into /custom.

• Module should be ready to be activated and used.

Configuration

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears on module thumb or at end of the line of the module, click on it to access the setup page specific to the module.

Module setup page:

In the module setup page, you must fille the following informations:

• Name of Memcached server: Put a DNS name or IP address of Memcached server.
• Port or Memcached server: Put here the port of the Memcached server.

Save and that's all. Dolibarr should now use the cache server when it can.

Note: If you add the line

$dolibarr_memcached_view_disable=1;

into file htdocs/conf/conf.php, then the 2 tabs to view statistics on cache server are removed. This is usefull for web hosting providers of Dolibarr (SaaS) to avoid users to see informations (the cache content) shared by the hosted server.

Usage

This module is a technical module. As soon as setup is done, Dolibarr use the cache server when it thinks it's necessary. There is no other things to do.

Development

CVS Repository

The development of this module is not included inside the standard GIT repository of Dolibarr but inside a repository dedicated to modules not supported by the Dolibarr development team but supported by DoliCloud team:

• GIT Repository: git clone https://github.com/DoliCloud/DoliMods.git

Note that the code of all modules developed by DoliCloud team are presents in the same repository (1 sub-directory of htdocs = 1 module). They are all Open Source modules.