Updated README

This commit is contained in:
Éloi Rivard 2020-11-13 11:15:17 +01:00
parent 6a160b1147
commit 49cfdc31b2
2 changed files with 17 additions and 7 deletions

View file

@ -20,10 +20,17 @@ It aims to be very light, simple to install and simple to maintain. Its main fea
<img src="doc/_static/consent.png" width="225" alt="Canaille" />
</div>
# Try it!
```bash
cd demo
./run.sh
```
# Documentation
⚠ Canaille is under heavy development and may not fit a production environment yet. ⚠
- Please have a look on our [documentation](https://canaille.readthedocs.io);
- To **install** canaille, just follow the [installation guide](https://canaille.readthedocs.io/en/latest/install.html);
- To **contribute** canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/contributing.html).
- To **contribute** to canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/contributing.html).

View file

@ -1,15 +1,18 @@
#!/bin/bash
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
if ! type python > /dev/null 2>&1; then
echo "Cannot start the LDAP server. Please install python on your system."
return -1
fi
if ! test -d env; then
virtualenv env
env/bin/pip install --editable ..
env/bin/pip install honcho requests
env/bin/pip install --upgrade git+https://github.com/python-ldap/python-ldap.git
if ! test -d "$DIR/env"; then
virtualenv "$DIR/env"
$DIR/env/bin/pip install --editable "$DIR/.."
$DIR/env/bin/pip install honcho requests
$DIR/env/bin/pip install --upgrade git+https://github.com/python-ldap/python-ldap.git
fi
env/bin/honcho start
env "PWD=$DIR" $DIR/env/bin/honcho start