From 9ebacb1e1333caaeec44dffe8c1485e59d1cb817 Mon Sep 17 00:00:00 2001 From: Andrew Williams Date: Sun, 20 May 2012 10:52:54 +0100 Subject: [PATCH] Update documentation and requirements --- LICENSE | 7 +------ README | 40 ++++++---------------------------------- requirements.txt | 4 ++-- 3 files changed, 9 insertions(+), 42 deletions(-) diff --git a/LICENSE b/LICENSE index dc27802..d808fa0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,9 +1,4 @@ -Auth is officially ISKware/Beerware. - -You are free to copy, modify and use this software as you see fit, as long as -you give attribution to TEST Alliance for the software. If you find this -useful then please consider tipping the following people some beer money or -ISKies for exotic dancers. +This software should be classified as all rights reserved, you may not redistribute the source or applications to any other parties, or use its code as the basis for any further development outside of Test Alliance Please Ignore. Main Developers: diff --git a/README b/README index a45360d..75b7ba9 100644 --- a/README +++ b/README @@ -1,44 +1,16 @@ REQUIREMENTS ------------ -Use ./setup-env.sh to setup the virtualenv for Auth, you'll also need the following packages (as named on Debian): +The requirements.txt covers all dependencies for Auth, setup a virtual env and install the requirements: -python-zeroc-ice (ZeroC ICE Bindings for Python, only needed if you are using Mumble connecitivty) -python-imaging (PIL) -python-mysqldb (MySQL connectors for Python) -python-crypto (SSL and related stuff for Django) -python-virtualenv (distribute enabled version) -python-distribute +virtualenv env +. env/bin/activate +pip install -r requirements.txt -Also you'll need a working RabbitMQ install, and your database software of choice. - -RABBITMQ SETUP --------------- - -The fabric config has all the options to auto configure this for you, just give sudo access to /usr/sbin/rabbitmqctl to -your user. - -VIRTUALENV SETUP ----------------- - -Most of Auth's dependancies are pulled through Virtualenv, to setup the enviroment use the ./setup-env.sh script. +As we're using system wide packages, its advisable to install python-mysql packages system wide, otherwise you'll need a basic build env on your machine (build-essentials, python-dev on Debian). RUNNING ------- -For live envs, use ./start.sh, which runs a FCGI instance on port 9981. +For dev, use ./manage.py runserver :, after loading the virtualenv. In development Celery will operate in-process and doesn't require a seperate celeryd process to execute. -For dev, use ./manage.py runserver :, after loading the virtualenv. Load a seperate shell and start the Celery -work processor with ./manage.py celeryd - -DB SETUP --------- - -Copy over dbsettings.py.example and modify to your needs. - - -MUMBLE SETUP ------------- - -If you are using the Mumble SSO connector, then please copy over your Murmur.ice file to the root of the directory, if this -doesnt match the current running Mumble server it'll cause a world of pain. diff --git a/requirements.txt b/requirements.txt index 43a8b54..54039b4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -8,7 +8,7 @@ MySQL-python Celery==2.5.3 django-celery==2.5.5 --e hg+http://bitbucket.org/schinckel/django-jsonfield#egg=django-jsonfield +django-jsonfield==0.8.7 South==0.7.4 django-redis-cache IPy==0.75 @@ -17,7 +17,7 @@ sentry==4.0.15 raven==1.7.3 nexus -gargoyle==0.8.0 +gargoyle==0.9.0 -e hg+https://bitbucket.org/jespern/django-piston@7c90898072ce#egg=django_piston -e hg+https://bitbucket.org/ubernostrum/django-registration@27bccd108cde#egg=django-registration