Project

General

Profile

Main » History » Version 22

Thomas Capricelli, 11/07/2013 12:21 AM

1 9 Thomas Capricelli
{{toc}}
2
3 20 Thomas Capricelli
!colibri_logo_small.png!
4 8 Thomas Capricelli
5 16 Thomas Capricelli
Colibri is a "free software":http://en.wikipedia.org/wiki/Free_software (GPL) used to handle mailing lists. It does the same task as "GNU mailman":http://en.wikipedia.org/wiki/GNU_Mailman or "majordomo":http://en.wikipedia.org/wiki/Majordomo_(software), but in a somewhat more modern way.
6 1 Thomas Capricelli
7 10 Thomas Capricelli
Those features are already present:
8 13 Thomas Capricelli
* web interface for browsing lists, (un)subscribing, changing user preferences, changing list preferences (for list admin),  creating mailing lists.
9
* handle multiple domains, so far as you can make them delivered on the computer running the daemon 
10
* handle multiple emails for an account. All need to be validated through a link send to the email.
11
* display of archives, public or not, with attachments.
12 10 Thomas Capricelli
* tagging of output mails ( adding [mylist] in the subject, only if not already present)
13
* scale from one list (simple interface) to huge site with lot of lists sorted by topics, all with descriptions and such.
14 13 Thomas Capricelli
* the web interface is easy to adapt, for better integration with existing sites. You only need to change few files, using django templates.
15 15 Thomas Capricelli
* import configuration, subscribers list and archive from "sympa":http://en.wikipedia.org/wiki/Sympa
16 10 Thomas Capricelli
17
Those features are not yet implemented, but planned
18
* (un)subscribe or getting help by mail
19 21 Thomas Capricelli
* import configuration and subscribers list from "mailman":http://en.wikipedia.org/wiki/Mailman_%28GNU%29
20 1 Thomas Capricelli
* moderation of emails
21 2 Thomas Capricelli
* handling of bounces from the web interface
22
23 14 Thomas Capricelli
Here's an example of a page from the web interface:
24
25
!myaccount.png!
26 6 Thomas Capricelli
27 1 Thomas Capricelli
See some more [[screenshots]].
28
29 13 Thomas Capricelli
h1. Information for system administrators
30 1 Thomas Capricelli
31
Colibri is written on "python":http://www.python.org and is based on the "django":http://www.djangoproject.com "ORM":http://en.wikipedia.org/wiki/Object-relational_mapping. This means you'll need python and "django":http://www.djangoproject.com on the server.
32 2 Thomas Capricelli
33 22 Thomas Capricelli
You do not need to use the web front-end, but if you do, you'll need some way to make your web server execute python code (typically this means using "gunicorn":http://gunicorn.org, but there are "numerous other ways":http://docs.djangoproject.com/en/1.6/howto/deployment ).
34 1 Thomas Capricelli
35 3 Thomas Capricelli
First read the [[Technical summary of colibri]].
36 1 Thomas Capricelli
37
Then there are the detailed notes about [[installing colibri]].
38
39 18 Thomas Capricelli
You might also be interested in the preliminary support for [[importing from sympa]].
40 1 Thomas Capricelli
41 13 Thomas Capricelli
h1. Information for developers
42 3 Thomas Capricelli
43 1 Thomas Capricelli
Colibri is written in "python":http://www.python.org, and makes heavy use of both django "ORM":http://en.wikipedia.org/wiki/Object-relational_mapping and the "email package":http://docs.python.org/library/email.html of python.
44 4 Thomas Capricelli
45 3 Thomas Capricelli
The web interface is made on top of "django":http://www.djangoproject.com
46 1 Thomas Capricelli
47
First read the [[Technical summary of colibri]].
48 13 Thomas Capricelli
49
50
h1. Information for users
51
52 22 Thomas Capricelli
The documentation for end-users is not yet written. Though, there's not much to say. Users can subscribe/unsubscribe and check their information on the web in addition to what you can usually do with a mailing list server.
53 21 Thomas Capricelli
54
h1. Development Source code
55
56
We recommend to use the released tarballs for production sites (available on the "file" tab at the top of this page). But if you want to follow the development version, the source code is available on http://sources.freehackers.org/Colibri/
57
58
This is also a mercurial repository that you can clone and update :
59
@hg clone http://sources.freehackers.org/Colibri/@