factored 2.1

Install

using virtualenv:

virtualenv factored
cd factored
git clone git://github.com/vangheem/factored.git
cd factored
../bin/python setup.py develop
../bin/initializedb develop.ini
../bin/adduser develop.ini --username=john@foo.bar
../bin/paster serve develop.ini
../bin/removeuser develop.ini --username=john@foo.bar

Configuration

Must follow the example develop.ini provided. You’ll probably want to copy that file into your own and change the settings.

Edit server and port settings for application server if not using with another wsgi application.

Nginx Example Configuration

An example setup with nginx and load balancing:

server {
    listen  80;
    server_name www.test.com;
    include proxy.conf;

    # paths to protect
    location ~ ^/admin.* {
        proxy_pass http://127.0.0.1:8000;
    }

    location / {
        proxy_pass http://app;
    }
}

server {
    listen 8090;
    include proxy.conf;
    location / {
        proxy_pass http://app;
    }
}

Then factored would be configured to run on port 8000 and proxy to 8090 and have base_auth_url url set to /admin/auth.

Sample Paste Configuration

An example to follow if you’re not using a git checkout:

[app:proxy]
use = egg:factored#simpleproxy
server = 127.0.0.1
port = 8090

[filter-app:main]
use = egg:factored#main
next = proxy
appname = REPLACEME

auth_tkt.secret = REPLACEME
auth_tkt.cookie_name = factored
auth_tkt.secure = false
auth_tkt.include_ip = true

auth_timeout = 7200
auth_remember_timeout = 604800
base_auth_url = /auth
supported_auth_schemes =
    Google Auth
    Email

email_auth_window = 120
# in seconds
em.subject = Authentication Request
em.sender = foo@bar.com
em.body =
    You have requested authentication.
    Your temporary access code is: {code}

autouserfinder = SQL
autouserfinder.table_name = users
autouserfinder.email_field = email
autouserfinder.connection_string = sqlite:///%(here)s/users.db

allowcodereminder = true
allowcodereminder.subject = Authentication code reminder
allowcodereminder.sender = foo@bar.com
allowcodereminder.body =
    You have requested code reminder.
    Your google auth code url is: {code}

pyramid.reload_templates = true
pyramid.debug_authorization = true
pyramid.debug_notfound = true
pyramid.debug_routematch = true
pyramid.default_locale_name = en
pyramid.includes =
    pyramid_tm
    pyramid_mailer

sqlalchemy.url = sqlite:///%(here)s/test.db

# all mail settings can be found at http://packages.python.org/pyramid_mailer/#configuration
mail.host = localhost
mail.port = 25

[server:main]
use = egg:Paste#http
# Change to 0.0.0.0 to make public:
host = 127.0.0.1
port = 8000

With Gunicorn

Install:

../bin/easy_install gunicorn

to run:

../bin/gunicorn_paste --workers=2 develop.ini

Customizing Templates

Use pcreate to generate package skeleton:

./bin/pcreate –template=starter factored_customize cd factored_customize

To register template overrides customize __init__.py:

from factored.templates import registerTemplateCustomizations

def includeme(config):

import factored_customize as pkg registerTemplateCustomizations(config, ‘templates’, pkg)

Modify paster ini file to include pyramid addon:

pyramid.includes =

… factored_customize

Available Customizable Templates

meta.pt

Override metadata in the head tag.

includes.pt

Override includes in the head tag.

headbottom.pt

Add additional html to the bottom of the head tag. Empty by default.

top.pt

Renders at top of container. Empty by default.

title.pt

Renders title of application.

abovecontent.pt

Renders above content. Empty by default.

auth.pt

Authentication layout template.

auth-code.pt

Code input.

auth-email.pt

Email input.

auth-controls.pt

Form controls.

auth-chooser.pt

Authentication system chooser.

belowcontent.pt

Below the content. Empty by default.

footer.pt

Application footer.

bottom.pt

Very bottom of layout. Empty by default.

Credit

Work was sponsored by wildcardcorp.com

2.1 (2013-06-04)

• script and template fixes

2.0rc1 (2013-01-31)

• more robust multi-use environment with database connections

• support more algorythms for auth ticket

• refactor so it’s more modular

• be able to easily customize all templates

• be able to customize text

• pull out auth_tkt module of paste so we can customize a bit

1.1a2 (2012-03-26)

• specify appname to customize google auth code entry.

• redirect to original url if possible

• be able to provide “remember me” functionality

1.1a1 (2012-03-26)

• add auto user finder support

• add ability to send google code reminders. This can work well with the autouserfinder

1.0a1 (2012-03-23)

• Initial release