Packages

phauxth

2.0.0-alpha.5
2.5.1 retired 2.5.0 2.4.0 2.3.2 2.3.1 2.3.0 2.2.0 2.1.1 2.1.0 2.0.1 2.0.0 2.0.0-rc.2 2.0.0-rc.1 2.0.0-rc.0 2.0.0-beta.1 2.0.0-beta.0 2.0.0-alpha.5 2.0.0-alpha.4 retired 2.0.0-alpha.3 retired 2.0.0-alpha.2 retired 2.0.0-alpha.1 retired 2.0.0-alpha.0 retired 1.2.9 1.2.8 1.2.7 1.2.6 1.2.5 1.2.4 1.2.3 1.2.1 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.3 1.0.2 1.0.1 1.0.0 0.17.1 0.17.0 0.16.0 0.15.1 0.15.0 0.14.0 0.13.0-rc.1 0.13.0-rc.0 0.12.1-rc.1 0.12.1-rc.0 0.12.0-rc 0.11.0 0.10.3 0.10.2 0.10.0 0.9.0 0.8.2 0.8.1 0.8.0

Authentication library for Phoenix, and other Plug-based, web applications

HexDocs

Current section

Files

Jump to
Readme
58 Versions
2 Dependencies
Dependants
Files
Activity
phauxth README.md
Raw

README.md 

# Phauxth



[![Hex.pm Version](http://img.shields.io/hexpm/v/phauxth.svg)](https://hex.pm/packages/phauxth)

[![Join the chat at https://gitter.im/phauxth_elixir/Lobby](https://badges.gitter.im/phauxth_elixir/Lobby.svg)](https://gitter.im/phauxth_elixir/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



Authentication library for Phoenix, and other Plug-based, web applications.



Phauxth is designed with Phoenix 1.3 in mind, but it can also be used with

older versions of Phoenix and any other Plug-based application. It is

designed to be secure, extensible and well-documented.



For a general overview of some of the goals of Phauxth and its basic usage,

see [this post](https://riverrun.github.io/projects/phauxth/2017/09/25/phauxth.html).



## Getting started



[This guide](https://github.com/riverrun/phauxth/wiki/Getting-started)

shows how you can set up a new Phoenix project with Phauxth.



## Authentication and authorization



The core Phauxth library handles authentication, verifying who the

user is.



For information about authorization, or access control, see the

[Authorization](https://github.com/riverrun/phauxth/wiki/Authorization) page

in the wiki.



If you have set up your app using the [Phauxth installer](https://github.com/riverrun/phauxth_installer),

the `authorize.ex` file in the controllers directory provides examples

of functions you can use to authorize users' access to resources.



## Phauxth examples



* [A basic example](https://github.com/riverrun/phauxth-example) of using

Phauxth with email confirmation.

* [An example api](https://github.com/riverrun/phoenix-todoapp) using Phauxth.



### License



BSD