The project is in a healthy, maintained state
This gem provides a strategy for revoking JWT tokens in a Rails application using Devise, utilizing Redis for token storage and revocation management.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
 Project Readme

Devise::Jwt::RevocationStrategies::Redis

Installation

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

$ bundle add devise-jwt-revocation_strategies-redis

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install devise-jwt-revocation_strategies-redis

Usage

Configuration

  • Setting up Redis Ensure that you have Redis installed and running. You can configure the Redis connection URL in your environment variables. For example:
REDIS_AUTH_URL=redis://localhost:6379/0

Setup your devise model:

class User < ApplicationRecord
  include Devise::Jwt::RevocationStrategies::Redis::JwtDispatcher

  devise :database_authenticatable, # your enabled modules
         :jwt_authenticatable, jwt_revocation_strategy: Devise::Jwt::RevocationStrategies::Redis
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devise-jwt-revocation_strategies-redis.