Mercurial > dovecot > original-hg > dovecot-1.2

comparison doc/documentation.txt @ 5441:9d36800df1ae HEAD

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added documentation to doc/wiki/. autogen.sh downloads them from dovecot.org if they don't exist. Changed wiki links in dovecot-example.conf to point to the doc/wiki/ directory instead.
author Timo Sirainen <tss@iki.fi>
date Wed, 28 Mar 2007 01:50:53 +0300
parents
children 950feba5248e
comparison
equal deleted inserted replaced
5440:d9b7957a7255 5441:9d36800df1ae
1 The documentation in wiki/ directory has been imported from
2 http://wiki.dovecot.org/. The actual Wiki may contain more up-to-date
3 information, so unless this is an old Dovecot release, you may want to use
4 the Wiki directly.
5
6 Documentation Index
7 ===================
8
9 * <QuickConfiguration.txt> for people in hurry
10 * <WhyDoesItNotWork.txt> - Why doesn't Dovecot work?
11
12 1. Welcome to the Dovecot Wiki
13 2. Dovecot Wiki Contents
14 3. Generic information about mail servers
15 4. A simple Dovecot installation
16 5. Full guide to setting up a new Dovecot installation
17 6. Examples / Scenarios
18 7. Migration from existing systems
19 8. Troubleshooting
20 9. Tuning
21 10. Reference
22 11. Misc
23
24 Generic information about mail servers
25 ======================================
26
27 * Mail protocols: IMAP [http://en.wikipedia.org/wiki/Imap], POP3
28 [http://en.wikipedia.org/wiki/Pop3] and SMTP
29 [http://en.wikipedia.org/wiki/Smtp]
30 * <Mail delivery agents and Sieve> [MDA.txt]
31 * <Mailbox formats> [MailboxFormat.txt]
32 * <User authentication> [Authentication.txt]
33 * <SASL> [Sasl.txt]
34
35 A simple Dovecot installation
36 =============================
37
38 It's a good idea to start with a simple Dovecot installation to see that
39 everything works. After that you can start changing things one at a time, so if
40 you run into trouble you know immediately where the problem is.
41
42 If you're in a hurry and you already know enough about mail servers,
43 <QuickConfiguration.txt> may be more helpful to you instead.
44
45 1. Installing
46 * <Compiling from sources> [CompilingSource.txt]
47 * <Installing prebuilt binaries> [PrebuiltBinaries.txt]
48 2. <Checking where mail is delivered to> [FindMailLocation.txt]
49 3. <Configuring Dovecot> [BasicConfiguration.txt]
50 4. <Running Dovecot> [RunningDovecot.txt]
51 5. <Logging.txt>
52 6. <Testing that everything works> [TestInstallation.txt]
53 * <Testing POP3 installation> [TestPop3Installation.txt]
54 7. <Finishing the test installation> [FinishBasicConfiguration.txt]
55
56 Full guide to setting up a new Dovecot installation
57 ===================================================
58
59 This guide assumes that you have already managed to run Dovecot successfully,
60 as described in the "A simple Dovecot installation" guide above.
61
62 * Starting guidelines
63 * <System users> [SystemUsers.txt]
64 * <Virtual users> [VirtualUsers.txt]
65 * <UNIX User IDs used by Dovecot> [UserIds.txt]
66 * <Authentication configuration> [Authentication.txt]
67 * <Password databases> [PasswordDatabase.txt]
68 * <User databases> [UserDatabase.txt]
69 * <Multiple authentication databases>
70 [Authentication.MultipleDatabases.txt]
71 * <Kerberos> [Authentication.Kerberos.txt]
72 * <Restricting users' access> [Authentication.RestrictAccess.txt]
73 * <Special authentication features> [PasswordDatabase.ExtraFields.txt]
74 * <Master users> [Authentication.MasterUsers.txt]
75 * <Mailbox location configuration> [MailLocation.txt]
76 * <Mails stored in local disk> [MailLocation.LocalDisk.txt]
77 * <Mails stored in shared filesystem> [MailLocation.SharedDisk.txt]
78 (<NFS.txt>, clustered FS)
79 * <Maildir configuration> [MailLocation.Maildir.txt]
80 * <Mbox configuration> [MailLocation.Mbox.txt]
81 * <Namespaces.txt>
82 * <Shared mailboxes> [SharedMailboxes.txt]
83 * <Login processes and their settings> [LoginProcess.txt]
84 * <SSL.txt> settings and certificate creation
85 * <Plugins.txt>
86 * <Quota.txt>
87 * <Access Control Lists> [ACL.txt] (ACLs)
88 * <Dovecot as a POP3 server> [POP3Server.txt]
89 * <Dovecot's local delivery agent> [LDA.txt]
90 * <Post-login scripting> [PostLoginScripting.txt]
91
92 Examples / Scenarios
93 ====================
94
95 See this section in http://wiki.dovecot.org/
96
97 * <Rootless installation> [Rootless.txt]
98 * <POP-before-SMTP> [PopBSMTPAndDovecot.txt]
99 * <Pop Relay Compatibility> [PopRelay.txt]
100
101 Migration from existing systems
102 ===============================
103
104 * <From other IMAP/POP3 servers> [Migration.txt]
105 * <My mailboxes are lost after migrating to Dovecot!>
106 [MissingMailboxes.txt]
107 * <Upgrading from Dovecot 0.99.x to 1.0> [UpgradingDovecot.txt]
108 * <Converting between mailbox formats> [Migration.MailFormat.txt] (mbox <->
109 Maildir, etc.)
110
111 Troubleshooting
112 ===============
113
114 * <Why doesn't Dovecot work?> [WhyDoesItNotWork.txt]
115 * <Finding the error message from logs> [Logging.txt]
116 * <Debugging authentication> [Debugging.Authentication.txt]
117 * <Process tracing> [Debugging.ProcessTracing.txt] is useful when Dovecot
118 seems slow or hangs completely
119 * <mbox errors and crashes> [MboxProblems.txt]
120 * <Client issues and configuration> [Clients.txt]
121 * <Debugging using Thunderbird's logging> [Debugging.Thunderbird.txt]
122 * Sending bug reports [http://dovecot.org/bugreport.html], debugging crashes
123 and sniffing network traffic
124
125 Tuning
126 ======
127
128 * <Performance tuning> [PerformanceTuning.txt]
129 * <Security tuning> [SecurityTuning.txt]
130 * <Chrooting.txt>
131
132 Reference
133 =========
134
135 * <Command line arguments> [CommandLine.txt]
136 * <Dovecot's design> [Design.txt]
137 * <Client issues and configuration> [Clients.txt]
138
139 Misc
140 ====
141
142 * <Listening on Additional Ports> [Iptables.txt] using IP Tables