Phauxth v1.2.5 Phauxth.Config View Source
This module provides an abstraction layer for configuration.
The following are valid configuration items.
name | type | default |
---|---|---|
log_level | atom | :info |
drop_user_keys | list of atoms | [] |
user_context | module | MyApp.Accounts |
user_messages | module | Phauxth.UserMessages |
endpoint | module | N/A |
token_salt | string | N/A |
Umbrella apps
Due to how the configuration is handled in umbrella apps, you will
need to override the token_salt
and endpoint
values when using
them in the sub-apps.
The example below shows how the token can be generated this way:
Phauxth.Token.sign(conn, data, token_salt: "somesalt")
And this example shows how the Confirm.verify function needs to be called:
Phauxth.Confirm.verify(params, MyApp.Accounts,
endpoint: MyAppWeb.Endpoint, token_salt: "somesalt")
Examples
Add a phauxth
entry to the config.exs
file in your project,
as in the following example.
config :phauxth,
token_salt: "YkLmt7+f",
endpoint: MyAppWeb.Endpoint,
log_level: :warn,
drop_user_keys: [:shoe_size]
Link to this section Summary
Functions
The keys that are removed from the user struct before it is passed on to another function
The endpoint of your app
Generate a random salt for use with token authentication
The log level for Phauxth logs
The salt to be used when creating and verifying tokens
The user context module to be used
Module to be used to display messages to users
Link to this section Functions
The keys that are removed from the user struct before it is passed on to another function.
This should be a list of atoms.
By default, :password_hash, :password and :otp_secret are removed, and this option allows you to add to this list.
The endpoint of your app.
This is used by the Phauxth.Confirm module.
Generate a random salt for use with token authentication.
The log level for Phauxth logs.
This can be false
, :debug
, :info
, :warn
or :error
.
The default is :info
, which means that :info
, :warn
and :error
logs
will be returned.
The salt to be used when creating and verifying tokens.
This is used by the Phauxth.Authenticate module, if you are using token authentication, and by the Phauxth.Confirm module.
The user context module to be used.
If no user_config config is set, the default is MyApp.Accounts. See Phauxth.Utils for more default user_context info.
Module to be used to display messages to users.
The default is Phauxth.UserMessages. See the documentation for Phauxth.UserMessages.Base for details about customizing / translating these messages.