Installation¶

Since Spiff is written with Django, the Django installation docs may be a helpful primer.

In Brief¶

Create a local_settings.py that contains any values you want to override from settings.py.
Install your dependencies:

$ pip install -r pip-requirements
$ ./manage.py syncdb –migrate
Go nuts.

The default settings use sqlite3 as the database, with /path/to/spiff/spiff.sqlite3 as the file.

Common Environments¶

MySQL¶

Here is an example configuration to put in local_settings.py:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'spiff',
        'USER': 'spiff',
        'PASSWORD': 'hunter2',
        'HOST': '',
        'PORT': ''
    }
}

Leaving HOST and PORT empty uses ‘localhost’ at the default mysql port.

Please refer to the Django MySQL docs for more details.

Apache¶

This section is included as an example to get Spiff and Apache to work together in harmony. It is more or less exactly how we run things at synhak.org

First, decide where you’re going to serve up spiff. Keep in mind: this URL should probably never ever ever change in your space’s lifetime. QR codes, hardware sensors, door swipes, and whatever else you have talking to Spiff will need reconfigured if things ever move. We run our instance at https://synhak.org/auth/

Our git clone of Spiff is located in /usr/share/spiff/.

$ git clone git://github.com/SYNHAK/spiff.git /usr/share/spiff/ $ cd /usr/share/spiff/ Configure your local_settings.py here $ ./manage.py syncdb –migrate

In /etc/httpd/conf.d/synhak.org.conf:

<VirtualHost *:80>
  LoadModule wsgi_module modules/mod_wsgi.so
  WSGIScriptAliasMatch ^/auth(/([^~].*)?)$ /usr/share/spiff/spiff/wsgi.py$1
  Alias /auth/static /usr/share/spiff/spiff/static
  WSGIPassAuthorization On
  WSGIDaemonProcess spiff-1 user=apache group=apache threads=25
  WSGIProcessGroup spiff-1
</VirtualHost>

That is all you need. You may then access spiff at http://your-space.org/auth/

Other information for using Django with mod_wsgi can be found at the Django mod_wsgi howto guide.