Commit d183023e authored by Baptiste Jonglez's avatar Baptiste Jonglez
Browse files

Reorganise the quickstart section in README

parent d5fd872e
......@@ -39,8 +39,11 @@ This user account has access to the administration interface.
Get yourself a virtualenv. On Debian, install `python-virtualenv`. On
Archlinux, the package is called `python2-virtualenv`, and you must
Using a virtualenv is recommended. On Debian, install `python-virtualenv`.
On Archlinux, the package is called `python2-virtualenv`, and you must
replace the `virtualenv` command with `virtualenv2` in the following.
To create the virtualenv (the first time):
......@@ -69,6 +72,9 @@ You may experience problems with SSL certificates du to self-signed cert used by
You should now be able to run `python` (within the
virtualenv, obviously) without error.
The `coin/` file is ignored by Git: feel free to override any
setting by writing into that file. For example, to override the `DEBUG`
......@@ -76,14 +82,24 @@ settings:
echo '# -*- coding: utf-8 -*-' > coin/
echo 'DEBUG = TEMPLATE_DEBUG = True' >> coin/
At this point, you should setup your database. Recommended is postgreSQL,
but you might be able to use SQLite. For more information, see
If you don't want to use LDAP, just set in your ``:
See the end of this README for a reference of available configuration settings.
At this point, you should setup your database: we highly recommend PostgreSQL.
SQLite might work, but some features will not be available:
- automatic allocation of IP subnet
For more information on the database setup, see:
The first time, you need to create the database, create a superuser, and
import some base data to play with:
......@@ -95,8 +111,10 @@ Note that the superuser will be inserted into the LDAP backend exactly in the
same way as all other members, so you should use a real account (not just
Then, at each code update, you only need to apply migrations:
Then, at each code update, you will only need to update dependencies and apply
new migrations:
pip install -r requirements.txt
python migrate
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment