nikdoof/test-auth
1
0
Fork 0
mirror of https://github.com/nikdoof/test-auth.git synced 2025-12-23 14:49:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation and requirements

Browse Source
This commit is contained in:
Andrew Williams
2012-05-20 10:52:54 +01:00
parent 474f067f06
commit 9ebacb1e13
3 changed files with 9 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README
View File

@@ -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 <ip>:<port>, 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 <ip>:<port>, 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.