inboxen

Inboxen

This is the complete system with everything you need to set up Inboxen. Please use the "deploy" branch if you wish to use this in production - "master" sometimes breaks!

Join us in our IRC channel! We're in the #inboxen channel on MegNet

See also: https://etherpad.mozilla.org/inboxen

Developing

Set yourself up with a virtual environment and run the following:

git clone https://github.com/Inboxen/Inboxen.git
cd Inboxen
pip install -r requirements-dev.txt

When you've made your changes, remember to run flake8 against Python files you've changed and run unit tests. To run the tests, do the following:

DB=sqlite python manage.py test --settings=inboxen.tests.settings

Deploying

Set yourself up with a virtual environment and run the following:

git clone https://github.com/Inboxen/Inboxen.git
cd Inboxen
# optional step
#git checkout deploy
pip install -r requirements.txt

After this has completed, see the next section on minimum configuration. Also, settings.py is well commented and explains what various configuration options do.

settings.ini

At the very least, this file should contain the following:

[general]
secret_key = some_random_string

Where some_random_string is a long (at least a length of 50) string, containing random characters.

Webserver

The WSGI script can be found at website/wsgi.py

If your WSGI daemon supports it (e.g. mod_wsgi), we provide an "import script" to improve performance for the first request after a reload. It can be found at website/importscript.py

There is also website/admin-wsgi.py - this enables the admin interface on /admin. It is highly recommended that you protect from the outside world. Solutions such as a VPN are probably the easiest for your staff to use.

Collecting Static Files

Remember to run python manage.py collectstatic!