View source for Module MemCached

<!-- BEGIN origin interlang links -->
<!-- You can edit this section but do NOT remove these comments
     Links below will be automatically replicated on translated pages by PolyglotBot -->
[[fr:Module_MemCached_FR]]
[[es:Módulo_MemCached]]
<!-- END interlang links -->

[[Category:Complementary modules]]
[[Category:MemCached]]
[[Category:DoliCloud]]
{{TemplateDocDevEn}}
{{TemplateDocUser}}
= Informations =
{{TemplateModuleInfo
|modulename=Accelerator MemCached
|editor=DoliCloud
|web={{URLNLTechno}}
|webbuy={{LinkToPluginDownloadDoliStore|keyword=memcached}}
|status=stable
|prerequisites=
|minversion=6.2
|note=
}}

= Features =
Allows Dolibarr to increase speed by using a cache server [http://memcached.org/ MemCached]. Dolibarr use this cache to store result of redundant operation like IO used for reading language files. According to platform, speed increase can be between 20% 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:

- See {{LinkForMemCachedInstallWindows}} for install on Windows

- See {{LinkForMemCachedInstallUbuntu}} for install on Ubuntu, ...

- See {{LinkforMemCachedInstallMacOS}} for install on MacOS 10.6

* Have functions "'''memcached'''" activated into your PHP (Go into Dolibarr menu '''Home -> System information -> PHP''' to see if at least PHP functions memcached are available).
Again, if those functions are not available, search article on the Internet to see how to setup your PHP to support memcached.

= Installation =
{{InstallModuleDoliStoreEn|keyword=memcached}}

= Configuration =
{{ActivationModuleEn}}



'''Module setup page:'''

== The tab Server setup ==
In the server setup page, you must fill the following information:

* 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
<syntaxhighlight lang="ini">
$dolibarr_memcached_view_disable=1;
</syntaxhighlight>
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 information (the cache content) shared by the hosted server.

== The tab Server statistics ==
This tab show you the status of the cache and how much it is used.
To have an idea of the efficiency, see the next chapter.

<div class="divforimgcentpercent">
[[File:Memcached screenshot 1.png]]
</div>

= 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.

The following screenshot show you a performance comparison, done with BlackFire, with and without the module. As we can see, the gain (59ms faster for a total of 152ms, so 25% faster) is mostly on the step to load the language files (already in cache, 56ms for this step in function '''Translate::load''').

<div class="divforimgcentpercent">
[[File:Comparison with blackfire.png]]
</div>

= Development =
{{TemplateModNLTechnoEn}}