https://github.com/rack/rack-session

https://github.com/rack/rack-session

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/rack/rack-session
• Owner: rack
• License: mit
• Created: 2021-02-11T00:40:49.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-10T04:45:14.000Z (over 2 years ago)
• Last Synced: 2024-05-08T18:16:15.947Z (about 2 years ago)
• Language: Ruby
• Size: 85 KB
• Stars: 31
• Watchers: 10
• Forks: 14
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • License: license.md
  • Security: security.md

Awesome Lists containing this project

README

          
# Rack::Session

Session management implementation for Rack.

[![Development Status](https://github.com/rack/rack-session/workflows/Test/badge.svg)](https://github.com/rack/rack-session/actions?workflow=Test)

## Usage

In your `config.ru`:

``` ruby

# config.ru

require 'rack/session'

use Rack::Session::Cookie,

  :domain => 'mywebsite.com',

  :path => '/',

  :expire_after => 3600*24,

  :secret => '**unique secret key**'

```

Usage follows the standard outlined by `rack.session`, i.e.:

``` ruby

class MyApp

  def call(env)

    session = env['rack.session']

    # Set some state:

    session[:key] = "value"

  end

end

```

### Compatibility

`rack-session` code used to be part of Rack, but it was extracted in Rack v3 to this gem. The v1 release of this gem is compatible with Rack v2, and the v2 release of this gem is compatible with Rack v3+. That means you can add `gem "rack-session"` to your application and it will be compatible with all versions of Rack.

## Contributing

We welcome contributions to this project.

1.  Fork it.

2.  Create your feature branch (`git checkout -b my-new-feature`).

3.  Commit your changes (`git commit -am 'Add some feature'`).

4.  Push to the branch (`git push origin my-new-feature`).

5.  Create new Pull Request.