teamneusta/elasticcache

elastic cache backend

Installs: 3 544

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 9

Forks: 0

Open Issues: 0

Type:typo3-cms-extension

1.1.0 2018-01-22 13:10 UTC

This package is auto-updated.

Last update: 2021-03-23 12:46:50 UTC


README

Provides a cache backend for TYPO3 which enables storing caches in elasticsearch.

Prerequisites

Installation

composer require teamneusta/elasticcache

Configuration

Add a section to your local configuration configuring the cache. You can either reconfigure existing caches or add a new one for your own use. For more general information see the caching framework documentation (at https://docs.typo3.org/typo3cms/CoreApiReference/ApiOverview/CachingFramework/Index.html#caching)

The following options can be set:

  • host: The elasticsearch host name (defaults to localhost)
  • port: The elasticsearch port (defaults to 9200)
  • path: The elasticsearch path (defaults to /)
  • transport: The elasticsearch transport protocol (defaults to http)
  • indexName: The index name to use for this cache - make sure to choose a different one per cache
  • typeName: The type name to use for this index
  • indexConfiguration: The path to index configuration where you can set alternating mappings and analyzers
  • defaultLifeTime: The default lifetime of a cache entry in this cache (in seconds - 0 means unlimited)

Example

'SYS' => [
	 'caching' => [
		 'cacheConfigurations' => [
			 'my_cache' => [
				 'backend' => 'TeamNeusta\\Elasticcache\\Cache\\Backend\\ElasticsearchBackend',
				 'frontend' => 'TYPO3\\CMS\\Core\\Cache\\Frontend\\VariableFrontend',
				 'options' => [
					 'defaultLifetime' => 0,
					 'indexName' => 'my_cache_index_name'
					 'typeName' => 'my_cache_type_name'
					 'indexConfiguration' => 'EXT:myext/Configuration/Elastic/indexConfiguration.yaml'
				 ],
			 ],
		 ],
	 ],

Issues and Feedback

If you run into any issues, want to contribute or just give feedback, just use the github issue tracker.