https://github.com/roaatech/laravel-elastic-session
A session driver for elastic search for laravel 5.1
https://github.com/roaatech/laravel-elastic-session
elastic elasticsearch laravel laravel51 php session-driver
Last synced: 24 days ago
JSON representation
A session driver for elastic search for laravel 5.1
- Host: GitHub
- URL: https://github.com/roaatech/laravel-elastic-session
- Owner: roaatech
- License: mit
- Created: 2015-11-07T06:43:09.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-23T12:25:20.000Z (about 9 years ago)
- Last Synced: 2025-12-26T06:51:07.365Z (3 months ago)
- Topics: elastic, elasticsearch, laravel, laravel51, php, session-driver
- Language: PHP
- Size: 21.5 KB
- Stars: 4
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Elastic Session Driver
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`:
```php
'providers' => [
//...
ItvisionSy\LaravelElasticSessionDriver\ElasticSessionServiceProvider::class,
//...
]
```
3. Set the correct settings in `config/session.php`
```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:
```json
{
"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:
```php
\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
## License
This code is published under [MIT](LICENSE) license.