Phauxth

v0.13.0-rc.1

Phauxth v0.13.0-rc.1 Phauxth.Remember View Source

Remember me Plug using Phoenix Token.

Options

There are three options:

  • token - the token key source to use when using Phoenix token

    • in most cases, this will be the name of the endpoint you are using

    • see the documentation for Phoenix.Token for more information

  • max_age - the length of the validity of the token

    • the default is four weeks

  • user_context - the user context module to be used

    • the default is MyApp.Accounts

Examples

Add the following line to the pipeline you want to authenticate in the web/router.ex file:

plug Phauxth.Authenticate
plug Phauxth.Remember

Make sure you add the Phauxth.Remember Plug after Phauxth.Authenticate.

Link to this section Summary

Functions

add_rem_cookie(conn, user_id, max_age \\ 2419200)

Add a Phoenix token as a remember me cookie

delete_rem_cookie(conn)

Delete the remember_me cookie

set_user(user, conn)

Set the current_user variable

Link to this section Functions

Link to this function add_rem_cookie(conn, user_id, max_age \\ 2419200) View Source

Add a Phoenix token as a remember me cookie.

Link to this function delete_rem_cookie(conn) View Source

Delete the remember_me cookie.

Link to this function set_user(user, conn) View Source

Set the current_user variable.