itvisionsy/laravel-elastic-session

A laravel 5.1 session driver on elasticsearch

v1.1.3 2016-03-21 13:35 UTC

Requires

• php: >=5.5.0
• itvisionsy/php-es-orm: ^1
• laravel/laravel: 5.1.*

Requires (Dev)

• phpunit/phpunit: ^5.0@dev

MIT

• Muhannad Shelleh

README

An elastic-search based session driver for Laravel 5.1

How to use

1. Require it via composer

   composer require itvisionsy/laravel-elastic-sessions
   

2. Add it to the providers list in config/app.php:

   'providers' => [
   //...
   ItvisionSy\LaravelElasticSessionDriver\ElasticSessionServiceProvider::class,
   //...
   ]

3. Set the correct settings in config/session.php

   "driver" => "elastic",
   "elastic" => [
       "url" => "http://localhost:9200/",
       "index" => "laravel-es-sessions",
       "type" => "session"
   ],
   "lifetime" => 30

   Values shown above for elastic parameter are the default values in case you did not configure.

Index/Type mapping

Elastic will detect the mapping by default, however, it is recommended to set the mapping explicitly.

You can do so manually by applying this mapping to the index and type:

{
    "index":"set_the_index",
    "type":"set_the_type",
    "body":{
        "properties":{
            "created":{"type":"date"},
            "updated":{"type":"date"},
            "data":{"type":"string","index":"no"}
        },
        "_ttl":{
            "enabled":true,
            "default":"30m"
        }
    }
}

Or simpler, the package can do it for you. You will need to tinker ./artisan tinker and then set the mapping:

\ItvisionSy\LaravelElasticSessionDriver\ElasticSessionStore::putMapping();

Please note that the putMapping() method will automatically read the values from your sessions config file including the session.lifetime value (in minutes) which will be used as the default TTL value.

Author

Muhannad Shelleh [e-mail]

License

This code is published under MIT license.