Development

Setting Up

Clone the repository

git clone git@github.com:tildaslash/RatticWeb.git

Change into the source dir

cd RatticWeb

Make sure you have development libraries installed

sudo yum install mysql-devel openldap-devel python-devel python-virtualenv libxml2-devel libxslt-devel

On Debian based systems:

sudo aptitude install libxml2-dev libxslt-dev libldap2-dev python-virtualenv libsasl2-dev libmysqlclient-dev python-dev

Create a virtualenv for Rattic. (n.b. Don't put the virtualenv directory inside the RatticWeb directory -- this breaks the code style tests, as they process all code under the RatticWeb directory.)

virtualenv ~/venv/RatticWeb

Activate the virtualenv

source ~/venv/RatticWeb/bin/activate

Install dependencies with pip

pip install -r requirements-mysql.txt -r requirements-dev.txt

Configure Rattic

cat > conf/local.cfg <<EOF
[ratticweb]
secretkey = [ENTER SOMETHING RANDOM HERE]
debug = true

[filepaths]
help = ../RatticWeb.wiki
EOF

Confirm that your environment is working as expected

./runtests.sh

Create the database files

./manage.py syncdb

Run DB migrations

./manage.py migrate

Create a default user

./manage.py demosetup

Start the server

./manage.py runserver

Browse to http://127.0.0.1:8000/ (default credentials are admin/rattic)

Help files

Clone the help files

cd ..
git clone git@github.com:tildaslash/RatticWeb.wiki.git