Veil

v0.2.4

Veil v0.2.4 mix veil.add View Source

Veil - simple passwordless authentication for your Phoenix apps.

This installer will do the following:

  • Append the :veil configuration to your config/config.exs file.
  • Generate the Veil.User, Veil.Request and Veil.Session schemas in lib/yourapp/veil/
  • Generate an Ecto migration for these schemas in priv/repo/migrations/
  • Generate controllers, views, plugs and templates in lib/yourapp_web/[type]/veil
  • If this is a new phoenix app using the default template, modify it to include a sign in link

Examples 

# Default installation
mix veil.add

Link to this section Summary

Functions

amend_default_template(config)

Amend the default layout file to add a Sign-in link in the top right. Do nothing if the app is an api

amend_router(config)
append_config_file(config)
config()

Set up the config map

config_html?(config)
config_names(config)

Add the app name to config

config_paths(config)

Add the main paths of the application to config

config_secrets(config)

Adds salts for the request/session internal tokens. These should only ever be saved in the database, so do not actually need to be this random

copy_file_evaluate(filename, source_dir, target_dir, binding)

Uses Mix.Generator to copy the file across, evaluating against the binding

copy_files(files, source_dir, target_dir, config)

Create directory and copy list of files across

copy_main_dir(config)

Copies the files in the main directory over, and evaluates against EEx using the config

copy_migration(config)

Copy the migration to the priv/repo/migrations folder

copy_templates(config)

Copies the templates in the web directory over (only if html)

copy_web_dir(config)

Copies the files in the web directory over, and evaluates against EEx using the config

run(args)

A task needs to implement run which receives a list of command line args

source_path(path)

Gives the source path to copy files from

verify_paths(config)

Verify the paths all exist

Link to this section Functions

Link to this function amend_default_template(config) View Source

Amend the default layout file to add a Sign-in link in the top right. Do nothing if the app is an api.

Link to this function append_config_file(config) View Source
Link to this function config() View Source

Set up the config map

Link to this function config_names(config) View Source

Add the app name to config

Link to this function config_paths(config) View Source

Add the main paths of the application to config

Link to this function config_secrets(config) View Source

Adds salts for the request/session internal tokens. These should only ever be saved in the database, so do not actually need to be this random.

Link to this function copy_file_evaluate(filename, source_dir, target_dir, binding) View Source

Uses Mix.Generator to copy the file across, evaluating against the binding

Link to this function copy_files(files, source_dir, target_dir, config) View Source

Create directory and copy list of files across

Link to this function copy_main_dir(config) View Source

Copies the files in the main directory over, and evaluates against EEx using the config

Link to this function copy_migration(config) View Source

Copy the migration to the priv/repo/migrations folder

Link to this function copy_templates(config) View Source

Copies the templates in the web directory over (only if html)

Link to this function copy_web_dir(config) View Source

Copies the files in the web directory over, and evaluates against EEx using the config

Link to this function run(args) View Source

A task needs to implement run which receives a list of command line args.

Callback implementation for Mix.Task.run/1.

Link to this function source_path(path) View Source

Gives the source path to copy files from

Link to this function verify_paths(config) View Source

Verify the paths all exist