README.rst

FAS (Fedora Account System) 3.0

Authors

Xavier Lamien, Pierre-yves Chibon, Ricky Elrod

Contacts

infrastructure@lists.fedoraproject.org

The Fedora Account System is a community oriented accounts system which aims to provide a self-driven and self-controled management to its registered users.

Requirements

Packages

• pyramid (1.5.1 or newer)
• pyramid_mako
• SQLAlchemy (1.0 or newer)
• transaction
• pyramid_tm
• zope.sqlalchemy
• waitress
• pytz
• enum34
• wtforms
• mistune
• GeoIP
• pygeoip
• ua-parser
• pyyaml
• pillow
• cryptography
• Babel
• lingua
• fedmsg
• PyGithub (optional)
• fake-factory (optional)
• pyramid_debugtoolbar (optional)

Python Version

FAS has been tested on Python 2.6 and 2.7 only at this time.

Installation

FAS can be installed as follows:

% python setup.py install

If necessary, the --install-data option can be used to configure the location in which the resources (res) and example· files (docs) should be installed.

Migrating FAS from release 2.x

Note

work in progress

Getting involved

Requirements

• virtualenvwrapper
• libffi
• openssl
• GeoIP
• libyaml

If you want to enable fonts that match with Fedora logo usage guideline:

• comfortaa-fonts
• cantarell-fonts

If you are running a Fedora or RedHat/CentOs's OS, here are dependencies' packages to install:

% sudo dnf install -y python-virtualenvwrapper libffi-devel openssl-devel \
        GeoIP-devel libyaml-devel redhat-rpm-config libjpeg-turbo-devel

Configuration

Add the following to your ~/.zshrc or `~/.bashrc`:

% export WORKON_HOME=$HOME/.virtualenvs
% source /usr/bin/virtualenvwrapper.sh

and reload your shell by sourcing its rc's file or closing and opening your terminal back up.

And if you want to use system fonts:

% sudo dnf install -y aajohan-comfortaa-fonts abattis-cantarell-fonts

Then run the boostrap helper script:

% ./bootstrap.py

And finally, load the virtualenv created:

% workon fas-python2.7

Initialize the database

% fas-admin -c development.ini --initdb --default-value

Run the test suite

% python setup.py test

Add fake data (People and group)

% fas-admin -c development.ini --generate-fake-data -n 1200

Run the web app

% pserve development.ini --reload

Hacking with vagrant

Quickly start hacking on FAS3 using the vagrant setup that is included in the FAS3 repo is super simple.

First, install Vagrant, the vagrant-sshfs plugin, and the vagrant-libvirt plugin from the official Fedora repos:

sudo dnf install vagrant vagrant-libvirt vagrant-sshfs

Now, from within main directory (the one with the Vagrantfile in it) of your git checkout of FAS3, run the vagrant up command to provision your dev environment:

vagrant up

When this command is completed (it may take a while) run the following command to start the FAS3 server on the vagrant virtual machine:

vagrant ssh -c 'pushd /vagrant/; pserve /home/vagrant/development.ini --reload'

Once that is running, simply go to http://localhost:5002/ in your browser on your host to see your running FAS3 test instance.