redis-session

A Crystal shard for Lucky framework to enable session storage in redis. This allows you to store more than just 4kb in session when using lucky framework, due to lucky storing the whole session in cookies. This shard simply gives the client a session identifier that is cross-referenced with your redis database.

A very hacky solution that should "just work".

How to use

Add to shards.yml

redis-session:
  github: kaskatto/redis-session

Then run

shards install

After installing the shards make sure to run the post install script from the scripts folder!! (cant do it automatically due to permission issues)

Run these commands in order, starting from your app's root folder:

cd lib/redis-session/

bash scripts/post_install

You can then start the app

Note This script replaces core lucky framework files. It does create a backup before hand, should things go wrong - just keep that in mind.

After the script finishes add the following to your shards.cr

require "redis-session"

There is a config file as well allowing you to customise how redis-session works. It is included by default. To utilise it you should move it to your config folder (if its not already there.) Below is the config example:

RedisSession.configure do |settings|
 # Sets the name for the session id cookie
 settings.session_id_name = "_session"
 # Sets the id length
 settings.session_id_length = 32
 # Should session storage be encrypted? (redis does not support encryption at rest - unless your using a cloud service like Redis Cloud or AWS)
 settings.encrpyt_session_storage = false
 # Sets how long a session will idle before being removed (idle timer reset every time session is written or read)
 settings.session_idle_time = 60.minutes
 # URI to redis server -
 settings.redis_uri = "redis://localhost:6379/0"
end