documentation.txt revision 0992011130e9d0a498ca860ddbe4028398a530c5
0N/AThe documentation in wiki/ directory has been imported from
0N/Ahttp://wiki2.dovecot.org/. The actual Wiki may contain more up-to-date
0N/Ainformation, so unless this is an old Dovecot release, you may want to use
0N/Athe Wiki directly.
0N/A
0N/ADocumentation Index
0N/A===================
0N/A
0N/A * <QuickConfiguration.txt> for people in hurry
0N/A * <WhyDoesItNotWork.txt> - Why doesn't Dovecot work?
0N/A
0N/A 1. Welcome to the Dovecot Wiki
0N/A 2. Dovecot Wiki Contents
0N/A 3. Generic information about mail servers
0N/A 4. Dovecot installation
0N/A 5. Dovecot configuration
0N/A 6. HOWTOs, examples and tutorials
0N/A 7. Migration from existing systems
0N/A 8. Troubleshooting
0N/A 9. Tuning
0N/A 10. Reference
0N/A 11. Misc
0N/A
0N/AGeneric information about mail servers
0N/A======================================
0N/A
0N/A * Mail protocols: IMAP [http://en.wikipedia.org/wiki/Imap], POP3
0N/A [http://en.wikipedia.org/wiki/Pop3] and SMTP
0N/A [http://en.wikipedia.org/wiki/Smtp]
0N/A * <Mail delivery agents and Sieve> [MDA.txt]
0N/A * <Mailbox formats> [MailboxFormat.txt]
0N/A * <Dovecot's index files> [IndexFiles.txt]
0N/A * <User authentication> [Authentication.txt]
0N/A * <SASL> [Sasl.txt]
0N/A
0N/ADovecot installation
0N/A====================
0N/A
0N/AIt's a good idea to start with a simple Dovecot installation to see that
0N/Aeverything works. After that you can start changing things one at a time, so if
0N/Ayou run into trouble you know immediately where the problem is.
0N/A
0N/AIf you're in a hurry and you already know enough about mail servers,
0N/A<QuickConfiguration.txt> may be more helpful to you instead.
0N/A
0N/A 1. Installing
0N/A * <Compiling from sources> [CompilingSource.txt]
0N/A * <Installing prebuilt binaries> [PrebuiltBinaries.txt]
0N/A 2. <Checking where mail is delivered to> [FindMailLocation.txt]
0N/A 3. <Configuring Dovecot> [BasicConfiguration.txt]
0N/A 4. <Running Dovecot> [RunningDovecot.txt]
0N/A 5. <Logging.txt>
0N/A 6. <Testing that everything works> [TestInstallation.txt]
0N/A * <Testing POP3 installation> [TestPop3Installation.txt]
0N/A 7. <Finishing the test installation> [FinishBasicConfiguration.txt]
0N/A
0N/ADovecot configuration
0N/A=====================
0N/A
0N/A * Starting guidelines
0N/A * <System users> [SystemUsers.txt]
0N/A * <Virtual users> [VirtualUsers.txt]
0N/A * <UNIX User IDs used by Dovecot> [UserIds.txt]
0N/A * <Authentication configuration> [Authentication.txt]
0N/A * <Password databases> [PasswordDatabase.txt]
0N/A * <User databases> [UserDatabase.txt]
0N/A * <Multiple authentication databases>
0N/A [Authentication.MultipleDatabases.txt]
0N/A * <Kerberos> [Authentication.Kerberos.txt]
0N/A * <Restricting users' access> [Authentication.RestrictAccess.txt]
0N/A * <Special authentication features> [PasswordDatabase.ExtraFields.txt]
0N/A * <Master users> [Authentication.MasterUsers.txt]
0N/A * <Mailbox location configuration> [MailLocation.txt]
0N/A * <Mails stored in local disk> [MailLocation.LocalDisk.txt]
0N/A * <Mails stored in shared filesystem> [MailLocation.SharedDisk.txt]
0N/A (<NFS.txt>, clustered FS)
0N/A * <Maildir configuration> [MailLocation.Maildir.txt]
0N/A * <Mbox configuration> [MailLocation.Mbox.txt]
0N/A * <Namespaces.txt>
0N/A * <Shared mailboxes> [SharedMailboxes.txt]
0N/A * <Login processes and their settings> [LoginProcess.txt]
0N/A * <SSL.txt> settings and certificate creation
0N/A * <Plugins.txt>
0N/A * <Quota.txt>
0N/A * <Access Control Lists> [ACL.txt] (ACLs)
0N/A * <Dovecot as a POP3 server> [POP3Server.txt]
0N/A * <Dovecot's local delivery agent> [LDA.txt]
0N/A * <Post-login scripting> [PostLoginScripting.txt]
0N/A
0N/AHOWTOs, examples and tutorials
0N/A==============================
0N/A
0N/ASome HOWTOs haven't been included in wiki/. Use http://wiki2.dovecot.org/
0N/Ainstead.
0N/A
0N/A * <HOWTOs, examples and tutorials> [HowTo.txt] for different installations
0N/A * Existing Dovecot installations
0N/A [http://wiki2.dovecot.org/DovecotServerInstallations]
0N/A
0N/AMigration from existing systems
0N/A===============================
0N/A
0N/A * <From other IMAP/POP3 servers> [Migration.txt]
0N/A * <My mailboxes are lost after migrating to Dovecot!>
0N/A [MissingMailboxes.txt]
0N/A * <Upgrading from Dovecot 0.99.x to 1.0> [UpgradingDovecot.txt]
0N/A * <Converting between mailbox formats> [Migration.MailFormat.txt] (mbox <->
0N/A Maildir, etc.)
0N/A
0N/ATroubleshooting
0N/A===============
0N/A
0N/A * <Why doesn't Dovecot work?> [WhyDoesItNotWork.txt]
0N/A * <Finding the error message from logs> [Logging.txt]
0N/A * <Debugging authentication> [Debugging.Authentication.txt]
0N/A * <Process tracing> [Debugging.ProcessTracing.txt] is useful when Dovecot
0N/A seems slow or hangs completely
0N/A * <mbox errors and crashes> [MboxProblems.txt]
0N/A * <Client issues and configuration> [Clients.txt]
0N/A * <Negative UIDs / message sets> [Clients.NegativeUIDs.txt]
0N/A * <Debugging using Thunderbird's logging> [Debugging.Thunderbird.txt]
0N/A * <"Time moved backwards" error> [TimeMovedBackwards.txt]
0N/A * Sending bug reports [http://dovecot.org/bugreport.html], debugging crashes
0N/A and sniffing network traffic
0N/A
0N/ATuning
0N/A======
0N/A
0N/A * <Performance tuning> [PerformanceTuning.txt]
0N/A * <Security tuning> [SecurityTuning.txt]
0N/A * <Chrooting.txt>
0N/A
0N/AReference
0N/A=========
0N/A
0N/A * <Command line arguments> [CommandLine.txt]
0N/A * <Dovecot's design> [Design.txt]
0N/A * <Client issues and configuration> [Clients.txt]
0N/A
0N/AMisc
0N/A====
0N/A
0N/A * <Listening on Additional Ports> [Iptables.txt] using IP Tables or socat
0N/A