summaryrefslogtreecommitdiff
path: root/doc/OLD/README
blob: ec630b3fc52d675740a4f39506da1e7329c7ed67 (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
This documentation is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 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, write to the Free Software
Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.

=========================================================================

Welcome to Binc IMAP! This is the documentation for v1.3.4.

The is an unstable development version, and it is not recommended for
production systems.

Here is a quick guide on how to setup IMAP on your system.

You can also check out the project home page's FAQ and the Life With
Binc IMAP community documentation site:

http://www.bincimap.org/
http://www.lifewithbincimap.org/

Binc IMAP requires OpenSSL - http://www.openssl.org/, for SSL support.

Installation instructions
-------------------------

Installing Binc IMAP is easy! View the options by passing --help to the
configure script. Here's how to install the server using default options.  Log
in as root on your machine, then:

# ./configure
# make
# make install

Binc IMAP's "make install" stage tells you exactly where all files are copied.
To uninstall, type "make uninstall".

Configuring the server
----------------------

You need to figure out one thing before you start using the server. Binc IMAP
doesn't run as a standalone TCP server. It relies on a TCP wrapper, like
xinetd, inetd or tcpserver.

   1) I will be using xinetd.
      - This is the recommended default. If you don't know what the other
        options are about, then this is definitely the way to go. Just
        make sure that xinetd is installed on your server.

   2) I will be using svscan / tcpserver
      - Before anything, make sure that logging works with multilog.

   3) I will need to use another TCP wrapper.
      - You should be able to figure out how to run Binc IMAP by looking
        at the bundled xinetd and daemontools files. Otherwise, see if the
        community pages can help you along the way. Or post a message to
        the mailing list.

Configuring Binc IMAP is easy! Simply locate your config file called
"bincimap-config". It was installed as part of the "make install" stage.  Edit
this file. It contains reasonable defaults, but it should be easy enough to
understand what you'd need to change.

NOTE: tcpserver users, make sure LOG_TYPE is set to "multilog" if you prefer
      using multilog.

Choose your depot setting with care. The default depot, IMAPdir, is always
best for fresh installs. If you're upgrading from a Courier-IMAP server, the
Maildir++ depot will give you a smoother transition. You should still aim at
moving to IMAPdir. For more on depots (or if you don't know what a depot is in
this setting), see README.DEPOT.

Check the SSL settings. See also README.SSL for more on generating an SSL
certificate and key.

Starting the server
-------------------

This assumes you used /usr/local as prefix when you installed Binc IMAP.

1) xinetd users:

  a) Create a symlink from /usr/local/etc/xinetd-bincimap to /etc/xinetd.d/imap.
  b) Create a symlink from /usr/local/etc/xinetd-bincimaps to /etc/xinetd.d/imaps.
  c) Restart xinetd.

2) svscan users:

  a) Create a symlink from /usr/local/share/service/bincimap to /service/imap.
  b) Create a symlink from /usr/local/share/service/bincimaps to /service/imaps.

The server should be available immediately.

Happy IMAPing! With these settings your copy of Binc IMAP should be
operational.  For more information, please check out the man pages and
FAQ.
                                                   Andy :-)

=========================================================================
Tell us what you think about this server! Post any problems, remarks
or comments to:

The Binc IMAP mailing list <binc@bincimap.org>
The Binc IMAP Developers' mailing list <binc-dev@bincimap.org>

Author: Andreas Aardal Hanssen <andreas-binc@bincimap.org>