Packages

phauxth

0.12.0-rc
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
4 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 web apps.



## Getting started with Phauxth and Phoenix



### Create new Phoenix project



Run the following commands (replace alibaba with the name of your project):



    mix phx.new alibaba

    cd alibaba



To create an api, change the `mix phx.new` command to:



    mix phx.new alibaba --no-html --no-brunch



### Run the Phauxth installer



Download and install the [phauxth_new installer](https://github.com/riverrun/phauxth/raw/master/installer/archives/phauxth_new.ez).



    mix archive.install https://github.com/riverrun/phauxth/raw/master/installer/archives/phauxth_new.ez



For a basic setup, run the following command:



    mix phauxth.new



If you want to add email / phone confirmation and password resetting, add the `--confirm` option:



    mix phauxth.new --confirm



If you want to create authentication files for an api, use the `--api` option:



    mix phauxth.new --api



### Add phauxth to deps



Make sure you are using Elixir 1.4 or above.



1. Add phauxth to your `mix.exs` dependencies



    ```elixir

    defp deps do

      [{:phauxth, "~> 0.10"}]

    end

    ```



2. Run `mix deps.get`



See the [wiki](https://github.com/riverrun/phauxth/wiki) for more

information about Phauxth.



### License



BSD