Skip to content
Devise based authorization for AlchemyCMS
Branch: master
Clone or download
tvdeyen v4.2.1
- Remove test files from built Ruby gem [#82](#82) ([tvdeyen](https://github.com/tvdeyen))
- Run CSRF protection before all other controller filters [#81](#81) ([tvdeyen](https://github.com/tvdeyen))
Latest commit 4fe8f82 May 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
bin
config
db/migrate
lib
spec
.gitignore
.travis.yml
CHANGELOG.md v4.2.1 May 15, 2019
Gemfile
LICENSE
README.md v4.2.0 Apr 1, 2019
Rakefile
alchemy-devise.gemspec

README.md

Devise based authentication for AlchemyCMS 4.2

Build Status

Gem Version Test Coverage Code Climate security

AlchemyCMS has no authentication in its core. So it is possibly to bring your own authentication and use it to authorize users in AlchemyCMS. If you don't have your own authentication, you can use this gem.

Install

Just put the gem into your projects Gemfile.

# Gemfile
gem 'alchemy-devise', github: 'AlchemyCMS/alchemy-devise', branch: '4.2-stable'

and run bundle install.

Then run the installer:

$ bin/rails g alchemy:devise:install

Upgrading

After updating the gem, please run the installer again.

$ bundle update alchemy-devise
$ bin/rails g alchemy:devise:install

Devise modules

Default Devise modules included in Alchemy::User model

  • :database_authenticatable
  • :trackable
  • :validatable
  • :timeoutable
  • :recoverable

If you want to add additional modules into the Alchemy user class append them to Alchemy.devise_modules in an initializer in your app.

Register additional modules example

# config/initializers/alchemy.rb
Alchemy.devise_modules << :registerable

Using old encryption

If your app uses an old encryption that needs the +devise-encryptable+ gem you also need to load the devise module.

# config/initializers/alchemy.rb
Alchemy.devise_modules << :encryptable

Testing

If you want to contribute (and you should ^_^), you need to run the tests locally on your machine.

Just follow these pretty rails standard way of testing projects:

1. Once to prepare the test suite:

Clone the repo to your local harddrive. Then

$ bundle install
$ rake alchemy:spec:prepare

2. Run the tests with:

$ rspec

Optional: Even shorter

$ rake

That prepares the database and runs the Rspec task in one step.

Getting Help

Resources

License

You can’t perform that action at this time.