Awesome
Devise based authentication for AlchemyCMS
AlchemyCMS has no authentication in its core. So it is possible 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'
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
- If you have bugs, please use the issue tracker on Github.
- For Q&A and general usage, please use the Slack
Resources
- Homepage: https://alchemy-cms.com
- Live-Demo: https://alchemy-demo.herokuapp.com (user: demo, password: demo123)
- API Documentation: https://www.rubydoc.info/github/AlchemyCMS/alchemy-devise
- Issue-Tracker: https://github.com/AlchemyCMS/alchemy-devise/issues
- Sourcecode: https://github.com/AlchemyCMS/alchemy-devise
- Slack: https://slackin.alchemy-cms.com