Installation

Requirements

• Crystal 1.0.0 or higher

• Redis 5.0+ (for Redis and Clustered Redis stores)

Add Dependency

Add the session shard to your shard.yml:

dependencies:
  session:
    github: azutoolkit/session
    version: ~> 1.0

Install

Run shards to install the dependency:

shards install

Verify Installation

Create a test file to verify the installation:

# test_session.cr
require "session"

struct TestSession
  include Session::SessionData
  property test : String = "Hello"
end

Session.configure do |config|
  config.secret = "test-secret-for-verification"
  config.provider = Session::MemoryStore(TestSession).provider
end

session = Session.provider.create
puts "Session ID: #{session.session_id}"
puts "Installation successful!"

Run the test:

crystal run test_session.cr

Optional Dependencies

Redis Support

For Redis-based stores, ensure you have Redis installed and running:

# macOS
brew install redis
brew services start redis

# Ubuntu/Debian
sudo apt-get install redis-server
sudo systemctl start redis

# Docker
docker run -d -p 6379:6379 redis:7-alpine

Verify Redis connection:

redis-cli ping
# Should return: PONG

Next Steps

• Quick Start - Create your first session

• Configuration - Configure session options