aboutsummaryrefslogtreecommitdiffstats
path: root/readme.rst
blob: eb44f65a92d03f11deadf361e8b79af40a8f86ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Cute Little Innocent Mailing List
#################################

climl is a simple mailing list compatible with any server supporting imap or
lmtp. I know these two protocols are not always brought together for mailing
list management, but this mailing list can be deployed in two modes:

- client mode: In this mode you can plug the manager on any remote server
  supporting the IMAP protocol. The client will listen for incomming e-mail
  and send it to the **climl** server listenning in lmtp.

- server mode: In this mode **climl** listen in lmtp (unix socket). A MTA,
  such as postfix for example, can send mails directly to it. In this mode, we
  just do not start the client bridge.

Installation
============

Simply run this (same command for upgrading)::

    pyvenv venv-climl \
        && venv-climl/bin/pip3 install --upgrade git+git://git.devys.org/climl

Running it
==========

After creating a configuration file, you can run climl by doing a::

    venv-climl/bin/climl.py

License
=======

Unless specified otherwise, this project is licensed under the terms of the
GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version. You
should have received a copy of the GNU General Public License along with this
program. If not, see <https://opensource.org/licenses/GPL-3.0> or
<http://www.gnu.org/licenses/>.

SPDX-License-Identifier: GPL-3.0+

Copyright © 2016 vg <vg@devys.org>

Contact
=======

developer
    vg

mail
    vg@devys.org