Packages
openmaize
3.0.0
3.0.1
retired
3.0.0
2.9.0
2.8.0
2.7.0
2.6.0
2.5.1
2.5.0
2.4.0
2.3.2
2.3.1
2.3.0
2.2.0
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
1.0.1
1.0.0
1.0.0-beta.5
1.0.0-beta.4
1.0.0-beta.3
1.0.0-beta.2
1.0.0-beta.1
1.0.0-beta.0
0.19.3
0.19.2
0.19.1
0.19.0
0.18.1
0.18.0
0.17.2
0.17.1
0.17.0
0.16.2
0.16.1
0.16.0
0.15.1
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.11.0
0.10.2
0.10.1
0.10.0
0.8.1
0.8.0
0.7.5
0.7.4
0.7.2
0.7.1
0.7.0
0.6.7
0.6.6
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
Authentication library for Elixir using Plug
Current section
Files
Jump to
Current section
Files
lib/openmaize.ex
defmodule Openmaize do
@moduledoc """
Openmaize is an authentication library for Plug-based applications in Elixir.
If you are using Phoenix, the easiest way to get started is to run
the following command (add the `--confirm` option to add files
for email confirmation):
mix openmaize.gen.phoenixauth
You then need to configure Openmaize. For more information, see the
documentation for the Openmaize.Config module.
There is an example of Openmaize being used with Phoenix at
[Openmaize-phoenix](https://github.com/riverrun/openmaize-phoenix).
## Migrating from Devise
Follow the above instructions for generating authorization modules,
and then add the following lines to the config file:
config :openmaize,
hash_name: :encrypted_password
## Openmaize plugs
* Authentication
* Openmaize.Authenticate - authenticate the user, using sessions.
* Openmaize.Login - handle login POST requests.
* Openmaize.OnetimePass - plug to handle one-time password POST requests.
* Openmaize.Remember - plug to check for a `remember me` cookie.
* Email confirmation and password resetting
* Openmaize.ConfirmEmail - verify the token that was sent to the user by email.
* Openmaize.ResetPassword - verify the token that was sent to the user by email,
but this time so that the user's password can be reset.
See the relevant module documentation for more details.
For configuration, see the documentation for Openmaize.Config.
"""
end