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