|Baptiste Jonglez 002dc0fff7 Add a Django command for dumping the email address of all subscribers||3 years ago|
|coin||3 years ago|
|contrib||3 years ago|
|simple_dsl||4 years ago|
|.gitignore||4 years ago|
|DEPLOYMENT.md||3 years ago|
|EXTENDING.md||4 years ago|
|README.md||3 years ago|
|manage.py||5 years ago|
|requirements.txt||3 years ago|
Coin is Illyse's Information System, designed to manage both members
and Internet accesses, such as through DSL, VPN, wireless…
It is written in Django, and features a generic configuration interface, which allows to implement custom backends for different technologies. Currently implemented is a LDAP-based backend for OpenVPN, and a very simple DSL backend, without any authentication (useful for "white label" DSL).
Coin currently only works with python2, because
python-ldap is (as of
2013) not compatible with python3.
The project page (issue, wiki, etc) is here:
A mailing list is available, for both users and developers: https://listes.illyse.org/wws/info/si
A demo of COIN is publicly available at:
Login: ffdn Password: internet
This user account has access to the administration interface.
If you want to write your own backend, see
Using a virtualenv is recommended. On Debian, install
On Archlinux, the package is called
python2-virtualenv, and you must
virtualenv command with
virtualenv2 in the following.
To create the virtualenv (the first time):
To activate the virtualenv (you need to do this each time you work on the project):
Install dependencies. On Debian, you will probably need the
sudo apt-get install python-dev python-pip libldap2-dev libpq-dev libsasl2-dev
pip install -r requirements.txt
You may experience problems with SSL certificates du to self-signed cert used by code.ffdn.org. You can temporarily disable certificate verification in git : git config --global http.sslVerify false
You should now be able to run
python manage.py (within the
virtualenv, obviously) without error.
coin/settings_local.py file is ignored by Git: feel free to override any
setting by writing into that file. For example, to override the
echo '# -*- coding: utf-8 -*-' > coin/settings_local.py echo 'DEBUG = TEMPLATE_DEBUG = True' >> coin/settings_local.py
If you don't want to use LDAP, just set in your
LDAP_ACTIVATE = False
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:
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:
python manage.py migrate python manage.py createsuperuser python manage.py loaddata offers ip_pool
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 admin/admin).
Then, at each code update, you will only need to update dependencies and apply new migrations:
pip install -r requirements.txt python manage.py migrate
At this point, Django should run correctly:
python manage.py runserver
Some useful administration commands are available via
python manage.py members_email: returns email addresses of all members, one
per line. This may be useful to automatically feed a mailing list software.
Note that membership is based on the
status field of users, not on
membership fees. That is, even if a member has forgot to renew his or her
membership fee, his or her address will still show up in this list.
python manage.py charge_subscriptions: generate invoices (including a
PDF version) for each subscriber. You probably want to run this command
every month as a cron task, see below.
python manage.py call_for_membership_fees: send reminder emails to members
whose membership fee is about to expire or is already expired (1 month before,
on the day of expiration, 1 month after, 2 months after, and 3 months after).
You should run this command in a cron job every day.
You should first setup the
sites application, in the admin. The domain name
configured there is used for outgoing emails.
By default, LDAP support is disabled. If you want to use LDAP (for
instance for the OpenVPN/LDAP backend, or for your own backend), see the
The main place to customize Coin for your ISP is the IspDatabase application, in the admin. Information entered in this application has two purposes:
1) generate a JSON file usable by http://db.ffdn.org/
2) customize the user interface (postal address, bank account, ISP name & logo...)
Some bits of configuration are done in
settings.py: LDAP branches, RSS feeds
to display on the home page, and so on.
You may want to run cron jobs for repetitive tasks.
The command that generates invoices should be run every day, so that invoices for new subscriptions are created automatically. On the first day of each month, invoices will be generated for all subscriptions. This will run the command at 23:59 every day:
59 23 * * * /home/coin/venv/bin/python manage.py charge_subscriptions`
To send reminder emails for membership fee expiration:
42 3 * * * /home/coin/venv/bin/python manage.py call_for_membership_fees`
If you want to be notified by email each time a reminder email is sent, you can set an email address in the crontab:
For the rest of the setup (database, LDAP), see
For real production deployment, see file