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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installing Cyrus — Cyrus IMAP 3.6.1 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/cyrus.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/>
<link rel="search" title="Search" href="../search.html"/>
<link rel="top" title="Cyrus IMAP 3.6.1 documentation" href="../index.html"/>
<link rel="up" title="Setup" href="../setup.html"/>
<link rel="next" title="HTTP modules" href="download/installation/manage-dav.html"/>
<link rel="prev" title="Compiling" href="developer/compiling.html"/>
</head>
<body class="wy-body-for-nav" role="document">
<div class="pageheader">
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../download.html">Download</a></li>
<li><a href="../contribute.html">Contribute</a></li>
<li><a href="../support.html">Support</a></li>
<li><a href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li>
</ul>
<div>
<a href="../index.html">
<h1>Cyrus IMAP</h1>
<!-- <img src="../_static/logo.gif" alt="CYRUS" /> -->
</a>
</div>
</div>
<div style="clear: both;"></div>
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="../index.html">
<h1>Cyrus IMAP</h1>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Cyrus IMAP</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../download.html">Download</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download/getcyrus.html">Get Cyrus</a><ul>
<li class="toctree-l3"><a class="reference internal" href="download/getcyrus.html#distribution-package">Distribution Package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/installation/distributions/centos.html">CentOS</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/installation/distributions/debian.html">Debian</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/installation/distributions/fedora.html">Fedora</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/installation/distributions/opensuse.html">openSUSE</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/installation/distributions/rhel.html">Red Hat Enterprise Linux</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/installation/distributions/ubuntu.html">Ubuntu</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="download/getcyrus.html#build-and-install-yourself">Build and Install Yourself</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/getcyrus.html#use-a-release-packaged-tarball">Use a release packaged tarball</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/getcyrus.html#use-the-source-from-git">Use the source from Git</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="download/getcyrus.html#external-tools">External Tools</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/getcyrus.html#licensing">Licensing</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="download/release-notes/index.html">Release Notes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="download/release-notes/index.html#stable-version">Stable Version</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/release-notes/index.html#development-version">Development Version</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/release-notes/index.html#supported-product-series">Supported Product Series</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/index.html#series-3-6">Series 3.6</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/index.html#series-3-4">Series 3.4</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/index.html#series-3-2">Series 3.2</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/index.html#series-3-0">Series 3.0</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/index.html#series-2-5">Series 2.5</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="download/release-notes/index.html#development-snapshots">Development snapshots</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/3.7/index.html">Cyrus IMAP 3.7 Tags</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/3.5/index.html">Cyrus IMAP 3.5 Tags</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/3.3/index.html">Cyrus IMAP 3.3 Tags</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/3.1/index.html">Cyrus IMAP 3.1 Tags</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="download/release-notes/index.html#older-versions">Older Versions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/index.html#series-1">Series 1</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/release-notes/index.html#series-2-2-0-2-4">Series 2: 2.0 - 2.4</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="download/packagers.html">Notes for Packagers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="download/packagers.html#binary-naming">Binary naming</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/packagers.html#sample-configuration-files">Sample configuration files</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/packagers.html#predefined-configurations">Predefined configurations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/packagers.html#the-configuration-file-for-master-cyrus-conf">The configuration file for master: cyrus.conf</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/packagers.html#the-configuration-file-for-the-various-programs-imapd-conf">The configuration file for the various programs: imapd.conf</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="download/packagers.html#services-in-etc-services">Services in <code class="docutils literal notranslate"><span class="pre">/etc/services</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../quickstart.html">Quickstart Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quickstart/introduction.html">Introduction to Cyrus IMAP</a><ul>
<li class="toctree-l3"><a class="reference internal" href="quickstart/introduction.html#what-is-imap">What is IMAP?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html#quick-install">Quick install</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../quickstart.html#install-cyrus-package-s">1. Install Cyrus package(s)</a></li>
<li class="toctree-l3"><a class="reference internal" href="../quickstart.html#setup-the-cyrus-mail-user-and-group">2. Setup the cyrus:mail user and group</a></li>
<li class="toctree-l3"><a class="reference internal" href="../quickstart.html#setting-up-authentication-with-sasl">3. Setting up authentication with SASL</a></li>
<li class="toctree-l3"><a class="reference internal" href="../quickstart.html#setup-mail-delivery-from-your-mta">4. Setup mail delivery from your MTA</a></li>
<li class="toctree-l3"><a class="reference internal" href="../quickstart.html#protocol-ports">5. Protocol ports</a></li>
<li class="toctree-l3"><a class="reference internal" href="../quickstart.html#configuring-cyrus">6. Configuring Cyrus</a></li>
<li class="toctree-l3"><a class="reference internal" href="../quickstart.html#launch-cyrus">7. Launch Cyrus</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../overview.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="concepts/features.html">Features</a><ul>
<li class="toctree-l3"><a class="reference internal" href="concepts/features.html#security-and-authentication">Security and Authentication</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/authentication-kerberos.html">Kerberos Authentication</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/authentication-ldap.html">LDAP Authentication</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/authentication-sql.html">SQL Authentication</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/access-control.html">Access Control</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/sealed-system.html">Sealed System Design</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/features.html#mailbox-management">Mailbox Management</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/automatic-creation-of-mailboxes.html">Automatic Creation of Mailboxes</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/namespaces.html">Mailbox Namespaces</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/virtual-domains.html">Virtual Domains</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/mailbox-annotations.html">Mailbox Annotations (METADATA)</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/mailbox-distribution.html">Mailbox Distribution</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/features.html#message-management">Message Management</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/delayed-delete.html">Delayed Delete</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/delayed-expunge.html">Delayed Expunge</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/message-annotations.html">Message Annotations (METADATA)</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/duplicate-message-delivery-suppression.html">Duplicate Message Delivery Suppression</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/shared-seen-state.html">Shared Seen State</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/server-side-filtering.html">Server Side Filtering (Sieve)</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/event-notifications.html">Event Notifications</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/features.html#calendar-and-contact-dav-collection-management">Calendar and Contact (DAV) Collection Management</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/caldav-collections.html">CalDAV Collections</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/dav-components.html">DAV Components</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/dav-collection-mgmt.html">DAV Collection Management</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/carddav.html">CardDAV Support</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/features.html#storage">Storage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/mail-spool-partitions.html">Mail Spool Partitions</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/mailbox-metadata-partitions.html">Mailbox Metadata Partitions</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/archiving.html">Archiving</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/quota.html">Quota</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/single-instance-store.html">Single-Instance Store</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/features.html#load-management">Load Management</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/features/server-aggregation.html">Cyrus IMAP Murder (Server Aggregation)</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="concepts/overview_and_concepts.html">Concepts</a><ul>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#access-control-lists">Access Control Lists</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#working-with-acls">Working with ACLs</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#sample-acl">Sample ACL</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#access-rights">Access Rights</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#access-control-defaults">Access Control Defaults</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#access-control-identifier-aci">Access Control Identifier (ACI)</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#negative-rights">Negative Rights</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#calculating-a-users-rights">Calculating a Users’ Rights</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#login-authentication">Login Authentication</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#anonymous-login">Anonymous Login</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#plaintext-authentication">Plaintext Authentication</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#kerberos-logins">Kerberos Logins</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#shared-secrets-logins">Shared Secrets Logins</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#quotas">Quotas</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#working-with-quotas">Working with Quotas</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#monitor-and-repair">Monitor and Repair</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#supported-quota-types">Supported Quota Types</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#quota-roots">Quota Roots</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#controlling-quota-behavior">Controlling Quota Behavior</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#mail-delivery-behavior">Mail Delivery Behavior</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#quota-warnings-upon-select-when-user-has-d-rights">Quota Warnings Upon Select When User Has <code class="docutils literal notranslate"><span class="pre">d</span></code> Rights</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#quotas-and-partitions">Quotas and Partitions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#new-mail-notification">New Mail Notification</a></li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#partitions">Partitions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#specifying-partitions-with-create">Specifying Partitions with “create”</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#changing-partitions-with-rename">Changing Partitions with “rename”</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#news">News</a></li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#pop3-server">POP3 Server</a></li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#the-syslog-facility">The syslog facility</a></li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#mail-directory-recovery">Mail Directory Recovery</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#reconstructing-mailbox-directories">Reconstructing Mailbox Directories</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#reconstructing-the-mailboxes-file">Reconstructing the Mailboxes File</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#reconstructing-quota-roots">Reconstructing Quota Roots</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#removing-quota-roots">Removing Quota Roots</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#subscriptions">Subscriptions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#configuration-directory">Configuration Directory</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#log-directory">Log Directory</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#proc-directory">Proc Directory</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#message-delivery">Message Delivery</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#local-mail-transfer-protocol-lmtp">Local Mail Transfer Protocol (lmtp)</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#single-instance-store">Single Instance Store</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/overview_and_concepts.html#duplicate-delivery-suppression">Duplicate Delivery Suppression</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#sieve-a-mail-filtering-language">Sieve, a Mail Filtering Language</a></li>
<li class="toctree-l3"><a class="reference internal" href="concepts/overview_and_concepts.html#cyrus-murder-the-imap-aggregator">Cyrus Murder, the IMAP Aggregator</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../setup.html">Setup</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="developer/compiling.html">Compiling</a><ul>
<li class="toctree-l3"><a class="reference internal" href="developer/compiling.html#setting-up-dependencies">Setting up dependencies</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/compiling.html#required-build-dependencies">Required Build Dependencies</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/compiling.html#build-dependencies-for-additional-functionality">Build dependencies for additional functionality</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer/compiling.html#compile-cyrus">Compile Cyrus</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/compiling.html#default-build-mail-only">Default build: mail only</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/compiling.html#optional-dependencies">Optional dependencies</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/compiling.html#compile">Compile</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/compiling.html#check">Check</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Installing Cyrus</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#install-cyrus">Install Cyrus</a></li>
<li class="toctree-l3"><a class="reference internal" href="#optional-components">Optional Components</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/installation/manage-dav.html">HTTP modules</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/installation/virus.html">Virus Scanner</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#setting-up-syslog">Setting up syslog</a></li>
<li class="toctree-l3"><a class="reference internal" href="#create-cyrus-environment">Create Cyrus environment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#set-up-the-cyrus-mail-user-and-group">Set up the cyrus:mail user and group</a></li>
<li class="toctree-l4"><a class="reference internal" href="#authentication-with-sasl">Authentication with SASL</a></li>
<li class="toctree-l4"><a class="reference internal" href="#mail-delivery-from-your-mta">Mail delivery from your MTA</a></li>
<li class="toctree-l4"><a class="reference internal" href="#protocol-ports">Protocol ports</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cyrus-config-files">Cyrus config files</a></li>
<li class="toctree-l4"><a class="reference internal" href="#optional-setting-up-tls-certificates">Optional: Setting up TLS certificates</a></li>
<li class="toctree-l4"><a class="reference internal" href="#prepare-ephemeral-run-time-storage-directories">Prepare ephemeral (run-time) storage directories</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#launch-cyrus">Launch Cyrus</a></li>
<li class="toctree-l3"><a class="reference internal" href="#send-a-test-email">Send a test email</a></li>
<li class="toctree-l3"><a class="reference internal" href="#checking-carddav-and-caldav">Checking CardDAV and CalDAV</a></li>
<li class="toctree-l3"><a class="reference internal" href="#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="download/upgrade.html">Upgrading to 3.6</a><ul>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#preparation">1. Preparation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="download/upgrade.html#versions-to-upgrade-from">Versions to upgrade from</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/upgrade.html#installation-from-tarball">Installation from tarball</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/upgrade.html#storage-changes">Storage changes</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/upgrade.html#how-are-you-planning-on-upgrading">How are you planning on upgrading?</a></li>
<li class="toctree-l4"><a class="reference internal" href="download/upgrade.html#do-what-as-who">Do What As Who?</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#install-new-3-6-cyrus">2. Install new 3.6 Cyrus</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#shut-down-existing-cyrus">3. Shut down existing Cyrus</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#backup-and-copy-existing-data">4. Backup and Copy existing data</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#copy-config-files-and-update">5. Copy config files and update</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#upgrade-specific-items">6. Upgrade specific items</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#start-new-3-6-cyrus-and-verify">7. Start new 3.6 Cyrus and verify</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#reconstruct-databases-and-cache">8. Reconstruct databases and cache</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#do-you-want-any-new-features">9. Do you want any new features?</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#upgrade-complete">10. Upgrade complete</a></li>
<li class="toctree-l3"><a class="reference internal" href="download/upgrade.html#special-note-for-murder-configurations">Special note for Murder configurations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="concepts/deployment.html">Configuration Guide</a><ul>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html">Deployment Scenarios</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#single-server-deployments">Single Server Deployments</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#multi-server-deployments">Multi Server Deployments</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#cyrus-murder-server-aggregation">Cyrus Murder: Server aggregation</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#the-discrete-murder">The Discrete Murder</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#the-unified-murder">The Unified Murder</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#the-shared-murder">The Shared Murder</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#cyrus-replication">Cyrus Replication</a></li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/deployment_scenarios.html#hosted-environments">Hosted Environments</a></li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/databases.html">Databases</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/databases.html#overview">Overview</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/databases.html#file-list">File list</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/databases.html#storage-types">Storage types</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html">Mailbox Creation Distribution</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html#selection-mode">Selection Mode</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html#special-cases">Special cases</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html#partitions-exclusion">Partitions Exclusion</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html#partitions-usage-data-reset">Partitions Usage Data Reset</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html#mailbox-creation-distribution-through-murder-frontend">Mailbox Creation Distribution Through <code class="docutils literal notranslate"><span class="pre">murder</span> <span class="pre">frontend</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html#backends-exclusion">Backends Exclusion</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/mailbox_creation_distribution.html#backends-usage-data-reset">Backends Usage Data Reset</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/known_protocol_limitations.html">Known Protocol Limitations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/known_protocol_limitations.html#pop3-and-mailbox-locking">POP3 and Mailbox Locking</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/known_protocol_limitations.html#cyrus-imap-pop3-implementation">Cyrus IMAP POP3 Implementation</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/authentication_and_authorization.html">Authentication and Authorization</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/authentication_and_authorization.html#client-authentication">Client Authentication</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/authentication_and_authorization.html#users-and-mailboxes">Users and Mailboxes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/performance_recommendations.html">Performance Recommendations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/performance_recommendations.html#databases-on-temporary-filesystems">Databases on Temporary Filesystems</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/performance_recommendations.html#certificates">Certificates</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/storage.html">Storage Considerations</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/storage.html#general-notes-on-storage">General Notes on Storage</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/storage.html#redundancy">Redundancy</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/storage.html#availability">Availability</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/storage.html#performance">Performance</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/storage.html#scalability">Scalability</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/storage.html#capacity">Capacity</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/storage.html#cost">Cost</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="concepts/deployment/supported-platforms.html">Supported Platforms and System Requirements</a><ul>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/supported-platforms.html#building-cyrus-imap">Building Cyrus IMAP</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/supported-platforms.html#required-software-components">Required Software Components</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/supported-platforms.html#recommended-software-components">Recommended Software Components</a></li>
<li class="toctree-l4"><a class="reference internal" href="concepts/deployment/supported-platforms.html#recommended-software-components-enabled-by-default">Recommended Software Components Enabled by Default</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operations.html">Operations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference/manpages/index.html">Man pages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/manpages/index.html#configuration-files">(5) Configuration Files</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/configs/cyrus.conf.html"><strong>cyrus.conf</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/configs/imapd.conf.html"><strong>imapd.conf</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/configs/krb.equiv.html"><strong>krb.equiv</strong></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/manpages/index.html#system-commands">(8) System Commands</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/arbitron.html"><strong>arbitron</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/backupd.html"><strong>backupd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/chk_cyrus.html"><strong>chk_cyrus</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ctl_backups.html"><strong>ctl_backups</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ctl_conversationsdb.html"><strong>ctl_conversationsdb</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ctl_cyrusdb.html"><strong>ctl_cyrusdb</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ctl_deliver.html"><strong>ctl_deliver</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ctl_mboxlist.html"><strong>ctl_mboxlist</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ctl_zoneinfo.html"><strong>ctl_zoneinfo</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cvt_cyrusdb.html"><strong>cvt_cyrusdb</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cvt_xlist_specialuse.html"><strong>cvt_xlist_specialuse</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_backup.html"><strong>cyr_backup</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_buildinfo.html"><strong>cyr_buildinfo</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_dbtool.html"><strong>cyr_dbtool</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_deny.html"><strong>cyr_deny</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_df.html"><strong>cyr_df</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_expire.html"><strong>cyr_expire</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_info.html"><strong>cyr_info</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_ls.html"><strong>cyr_ls</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_synclog.html"><strong>cyr_synclog</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_userseen.html"><strong>cyr_userseen</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyr_virusscan.html"><strong>cyr_virusscan</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyradm.html"><strong>cyradm</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/cyrdump.html"><strong>cyrdump</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/deliver.html"><strong>deliver</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/fetchnews.html"><strong>fetchnews</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/fud.html"><strong>fud</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/httpd.html"><strong>httpd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/idled.html"><strong>idled</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/imapd.html"><strong>imapd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ipurge.html"><strong>ipurge</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/lmtpd.html"><strong>lmtpd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/lmtpproxyd.html"><strong>lmtpproxyd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/masssievec.html"><strong>masssievec</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/master.html"><strong>master</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/mbexamine.html"><strong>mbexamine</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/mbpath.html"><strong>mbpath</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/mbtool.html"><strong>mbtool</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/mkimap.html"><strong>mkimap</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/mknewsgroups.html"><strong>mknewsgroups</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/mupdate.html"><strong>mupdate</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/nntpd.html"><strong>nntpd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/notifyd.html"><strong>notifyd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/pop3d.html"><strong>pop3d</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/pop3proxyd.html"><strong>pop3proxyd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/promstatsd.html"><strong>promstatsd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/proxyd.html"><strong>proxyd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ptdump.html"><strong>ptdump</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ptexpire.html"><strong>ptexpire</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/ptloader.html"><strong>ptloader</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/quota.html"><strong>quota</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/reconstruct.html"><strong>reconstruct</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/rehash.html"><strong>rehash</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/relocate_by_id.html"><strong>relocate_by_id</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/restore.html"><strong>restore</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/sievec.html"><strong>sievec</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/sieved.html"><strong>sieved</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/smmapd.html"><strong>smmapd</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/squatter.html"><strong>squatter</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/sync_client.html"><strong>sync_client</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/sync_reset.html"><strong>sync_reset</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/sync_server.html"><strong>sync_server</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/timsieved.html"><strong>timsieved</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/tls_prune.html"><strong>tls_prune</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/translatesieve.html"><strong>translatesieve</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/systemcommands/unexpunge.html"><strong>unexpunge</strong></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/manpages/index.html#user-commands">(1) User Commands</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/arbitronsort.pl.html"><strong>arbitronsort.pl</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/dav_reconstruct.html"><strong>dav_reconstruct</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/httptest.html"><strong>httptest</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/imtest.html"><strong>imtest</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/installsieve.html"><strong>installsieve</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/lmtptest.html"><strong>lmtptest</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/mupdatetest.html"><strong>mupdatetest</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/nntptest.html"><strong>nntptest</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/pop3test.html"><strong>pop3test</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/sieveshell.html"><strong>sieveshell</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/sivtest.html"><strong>sivtest</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/smtptest.html"><strong>smtptest</strong></a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/manpages/usercommands/synctest.html"><strong>synctest</strong></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/admin.html">Administrator Guide</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/admin.html#architecture">Architecture</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/architecture.html">System Architecture</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/admin.html#management">Management</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/locations.html">File & Directory Locations</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/ports-sockets.html">Ports and Sockets</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/access-control.html">Access Control</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/quotas.html">Quotas</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/sieve.html">Cyrus Sieve</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/backups.html">Cyrus Backups</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/nntp.html">Cyrus NNTP</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/protlayer.html">Cyrus Prot Layer</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/sop.html">Standard Operating Procedures</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/eventsource.html">Cyrus Event Source</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/monitoring.html">Monitoring</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/config-mailboxdistribution.html">Mailbox Distribution</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/murder/murder.html">Cyrus Murder</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/nginx-proxy.html">HOWTO: Using an NGINX IMAP Proxy</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/admin/tweaking.html">Tweaking Cyrus IMAP</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference/faq.html">Frequently Asked Questions</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/faq.html#features">Features</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/feature-database-backend.html">Which database backend should I use for which databases?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/feature-duplicate-delivery.html">Duplicate Delivery Suppression</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/faq.html#installation-problems">Installation Problems</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/install-compilationerrors.html">Compilation errors about kssl.h and krb5.h on Red Hat Linux/Fedora</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/install-install-help.html">Help! There must be an easier way to get all this going…</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/install-linkerwarnings.html">OpenSSL Version Mismatches</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/faq.html#common-feature-requests">Common Feature Requests</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/r-murder-ha.html">Does the Cyrus Murder support High Availability configurations?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/r-pop3-logging.html">Can I configure pop3d to log amount and size of messages fetched by user?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/r-publicssharedfolders.html">How can I make CyrusSieve work with public shared folders?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/r-subfolders.html">Can I have subfolders not appear under INBOX?</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/faq.html#common-operational-questions">Common Operational Questions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-acls.html">How do I view ACLs on a mailbox?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-annotations.html">What annotations are available?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-configdir-tempfs.html">Is it safe to put <configdirectory>/proc and <configdirectory>/lock on a tmpfs filesystem?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-coredump.html">How to enable core dumps</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-delete-mailbox.html">Why can I not delete a mailbox as an admin user?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-deleted-expired-expunged-purged.html">When is What … Deleted, Expired, Expunged or Purged?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-deliverdb-size.html">Why is deliver.db so large?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-freezes.html">I have multiple imapd-SERVICES configured and experience occasional freezes when I try to log in!</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-gdb.html">How to run gdb on Cyrus components</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-mailbox-doesnotexist.html">Cyrus delivers claims that the mailbox does not exist</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-mixedcase.html">Why is mail being rejected with No Mailbox found due to MiXed CaSe incoming e-mail?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-otherdatabases.html">Can I use MySQL (or another SQL database) as the primary mail store?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-pop3slow.html">Why do POP3 connections take so long, but once the connection is established all is well?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-reconstruct.html">Why does reconstruct -m not work?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-sharedfilesystem-gpfs.html">Shared File Systems GPFS for high availability</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-telemetry.html">How to enable telemetry</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-toomanyprocesses.html">The process count keeps growing!</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-unable-join-environment.html">“unable to join environment” error</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/o-vacation-mailfrom.html">Why does Cyrus set the MAIL FROM address of the sender of vacation responses to ‘<>’?</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="reference/faq.html#common-interoperability-problems">Common Interoperability Problems</a><ul>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/interop-8bit.html">Why does Cyrus reject 8-bit characters in the headers of my messages?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/interop-barenewlines.html">Why does Cyrus reject messages with “bare newlines”?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/interop-sieve-exim.html">How do I get Cyrus Sieve to play nice with Exim?</a></li>
<li class="toctree-l4"><a class="reference internal" href="reference/faqs/interop-slow-delivery.html">Why does mail delivery go slow or hang sometimes?</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 current"><a class="reference internal" href="../developers.html">Developers</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../contribute.html">We need your help</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer/documentation.html">Contribute docs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="developer/documentation.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="developer/documentation.html#documentation-tools">Documentation Tools</a></li>
<li class="toctree-l3"><a class="reference internal" href="developer/documentation.html#building-the-files">Building the files</a></li>
<li class="toctree-l3"><a class="reference internal" href="developer/documentation.html#submitting-updates">Submitting updates</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/documentation.html#using-github-pull-requests">Using GitHub pull requests</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/documentation.html#patches-through-the-mailing-list">Patches through the mailing list</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer/documentation.html#special-tags">Special Tags</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/documentation.html#rfc">rfc</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/documentation.html#cyrusman">cyrusman</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/documentation.html#imap-current-stable-version">imap_current_stable_version</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer/documentation.html#conventions-man-pages">Conventions: Man Pages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/documentation.html#synopsis">Synopsis</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/documentation.html#examples">Examples</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2 current"><a class="reference internal" href="developer.html">Contribute code and tests</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="developer.html#getting-started">Getting Started</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="developer/process.html">Development Process</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/overview.html">Overview of Cyrus development environment</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/github-guide.html">GitHub guide</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/compiling.html">Compiling</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">Installing Cyrus</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/developer-testing.html">Developer Test Environment</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/jmap.html">JMAP support</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer.html#system-files-and-databases">System files and Databases</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/namespaces.html">Namespaces: a developer view</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer.html#resources">Resources</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/libraries.html">Developer Libraries</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer.html#releasing">Releasing</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/releasing.html">Releasing Cyrus IMAP</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/ancient-releasing.html">Releasing new builds of ancient Cyrus IMAP versions</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="developer/cyrusworks.html">Cyrus.Works</a><ul>
<li class="toctree-l3"><a class="reference internal" href="developer/cyrusworks.html#about-cyrus-works">About Cyrus Works</a></li>
<li class="toctree-l3"><a class="reference internal" href="developer/cyrusworks.html#how-it-works">How it works</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../developers.html#cyrus-internals">Cyrus Internals</a><ul>
<li class="toctree-l3"><a class="reference internal" href="developer/API.html">Cyrus APIs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/API/cyrusdb.html">CyrusDB API</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/API/cyrusdb2.html">cyrusdb API</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/API/index-api.html">Index API</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/API/mailbox-api.html">Mailbox API</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer/thoughts.html">Thoughts & Notes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/thoughts/backup.html">Notes for backup implementation</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/thoughts/bytecode.html">Cyrus IMAP Server: Sieve Bytecode</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/thoughts/caldav_scheduling_flowchart.html">Cyrus CalDAV Scheduling Flowchart</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/thoughts/improved_mboxlist_sort.html">Enabling improved_mboxlist_sort</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/thoughts/notes.html">Cyrus IMAP Server: Notes</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/thoughts/prot-events.html">Cyrus IMAP Server: Prot Events</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="developer/guidance.html">Guidance for Developers</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/hacking.html">Cyrus IMAP Server: Hacking</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/internationalization.html">Cyrus IMAP Server: Internationalization</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/locking.html">Cyrus IMAP Server: Locking</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/mailbox-format.html">Cyrus IMAP Server: Mailbox File Formats</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/namelocks.html">Cyrus IMAP Server: Namelocks</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/prot.html">Cyrus IMAP Server: prot layer</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/replication_examples.html">Cyrus IMAP Server: Replication Examples</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/replication_protocol.html">Cyrus IMAP Server: Replication Protocol v2.4+</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/special_chars.html">Cyrus IMAP Server: Special Characters</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/guidance/var_directory_structure.html">Cyrus IMAP Server: var directory structure</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../developers.html#unit-tests">Unit Tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="developer/unit-tests.html">Unit Tests</a><ul>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#table-of-contents">Table of Contents</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#introduction">1. Introduction</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#what-is-a-unit-test">2. What Is A Unit Test?</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#running-the-tests">3. Running The Tests</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#debugging-a-test">3.6 Debugging A Test</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#adding-your-own-tests">4. Adding Your Own Tests</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#where-to-put-your-tests">4.1 Where To Put Your Tests</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#adding-a-new-suite">4.1 Adding A New Suite</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#adding-a-test-to-a-suite">4.2 Adding A Test To A Suite</a></li>
<li class="toctree-l4"><a class="reference internal" href="developer/unit-tests.html#suite-setup-and-teardown">4.3 Suite Setup And Teardown</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../support.html">Support/Community</a><ul>
<li class="toctree-l2"><a class="reference internal" href="support/feedback-bugs.html">Found a bug?</a></li>
<li class="toctree-l2"><a class="reference internal" href="support/feedback-mailing-lists.html">Mailing lists</a></li>
<li class="toctree-l2"><a class="reference internal" href="support/feedback-meetings.html">Weekly meetings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../overview/about_cyrus.html">About</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../overview/what_is_cyrus.html">What is Cyrus</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/what_is_cyrus.html#what-is-cyrus">What is Cyrus</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/what_is_cyrus.html#what-is-imap">What is IMAP?</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/what_is_cyrus.html#imap-version-4-imap4">IMAP Version 4 (IMAP4)</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/what_is_cyrus.html#mime">Mime</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/what_is_cyrus.html#smtp">SMTP</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/who_is_cyrus.html">Who Is Cyrus</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/who_is_cyrus.html#core-contributors">Core Contributors</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/who_is_cyrus.html#individual-contributors-and-past-contributors">Individual contributors and past contributors</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/cyrus_roadmap.html">Cyrus Roadmap</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/cyrus_roadmap.html#high-level-roadmap">High Level Roadmap</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../overview/cyrus_history.html">Cyrus History</a></li>
<li class="toctree-l3"><a class="reference internal" href="../overview/cyrus_bylaws.html">Cyrus Bylaws</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../overview/cyrus_bylaws.html#i-the-cyrus-governance-board">I. The Cyrus Governance Board</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/cyrus_bylaws.html#ii-the-cyrus-core-developers-group">II. The Cyrus Core Developers Group</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/cyrus_bylaws.html#iii-the-release-engineer">III. The Release Engineer</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/cyrus_bylaws.html#iv-the-cyrus-roadmap">IV. The Cyrus Roadmap</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/cyrus_bylaws.html#v-development-process">V. Development Process</a></li>
<li class="toctree-l4"><a class="reference internal" href="../overview/cyrus_bylaws.html#vi-changes-to-the-bylaws">VI. Changes to the Bylaws</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Cyrus SASL</span></p>
<ul>
<li class="toctree-l1"><a class="reference external" href="http://www.cyrusimap.org/sasl">Cyrus SASL</a></li>
</ul>
</div>
<div class="buildstatus">
<a href="https://github.com/cyrusimap/cyrus-imapd/actions" target="_blank">cyrus-imapd-3.6: <img src="https://github.com/cyrusimap/cyrus-imapd/actions/workflows/main.yml/badge.svg?branch=cyrus-imapd-3.6"></a>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Cyrus IMAP</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html">Docs v3.6.1</a> »</li>
<li><a href="../setup.html">Setup</a> »</li>
<li>Installing Cyrus</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/cyrusimap/cyrus-imapd/blob/cyrus-imapd-3.6/docsrc/imap/installing.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<div class="section" id="installing-cyrus">
<span id="installing"></span><h1>Installing Cyrus<a class="headerlink" href="#installing-cyrus" title="Permalink to this headline">¶</a></h1>
<p>This guide assumes you have already <a class="reference internal" href="developer/compiling.html#compiling"><span class="std std-ref">compiled Cyrus</span></a>.</p>
<div class="section" id="install-cyrus">
<h2>Install Cyrus<a class="headerlink" href="#install-cyrus" title="Permalink to this headline">¶</a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">--prefix</span></code> option given to <code class="docutils literal notranslate"><span class="pre">configure</span></code> (during <a class="reference internal" href="developer/compiling.html#compiling"><span class="std std-ref">compilation</span></a>) sets where Cyrus is installed to.</p>
<p>If unspecified, it will go to whatever destination is your system default (often <code class="docutils literal notranslate"><span class="pre">/usr/local</span></code>).
To check: the final output of the configure step will display where a <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> will install to.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make install <span class="c1"># optional if you're just developing on this machine</span>
make install-binsymlinks <span class="c1"># Only needed if you're testing older Cyrus versions</span>
</pre></div>
</div>
</div>
<div class="section" id="optional-components">
<h2>Optional Components<a class="headerlink" href="#optional-components" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="download/installation/manage-dav.html">HTTP modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download/installation/manage-dav.html#about-http-module-support">About http module support</a></li>
<li class="toctree-l2"><a class="reference internal" href="download/installation/manage-dav.html#httpd-configuration">HTTPD Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="download/installation/manage-dav.html#module-specific-information">Module-specific information</a></li>
<li class="toctree-l2"><a class="reference internal" href="download/installation/manage-dav.html#for-end-users">For end users</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="download/installation/virus.html">Virus Scanner</a><ul>
<li class="toctree-l2"><a class="reference internal" href="download/installation/virus.html#about-virus-scan-support">About virus scan support</a></li>
<li class="toctree-l2"><a class="reference internal" href="download/installation/virus.html#virus-scanner-configuration">Virus Scanner Configuration</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="setting-up-syslog">
<h2>Setting up syslog<a class="headerlink" href="#setting-up-syslog" title="Permalink to this headline">¶</a></h2>
<p>A lot of Cyrus’s debugging information gets logged with <code class="docutils literal notranslate"><span class="pre">syslog</span></code>, so you’ll want to be able to capture it and find it later (especially when debugging cassandane tests)</p>
<ol class="arabic">
<li><p>Find the correct place to edit syslog config for your system (for me, I needed to create <code class="docutils literal notranslate"><span class="pre">/etc/rsyslog.d/cyrus.conf</span></code>)</p></li>
<li><p>Add lines like</p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">local6.*</span>        <span class="pre">/var/log/imapd.log</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">auth.debug</span>      <span class="pre">/var/log/auth.log</span></code></p>
</div></blockquote>
</li>
<li><p>Restart the rsyslog service</p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">/etc/init.d/rsyslog</span> <span class="pre">restart</span></code></p>
</div></blockquote>
</li>
<li><p>Arrange to rotate <code class="docutils literal notranslate"><span class="pre">/var/log/imapd.log</span></code> so it doesn’t get stupendously large. Create <code class="docutils literal notranslate"><span class="pre">/etc/logrotate.d/cyrus.conf</span></code> with content like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">imapd</span><span class="o">.</span><span class="n">log</span>
<span class="p">{</span>
<span class="n">rotate</span> <span class="mi">4</span>
<span class="n">weekly</span>
<span class="n">missingok</span>
<span class="n">notifempty</span>
<span class="n">compress</span>
<span class="n">delaycompress</span>
<span class="n">sharedscripts</span>
<span class="n">postrotate</span>
<span class="n">invoke</span><span class="o">-</span><span class="n">rc</span><span class="o">.</span><span class="n">d</span> <span class="n">rsyslog</span> <span class="n">rotate</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span>
<span class="n">endscript</span>
<span class="p">}</span>
</pre></div>
</div>
</li>
</ol>
</div>
<div class="section" id="create-cyrus-environment">
<h2>Create Cyrus environment<a class="headerlink" href="#create-cyrus-environment" title="Permalink to this headline">¶</a></h2>
<div class="section" id="set-up-the-cyrus-mail-user-and-group">
<h3>Set up the cyrus:mail user and group<a class="headerlink" href="#set-up-the-cyrus-mail-user-and-group" title="Permalink to this headline">¶</a></h3>
<p>Now let’s create a <strong>special user account just for the Cyrus server</strong>
to sandbox Cyrus: called <code class="docutils literal notranslate"><span class="pre">cyrus</span></code>. We’ll also create a <code class="docutils literal notranslate"><span class="pre">mail</span></code> group
as well. This allows Cyrus to give other programs some permissions if
they are run under the <code class="docutils literal notranslate"><span class="pre">mail</span></code> group, again, without causing a Cyrus
bug to delete all of your cat pictures. Disaster!</p>
<p>If you have installed from packages, your package vendor may have
already done this for you. To check, use these commands:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ getent group mail
mail:x:8:
</pre></div>
</div>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ getent passwd cyrus
cyrus:x:999:8:Cyrus IMAP Server:/var/lib/imap:/bin/bash
</pre></div>
</div>
<p>Example group and user creation commands for GNU/Linux:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">groupadd</span> <span class="o">-</span><span class="n">fr</span> <span class="n">mail</span>
<span class="n">useradd</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"Cyrus IMAP Server"</span> <span class="o">-</span><span class="n">d</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">imap</span> <span class="o">-</span><span class="n">g</span> <span class="n">mail</span> <span class="o">-</span><span class="n">s</span> <span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bash</span> <span class="o">-</span><span class="n">r</span> <span class="n">cyrus</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">var/lib/imap</span></code> directory above is an example. Use the same directory
specified in the <code class="docutils literal notranslate"><span class="pre">configdirectory</span></code> option in <a class="reference internal" href="reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>.</p>
<div class="sidebar">
<p class="sidebar-title">configdirectory</p>
<p><em>This shows the default value: change it in imapd.conf to suit your needs.</em></p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">configdirectory:</span></code> <none></p>
<blockquote>
<div><p>The pathname of the IMAP configuration directory. This field is
required.</p>
</div></blockquote>
</div></blockquote>
</div>
<p>If your installation uses system locations for things like SSL
certificates (i.e. <code class="docutils literal notranslate"><span class="pre">/etc/ssl/certs</span> <span class="pre">/etc/ssl/private</span></code>), then you should
also add the <code class="docutils literal notranslate"><span class="pre">cyrus</span></code> user to the appropriate group to gain access to
the PKI files. On Debian/Ubuntu systems, for example, this group is
<code class="docutils literal notranslate"><span class="pre">ssl-cert</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usermod</span> <span class="o">-</span><span class="n">aG</span> <span class="n">ssl</span><span class="o">-</span><span class="n">cert</span> <span class="n">cyrus</span>
</pre></div>
</div>
</div>
<div class="section" id="authentication-with-sasl">
<h3>Authentication with SASL<a class="headerlink" href="#authentication-with-sasl" title="Permalink to this headline">¶</a></h3>
<p>Now, let’s set up <strong>SASL</strong>. This will allow you to connect to your
local IMAP server and login, just like any IMAP user would before
checking for new emails.</p>
<p>Create a <code class="docutils literal notranslate"><span class="pre">saslauth</span></code> group and add the <code class="docutils literal notranslate"><span class="pre">cyrus</span></code> user to the group, so
Cyrus can access SASL. (on Debian, this group is called ‘sasl’: adjust
the following commands to suit.)</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">groupadd</span> <span class="o">-</span><span class="n">fr</span> <span class="n">saslauth</span>
<span class="n">usermod</span> <span class="o">-</span><span class="n">aG</span> <span class="n">saslauth</span> <span class="n">cyrus</span>
</pre></div>
</div>
<dl class="simple">
<dt>Change the default SASL configuration in <code class="docutils literal notranslate"><span class="pre">/etc/default/saslauthd</span></code>.</dt><dd><ol class="arabic simple">
<li><p>Make sure that the <code class="docutils literal notranslate"><span class="pre">START</span></code> option is set to <em>yes</em>
<code class="docutils literal notranslate"><span class="pre">(START=yes)</span></code> and</p></li>
<li><p>Set the``MECHANISMS`` option to <strong>sasldb</strong>
<code class="docutils literal notranslate"><span class="pre">(MECHANISMS="sasldb")</span></code>.</p></li>
</ol>
</dd>
</dl>
<p>Start the SASL auth daemon:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">saslauthd</span> <span class="n">start</span>
</pre></div>
</div>
<p>Now, we’ll create the IMAP user inside SASL. This is the user you’ll
use to login to the IMAP server later on.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s1">'secret'</span> <span class="o">|</span> <span class="n">saslpasswd2</span> <span class="o">-</span><span class="n">p</span> <span class="o">-</span><span class="n">c</span> <span class="n">imapuser</span>
</pre></div>
</div>
<p>You can replace <code class="docutils literal notranslate"><span class="pre">secret</span></code> with a more suitable password you want and
<code class="docutils literal notranslate"><span class="pre">imapuser</span></code> with the username you want. Once this is done, check that
the user exists and is set up correctly:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">testsaslauthd</span> <span class="o">-</span><span class="n">u</span> <span class="n">imapuser</span> <span class="o">-</span><span class="n">p</span> <span class="n">secret</span> <span class="o">-</span><span class="n">f</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">saslauthd</span><span class="o">/</span><span class="n">mux</span>
</pre></div>
</div>
<p>You should get an <code class="docutils literal notranslate"><span class="pre">0:</span> <span class="pre">OK</span> <span class="pre">"Success."</span></code> message.</p>
</div>
<div class="section" id="mail-delivery-from-your-mta">
<span id="mta-lda-delivery"></span><h3>Mail delivery from your MTA<a class="headerlink" href="#mail-delivery-from-your-mta" title="Permalink to this headline">¶</a></h3>
<p>Your Cyrus IMAP server will want to receive the emails accepted by your
SMTP server (ie Sendmail, Postfix, Exim). In Cyrus, this happens via a
protocol called LMTP, which is usually supported by your SMTP server.</p>
<div class="section" id="integration-with-sendmail">
<h4>Integration with Sendmail<a class="headerlink" href="#integration-with-sendmail" title="Permalink to this headline">¶</a></h4>
<div class="section" id="objectives">
<h5>Objectives<a class="headerlink" href="#objectives" title="Permalink to this headline">¶</a></h5>
<p>This manual describes how to integrate Sendmail with Cyrus IMAP. <a class="reference external" href="http://open-sendmail.sourceforge.net">Open Sendmail</a> presents alternative approaches, but these do not integrate well with email addresses from virtual domains, which are hosted by Cyrus IMAP, but are not in the <cite>virtuser</cite> table.</p>
<p>Cyrus IMAP can manage many domains. It has a default domain, and other, virtual domains.</p>
<p>Sendmail can also manage many domains. Its primary domains are stored in the <cite>w</cite> class and are read from <cite>/etc/mail/local-host-names</cite>. The rewritings for these domains are modified using the aliases database. Sendmail handles unqualified email addresses and addresses from the domains in the <cite>w</cite> class the same. Sendmail in addition can manage further, virtual domains by defining the <cite>VirtHost</cite> class. The redirections for the virtual domains are controlled by <cite>virtusertable</cite>.</p>
<p>This guide explains how to configure sendmail, so that it handles unqualified email addresses in the same way, as if they were in the default Cyrus IMAP domain. It assumes, that the default Cyrus domain is in the <cite>w</cite> class. At the end it will be possible to have destination addresses with domains in the <cite>w</cite> or <cite>VirtHost</cite> classes and these addresses will be delivered to Cyrus IMAP after aliases and <cite>virtusertable</cite> rewritings, if and only if Cyrus IMAP hosts them.</p>
<p>Sendmail will be configured to verify using <cite>smmapd</cite> if Cyrus does have a mailbox, and reject the email during the SMTP dialog otherwise. This avoids sending bounces. Bounces reduce the IP reputation of a mail server. If a local for the server user does not have a Cyrus IMAP account, this user will not get its emails in a folder on the server. If <cite>smmapd</cite> does not respond, sendmail will accept emails for any address.</p>
<p>If a virtual mailbox exists in Cyrus IMAP and <cite>virtusertable</cite> redirects the emails for that mailbox somewhere, the <cite>virtusertable</cite> takes precedence, like the aliases database has precedence in such cases.</p>
<p>The user database is not considered in this guide.</p>
<p>Plus addressing works, when the destination folder does exist and is lowercased: If <cite>user1</cite> has folders <cite>abc</cite> and <cite>mNp</cite>, emails for <cite>user1+abc</cite> and <cite>user1+aBc</cite> will be accepted, emails for <cite>user1+mNp</cite> and <cite>user1+mnp</cite> will be rejected. The lowercase limitation comes from <cite>smmapd</cite>. Emails for <cite>user1+def</cite> will be rejected, if <cite>user1</cite> has no mailbox <cite>def</cite>, even if a Sieve script would place such mails in existing folders.</p>
<p>Plus addressing does not survive aliases rewriting. If the aliases table contains <cite>user2: user1</cite>, emails for <cite>user2+abc</cite> will be rejected, while emails for <cite>user2</cite> or <cite>user1+abc</cite> will be accepted. After inserting <cite>user2+abc: user1+abc</cite> in the aliases table, emails for <cite>user2+abc</cite> will be accepted.</p>
</div>
<div class="section" id="install-sendmail">
<h5>Install Sendmail<a class="headerlink" href="#install-sendmail" title="Permalink to this headline">¶</a></h5>
<p>We’ll set up LMTP with the Sendmail SMTP server.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="o">-</span><span class="n">y</span> <span class="n">sendmail</span>
</pre></div>
</div>
</div>
<div class="section" id="add-cf-feature-anfi-vcyrus-m4">
<h5>Add cf/feature/anfi_vcyrus.m4<a class="headerlink" href="#add-cf-feature-anfi-vcyrus-m4" title="Permalink to this headline">¶</a></h5>
<p>Create the file cf/feature/anfi_vcyrus.m4:</p>
<div class="highlight-m4 notranslate"><div class="highlight"><pre><span></span>divert(-1)
dnl
dnl By using this file, you agree to the terms and conditions set
dnl forth in the LICENSE file which can be found at the top level of
dnl the sendmail distribution (sendmail-8.12).
dnl
dnl Contributed by Andrzej Filip and Dilyan Palauzov
LOCAL_CONFIG
# cyrus - map for checking cyrus maibox presence
Kcyrus socket -T<TMPF> -a<OK> local:/var/imap/socket/smmapd
LOCAL_RULESETS
SLocal_localaddr
R$+ $: $1 $| $(cyrus $1 $: $)
R$+ $| $#error $@ 5.1.1 $: "550 User unknown."
R$+ $| $*<TMPF> $#error $@ 4.3.0 $: "451 Temporary system failure. Please try again later."
R$+ $| $*<OK> $#cyrusv2 $@ $: $1
R$+ $| $* $: $1
</pre></div>
</div>
<p>Many spaces in a row stand for the tabulator character.</p>
<p>Despite the naming confusion, Cyrus 3 works with the <cite>cyrusv2</cite> mailer.</p>
<p>This file creates a map called <cite>cyrus</cite>, which connects to the Cyrus` <cite>smmapd</cite> service.</p>
<p>The file extends the <cite>localaddr=5</cite> and <cite>Local_localaddr</cite> rulesets to verify whether an address is known to Cyrus IMAP. The rulesets are called from the <cite>local</cite> mailer, as the <cite>local</cite> mailer has the <cite>5</cite> mailer flag set. The ruleset changes the mailer to <cite>cyrusv2</cite> and the email is accepted if and only if the address is known to Cyrus IMAP.</p>
<p>The temporary rejections do not work in practice. If <cite>smmapd</cite> is down, the email is queued instead of being rejected. The 451 line above is there to encourage discussion.</p>
</div>
<div class="section" id="patching-m4-proto-m4">
<h5>Patching m4/proto.m4<a class="headerlink" href="#patching-m4-proto-m4" title="Permalink to this headline">¶</a></h5>
<div class="highlight-diff notranslate"><div class="highlight"><pre><span></span><span class="gh">diff --git a/cf/m4/proto.m4 b/cf/m4/proto.m4</span>
<span class="gd">--- a/cf/m4/proto.m4</span>
<span class="gi">+++ b/cf/m4/proto.m4</span>
<span class="gu">@@ -1147,6 +1147,10 @@ dnl if no match, change marker to prevent a second @domain lookup</span>
R<@> $+ + $* < @ $+ . > $: < $(virtuser @ $3 $@ $1 $@ $2 $@ +$2 $: ! $) > $1 + $2 < @ $3 . >
dnl without +detail
R<@> $+ < @ $+ . > $: < $(virtuser @ $2 $@ $1 $: @ $) > $1 < @ $2 . >
<span class="gi">+dnl If a virtual address is not in the virtusertable, but cyrus knows about the address, deliver it.</span>
<span class="gi">+R< error : $-.$-.$- : $+ > $+ < @ $={VirtHost} . > $: < error : $1.$2.$3 : $4 > $5 < $6 . > $| $(cyrus $5@$6 $: $)</span>
<span class="gi">+R< error : $-.$-.$- : $+ > $* < $* . > $| $*<OK> $#cyrusv2 $@ $: $5@$6</span>
<span class="gi">+R< error : $-.$-.$- : $+ > $* $| $*<TMPFS> $#error $@ 4.3.0 $: "451 Temporary system failure. Please try again later."</span>
dnl no match
R<@> $+ $: $1
dnl remove mark
</pre></div>
</div>
<p>Where many spaces in a row stand for the tabulator key.</p>
<p>If an address from a virtual domain is not found in the <cite>virtusertable</cite>, ask <cite>smmapd</cite> if the address is known to Cyrus IMAP. If it is known, deliver it to Cyrus IMAP.</p>
</div>
<div class="section" id="patching-mailer-cyrusv2-m4">
<h5>Patching mailer/cyrusv2.m4<a class="headerlink" href="#patching-mailer-cyrusv2-m4" title="Permalink to this headline">¶</a></h5>
<div class="highlight-diff notranslate"><div class="highlight"><pre><span></span><span class="gh">diff --git a/cf/mailer/cyrusv2.m4 b/cf/mailer/cyrusv2.m4</span>
<span class="gd">--- a/cf/mailer/cyrusv2.m4</span>
<span class="gi">+++ b/cf/mailer/cyrusv2.m4</span>
<span class="gu">@@ -11,7 +11,7 @@ PUSHDIVERT(-1)</span>
#
_DEFIFNOT(`_DEF_CYRUSV2_MAILER_FLAGS', `lsDFMnqXz')
<span class="gd">-_DEFIFNOT(`CYRUSV2_MAILER_FLAGS', `A@/:|m')</span>
<span class="gi">+_DEFIFNOT(`CYRUSV2_MAILER_FLAGS', `8m')</span>
ifdef(`CYRUSV2_MAILER_ARGS',, `define(`CYRUSV2_MAILER_ARGS', `FILE /var/imap/socket/lmtp')')
define(`_CYRUSV2_QGRP', `ifelse(defn(`CYRUSV2_MAILER_QGRP'),`',`', ` Q=CYRUSV2_MAILER_QGRP,')')dnl
</pre></div>
</div>
<p>The <cite>8</cite> flag means, that Cyrus LMTPd can accept 8bit data and sendmail will not convert 8bit data to 7bit before passing it to Cyrus IMAP. The <cite>A@/:|</cite> functionality will be performed by the <cite>local</cite> mailer, before the <cite>cyrusv2</cite> mailer is called. The <cite>cyrus2v</cite> mailer is used only to pass data to Cyrus IMAP, after it is verified, that Cyrus IMAP hosts a particular mailbox. Thus the <cite>cyrus2v</cite> mailer does not call the <cite>localaddr=5</cite> rule set in order to avoid loops. (If the <cite>cyrusv2</cite> mailer calls the <cite>localaddr=5</cite> ruleset and the <cite>localaddr=5</cite> ruleset calls the <cite>cyrusv2</cite> mailer, there is an endless loop).</p>
<p>The patch to <cite>m4/proto.m4</cite> also requires a mailer, which does not call the <cite>localaddr=5</cite> ruleset. Because of this, substituting the <cite>local</cite> mailer by <cite>define(`confLOCAL_MAILER’, `cyrusv2’)dnl</cite> will not work. The proposed setup needs one mailer calling the <cite>localaddr=5</cite> ruleset (here the <cite>local</cite> mailer) and one mailer not calling the <cite>localaddr=5</cite> ruleset (the <cite>cyrusv2</cite> mailer).</p>
</div>
<div class="section" id="sendmail-communication">
<h5>Sendmail communication<a class="headerlink" href="#sendmail-communication" title="Permalink to this headline">¶</a></h5>
<p>For LMTP and SMMAP to work with Sendmail, it is necessary to create a folder that will contain the UNIX socket used by Sendmail and Cyrus to deliver/receive emails:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">socket</span>
<span class="n">sudo</span> <span class="n">chown</span> <span class="n">cyrus</span><span class="p">:</span><span class="n">mail</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">socket</span>
<span class="n">sudo</span> <span class="n">chmod</span> <span class="mi">750</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">socket</span>
</pre></div>
</div>
<p>Do the same for the <cite>smmapd</cite> socket.</p>
</div>
<div class="section" id="adjustments-for-the-mc-files">
<h5>Adjustments for the <cite>.mc</cite> files<a class="headerlink" href="#adjustments-for-the-mc-files" title="Permalink to this headline">¶</a></h5>
<p>In your <cite>.mc</cite> files add:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>FEATURE(`anfi_vcyrus')dnl
MAILER(`cyrusv2')dnl
</pre></div>
</div>
<p>and recompile them, e.g. by calling <cite>make file.cf</cite> to convert <cite>file.mc</cite> to <cite>file.cf</cite>. Test with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span># ggg is unqualified address, which exists both in Cyrus’ default domain and in sendmails’ w class
$ sendmail -C file.cf -bv ggg
ggg... deliverable: mailer cyrusv2, user ggg
# verify that ggg and ggg@your-primary-domain resolve in the same way, your-primary-domain is the default Cyrus IMAP domain
$ sendmail -C file.cf -bv ggg@your-primary-domain
ggg... deliverable: mailer cyrusv2, user ggg
# as above, but here another-domain belongs to class `w` and it is not the default domain for Cyrus IMAP
$ sendmail -C file.cf -bv ggg@another-domain
ggg... deliverable: mailer cyrusv2, user ggg
# for an address, which exists in Cyrus IMAP, and is not overwritten in virtusertable.
# domain1.org belongs to class VirtHost and does not belong to class w.
$ sendmail -C sendmail-mail.cf -bv zzz@domain1.org
zzz@domain1.org... deliverable: mailer cyrusv2, user zzz@domain1.org
</pre></div>
</div>
</div>
</div>
<div class="section" id="postfix">
<h4>Postfix<a class="headerlink" href="#postfix" title="Permalink to this headline">¶</a></h4>
<div class="section" id="install-postfix">
<h5>Install Postfix<a class="headerlink" href="#install-postfix" title="Permalink to this headline">¶</a></h5>
<p>We’ll set up LMTP with the Postfix SMTP server (consider which other
Postfix related packages you may also desire):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="o">-</span><span class="n">y</span> <span class="n">postfix</span> <span class="n">postfix</span><span class="o">-</span><span class="n">doc</span> <span class="n">postfix</span><span class="o">-</span><span class="n">pcre</span> <span class="n">postfix</span><span class="o">-</span><span class="n">ldap</span> <span class="o">...</span>
</pre></div>
</div>
<p>We need to make Postfix aware of the fact we are using the Cyrus IMAP
server and engineer delivery via LMTP. The following examples show the
<code class="docutils literal notranslate"><span class="pre">postconf</span></code> commands to run to add the necessary configuration to
<code class="docutils literal notranslate"><span class="pre">/etc/postfix/main.cf</span></code>, these are not complete configurations.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Postfix supports a great many configurations for mail delivery
transport, so these settings will depend on whether you’re planning
to use the <code class="docutils literal notranslate"><span class="pre">local</span></code>, <code class="docutils literal notranslate"><span class="pre">virtual</span></code> or <code class="docutils literal notranslate"><span class="pre">lmtp</span></code> destination
definitions. For our examples we’ll be using <code class="docutils literal notranslate"><span class="pre">virtual</span></code>. Adjust
as needed for your purposes, and please consult the Postfix
documentation at <a class="reference external" href="http://www.postfix.org/postconf.5.html">http://www.postfix.org/postconf.5.html</a></p>
</div>
<ol class="arabic">
<li><p>Setup your recipient maps, thus defining for which recipients the
<code class="docutils literal notranslate"><span class="pre">virtual</span></code> destination will be used:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_mailbox_domains=hash:/etc/postfix/virtual_recipient_domains"</span>
<span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_mailbox_maps=hash:/etc/postfix/virtual_recipients"</span>
</pre></div>
</div>
<p>or, if you have enabled smmapd you can automatically track mailboxes with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_mailbox_domains=hash:/etc/postfix/virtual_recipient_domains"</span>
<span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_mailbox_maps=socketmap:unix:/run/cyrus/socket/smmap"</span>
</pre></div>
</div>
</li>
<li><p>Optional: Set the concurrency and recipient limits for LMTP delivery to the
<code class="docutils literal notranslate"><span class="pre">virtual</span></code> destination:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_destination_concurrency_limit=300"</span>
<span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_destination_recipient_limit=300"</span>
</pre></div>
</div>
<p>The purpose of those two settings is to allow for a large number of
simultaneous delivery threads between the MTA (Postfix) and the MDA
(Cyrus), and to allow for a large number of recipients to be listed
for any given message, thus avoiding splitting up delivery of messages
with lots of recipients into many separate deliveries.</p>
</li>
<li><p>Send mail for those recipients to Cyrus via LMTP. This first
example is for delivery via TCP to a different host:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_transport=lmtp:inet:lmtp.example.org:2003"</span>
</pre></div>
</div>
<p>If your Postfix and Cyrus are on the same host, then use some
version of this, where the socket patch matches what’s set in the
<code class="docutils literal notranslate"><span class="pre">lmtpsocket</span></code> option in <a class="reference internal" href="reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">postconf</span> <span class="o">-</span><span class="n">e</span> <span class="s2">"virtual_transport=lmtp:unix:/run/cyrus/socket/lmtp"</span>
</pre></div>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="section" id="protocol-ports">
<h3>Protocol ports<a class="headerlink" href="#protocol-ports" title="Permalink to this headline">¶</a></h3>
<p>The Cyrus IMAP server provides service interfaces via either TCP/IP
ports or Unix domain sockets. For the former, Cyrus requires that there
are proper entries in the host’s <code class="docutils literal notranslate"><span class="pre">/etc/services</span></code> file. The following
are required for any host using the listed services:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pop3</span> <span class="mi">110</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Post Office Protocol v3</span>
<span class="n">nntp</span> <span class="mi">119</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Network News Transport Protocol</span>
<span class="n">imap</span> <span class="mi">143</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Internet Mail Access Protocol rev4</span>
<span class="n">nntps</span> <span class="mi">563</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># NNTP over TLS</span>
<span class="n">imaps</span> <span class="mi">993</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># IMAP over TLS</span>
<span class="n">pop3s</span> <span class="mi">995</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># POP3 over TLS</span>
<span class="n">kpop</span> <span class="mi">1109</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Kerberized Post Office Protocol</span>
<span class="n">lmtp</span> <span class="mi">2003</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Lightweight Mail Transport Protocol service</span>
<span class="n">smmap</span> <span class="mi">2004</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Cyrus smmapd (quota check) service</span>
<span class="n">csync</span> <span class="mi">2005</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Cyrus replication service</span>
<span class="n">mupdate</span> <span class="mi">3905</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># Cyrus mupdate service</span>
<span class="n">sieve</span> <span class="mi">4190</span><span class="o">/</span><span class="n">tcp</span> <span class="c1"># timsieved Sieve Mail Filtering Language service</span>
</pre></div>
</div>
<p>Make sure that these lines are present or add them if they are missing.</p>
</div>
<div class="section" id="cyrus-config-files">
<h3>Cyrus config files<a class="headerlink" href="#cyrus-config-files" title="Permalink to this headline">¶</a></h3>
<p>Set up a simple directory structure for Cyrus to store emails, owned by
the <code class="docutils literal notranslate"><span class="pre">cyrus</span></code> user and group <code class="docutils literal notranslate"><span class="pre">mail</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">cyrus</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">spool</span><span class="o">/</span><span class="n">cyrus</span>
<span class="n">sudo</span> <span class="n">chown</span> <span class="o">-</span><span class="n">R</span> <span class="n">cyrus</span><span class="p">:</span><span class="n">mail</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">cyrus</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">spool</span><span class="o">/</span><span class="n">cyrus</span>
<span class="n">sudo</span> <span class="n">chmod</span> <span class="mi">750</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">cyrus</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">spool</span><span class="o">/</span><span class="n">cyrus</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">/var/spool/cyrus</span></code> directory is the
<a class="reference internal" href="concepts/features/mail-spool-partitions.html#imap-features-mail-spool-partitions"><span class="std std-ref">partition</span></a> where Cyrus will store
mail and must be allocated sufficient storage. The exact location can be
configured in <a class="reference internal" href="reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a> in the partitions options.</p>
<p>Let’s add some basic configuration for the Cyrus IMAP server. Two files
have to be added: <code class="docutils literal notranslate"><span class="pre">/etc/imapd.conf</span></code> and <code class="docutils literal notranslate"><span class="pre">/etc/cyrus.conf</span></code>. There
are several examples included with the software, in <code class="docutils literal notranslate"><span class="pre">doc/examples/</span></code>.
Pick one each from the <code class="docutils literal notranslate"><span class="pre">imapd_conf</span></code> and <code class="docutils literal notranslate"><span class="pre">cyrus_conf</span></code> directories,
or create your own.</p>
<p>For <a class="reference internal" href="reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>, let’s start with the <code class="docutils literal notranslate"><span class="pre">normal.conf</span></code>
example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Suggested minimal imapd.conf</span>
<span class="c1"># See imapd.conf(5) for more information and more options</span>
<span class="c1"># Space-separated users who have admin rights for all services.</span>
<span class="c1"># NB: THIS MUST BE CONFIGURED</span>
<span class="n">admins</span><span class="p">:</span> <span class="n">cyrus</span>
<span class="c1">###################################################################</span>
<span class="c1">## File, socket and DB location settings.</span>
<span class="c1">###################################################################</span>
<span class="c1"># Configuration directory</span>
<span class="n">configdirectory</span><span class="p">:</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">cyrus</span>
<span class="c1"># Directories for proc and lock files</span>
<span class="n">proc_path</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">proc</span>
<span class="n">mboxname_lockpath</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">lock</span>
<span class="c1"># Locations for DB files</span>
<span class="c1"># The following DB are recreated upon initialization, so should live in</span>
<span class="c1"># ephemeral storage for best performance.</span>
<span class="n">duplicate_db_path</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">deliver</span><span class="o">.</span><span class="n">db</span>
<span class="n">ptscache_db_path</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">ptscache</span><span class="o">.</span><span class="n">db</span>
<span class="n">statuscache_db_path</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">statuscache</span><span class="o">.</span><span class="n">db</span>
<span class="n">tls_sessions_db_path</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">tls_sessions</span><span class="o">.</span><span class="n">db</span>
<span class="c1"># Which partition to use for default mailboxes</span>
<span class="n">defaultpartition</span><span class="p">:</span> <span class="n">default</span>
<span class="n">partition</span><span class="o">-</span><span class="n">default</span><span class="p">:</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">spool</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">mail</span>
<span class="c1"># If sieveusehomedir is false (the default), this directory is searched</span>
<span class="c1"># for Sieve scripts.</span>
<span class="n">sievedir</span><span class="p">:</span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">spool</span><span class="o">/</span><span class="n">sieve</span>
<span class="c1">###################################################################</span>
<span class="c1">## Important: KEEP THESE IN SYNC WITH cyrus.conf</span>
<span class="c1">###################################################################</span>
<span class="n">lmtpsocket</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">socket</span><span class="o">/</span><span class="n">lmtp</span>
<span class="n">idlesocket</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">socket</span><span class="o">/</span><span class="n">idle</span>
<span class="n">notifysocket</span><span class="p">:</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">socket</span><span class="o">/</span><span class="n">notify</span>
<span class="c1"># Syslog prefix. Defaults to cyrus (so logging is done as cyrus/imap</span>
<span class="c1"># etc.)</span>
<span class="n">syslog_prefix</span><span class="p">:</span> <span class="n">cyrus</span>
<span class="c1">###################################################################</span>
<span class="c1">## Server behaviour settings</span>
<span class="c1">###################################################################</span>
<span class="c1"># Space-separated list of HTTP modules that will be enabled in</span>
<span class="c1"># httpd(8). This option has no effect on modules that are disabled at</span>
<span class="c1"># compile time due to missing dependencies (e.g. libical).</span>
<span class="c1">#</span>
<span class="c1"># Allowed values: caldav, carddav, domainkey, ischedule, rss</span>
<span class="n">httpmodules</span><span class="p">:</span> <span class="n">caldav</span> <span class="n">carddav</span>
<span class="c1"># If enabled, the partitions will also be hashed, in addition to the</span>
<span class="c1"># hashing done on configuration directories. This is recommended if one</span>
<span class="c1"># partition has a very bushy mailbox tree.</span>
<span class="n">hashimapspool</span><span class="p">:</span> <span class="n">true</span>
<span class="c1"># Enable virtual domains</span>
<span class="c1"># and set default domain to localhost</span>
<span class="n">virtdomains</span><span class="p">:</span> <span class="n">yes</span>
<span class="n">defaultdomain</span><span class="p">:</span> <span class="n">localhost</span>
<span class="c1">###################################################################</span>
<span class="c1">## User experience settings</span>
<span class="c1">###################################################################</span>
<span class="c1"># Minimum time between POP mail fetches in minutes</span>
<span class="n">popminpoll</span><span class="p">:</span> <span class="mi">1</span>
<span class="c1">###################################################################</span>
<span class="c1">## User Authentication settings</span>
<span class="c1">###################################################################</span>
<span class="c1"># Allow plaintext logins by default (SASL PLAIN)</span>
<span class="n">allowplaintext</span><span class="p">:</span> <span class="n">yes</span>
<span class="c1">###################################################################</span>
<span class="c1">## SASL library options (these are handled directly by the SASL</span>
<span class="c1">## libraries, refer to SASL documentation for an up-to-date list of</span>
<span class="c1">## these)</span>
<span class="c1">###################################################################</span>
<span class="c1"># The mechanism(s) used by the server to verify plaintext passwords.</span>
<span class="c1"># Possible values are "saslauthd", "auxprop", "pwcheck" and</span>
<span class="c1"># "alwaystrue". They are tried in order, you can specify more than one,</span>
<span class="c1"># separated by spaces.</span>
<span class="n">sasl_pwcheck_method</span><span class="p">:</span> <span class="n">saslauthd</span>
<span class="c1"># If enabled, the SASL library will automatically create authentication</span>
<span class="c1"># secrets when given a plaintext password. Refer to SASL documentation</span>
<span class="n">sasl_auto_transition</span><span class="p">:</span> <span class="n">no</span>
<span class="c1">###################################################################</span>
<span class="c1">## SSL/TLS Options</span>
<span class="c1">###################################################################</span>
<span class="c1"># File containing the global certificate used for ALL services (imap,</span>
<span class="c1"># pop3, lmtp, sieve)</span>
<span class="c1">#tls_server_cert: /etc/ssl/certs/ssl-cert-snakeoil.pem</span>
<span class="c1"># File containing the private key belonging to the global server</span>
<span class="c1"># certificate.</span>
<span class="c1">#tls_server_key: /etc/ssl/private/ssl-cert-snakeoil.key</span>
<span class="c1"># File containing one or more Certificate Authority (CA) certificates.</span>
<span class="c1">#tls_client_ca_file: /etc/ssl/certs/cyrus-imapd-ca.pem</span>
<span class="c1"># Path to directory with certificates of CAs.</span>
<span class="n">tls_client_ca_dir</span><span class="p">:</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">ssl</span><span class="o">/</span><span class="n">certs</span>
<span class="c1"># The length of time (in minutes) that a TLS session will be cached for</span>
<span class="c1"># later reuse. The maximum value is 1440 (24 hours), the default. A</span>
<span class="c1"># value of 0 will disable session caching.</span>
<span class="n">tls_session_timeout</span><span class="p">:</span> <span class="mi">1440</span>
</pre></div>
</div>
<p>Note that <strong>configdirectory</strong> and <strong>partition-default</strong> are set to the
folders we just created.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The admin user is the <code class="docutils literal notranslate"><span class="pre">imapuser</span></code> created earlier for
authentication against sasl. Change this value if you named your user
something different.</p>
</div>
<p>For <a class="reference internal" href="reference/manpages/configs/cyrus.conf.html#std-cyrusman-cyrus.conf-5">cyrus.conf(5)</a>, again we’ll start with the
<code class="docutils literal notranslate"><span class="pre">normal.conf</span></code> example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># standard standalone server implementation</span>
<span class="n">START</span> <span class="p">{</span>
<span class="c1"># do not delete this entry!</span>
<span class="n">recover</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"ctl_cyrusdb -r"</span>
<span class="p">}</span>
<span class="c1"># UNIX sockets start with a slash and are put into /run/cyrus/socket</span>
<span class="n">SERVICES</span> <span class="p">{</span>
<span class="c1"># add or remove based on preferences</span>
<span class="n">imap</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"imapd"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"imap"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="n">imaps</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"imapd -s"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"imaps"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="n">pop3</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"pop3d"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"pop3"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="n">pop3s</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"pop3d -s"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"pop3s"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="n">sieve</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"timsieved"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"sieve"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="c1"># these are only necessary if receiving/exporting usenet via NNTP</span>
<span class="c1"># nntp cmd="nntpd" listen="nntp" prefork=0</span>
<span class="c1"># nntps cmd="nntpd -s" listen="nntps" prefork=0</span>
<span class="c1"># these are only necessary if using HTTP for CalDAV, CardDAV, or RSS</span>
<span class="n">http</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"httpd"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"http"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="n">https</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"httpd -s"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"https"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="c1"># at least one LMTP is required for delivery</span>
<span class="c1"># lmtp cmd="lmtpd" listen="lmtp" prefork=0</span>
<span class="n">lmtpunix</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"lmtpd"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"/run/cyrus/socket/lmtp"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
<span class="c1"># this is requied if using socketmap</span>
<span class="c1"># smmap cmd="smmapd" listen="/run/cyrus/socket/smmap" prefork=0</span>
<span class="c1"># this is required if using notifications</span>
<span class="c1"># notify cmd="notifyd" listen="/run/cyrus/socket/notify" proto="udp" prefork=1</span>
<span class="p">}</span>
<span class="n">EVENTS</span> <span class="p">{</span>
<span class="c1"># this is required</span>
<span class="n">checkpoint</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"ctl_cyrusdb -c"</span> <span class="n">period</span><span class="o">=</span><span class="mi">30</span>
<span class="c1"># this is only necessary if using duplicate delivery suppression,</span>
<span class="c1"># Sieve or NNTP</span>
<span class="n">delprune</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"cyr_expire -E 3"</span> <span class="n">at</span><span class="o">=</span><span class="mi">0400</span>
<span class="c1"># Expire data older than 28 days.</span>
<span class="n">deleteprune</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"cyr_expire -E 4 -D 28"</span> <span class="n">at</span><span class="o">=</span><span class="mi">0430</span>
<span class="n">expungeprune</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"cyr_expire -E 4 -X 28"</span> <span class="n">at</span><span class="o">=</span><span class="mi">0445</span>
<span class="c1"># this is only necessary if caching TLS sessions</span>
<span class="n">tlsprune</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"tls_prune"</span> <span class="n">at</span><span class="o">=</span><span class="mi">0400</span>
<span class="p">}</span>
<span class="n">DAEMON</span> <span class="p">{</span>
<span class="c1"># this is only necessary if using idled for IMAP IDLE</span>
<span class="c1"># idled cmd="idled"</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Before you launch Cyrus for the first time, create the Cyrus directory
structure: use <a class="reference internal" href="reference/manpages/systemcommands/mkimap.html#std-cyrusman-mkimap-8">mkimap(8)</a>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">-</span><span class="n">u</span> <span class="n">cyrus</span> <span class="o">./</span><span class="n">tools</span><span class="o">/</span><span class="n">mkimap</span>
</pre></div>
</div>
</div>
<div class="section" id="optional-setting-up-tls-certificates">
<h3>Optional: Setting up TLS certificates<a class="headerlink" href="#optional-setting-up-tls-certificates" title="Permalink to this headline">¶</a></h3>
<p>Obtain a certificate, e.g. from
<a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a>. You need a file with
the full chain and a private key in
<a class="reference external" href="https://en.wikipedia.org/wiki/X.509">X.509</a> format. Adjust the file
owner on these files with <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">chown</span> <span class="pre">cyrus:mail</span></code>. Set the options
<code class="docutils literal notranslate"><span class="pre">tls_server_cert</span></code> and <code class="docutils literal notranslate"><span class="pre">tls_server_key</span></code> in <a class="reference internal" href="reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>
to point to these files.</p>
<p>Open <code class="docutils literal notranslate"><span class="pre">/etc/cyrus.conf</span></code> and in the <strong>SERVICES</strong> section, add (or
uncomment) this line:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">imaps</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"imapd"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"imaps"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
</pre></div>
</div>
<p>Notice the <cite>s</cite> at the end of <cite>imaps</cite>. This says we are using TLS.
Similar such lines may be used for <cite>pop3s</cite>, <cite>lmtps</cite> and other protocols.
See Protocol Ports, above, for more information on these.</p>
<p>If you now restart (or start) your Cyrus server, you should have Cyrus
listening on port <strong>993</strong> (the IMAPS port) with the <strong>STARTTLS IMAP
extension</strong> enabled. You can check that TLS works as expected with the
following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">imtest</span> <span class="o">-</span><span class="n">t</span> <span class="s2">""</span> <span class="o">-</span><span class="n">u</span> <span class="n">imapuser</span> <span class="o">-</span><span class="n">a</span> <span class="n">imapuser</span> <span class="o">-</span><span class="n">w</span> <span class="n">secret</span> <span class="n">localhost</span>
</pre></div>
</div>
<p>Make sure to replace <cite>imapuser</cite> with whatever user you set up with
saslpasswd2 before, and to replace <cite>secret</cite> with the actual password
you set for that user.</p>
</div>
<div class="section" id="prepare-ephemeral-run-time-storage-directories">
<h3>Prepare ephemeral (run-time) storage directories<a class="headerlink" href="#prepare-ephemeral-run-time-storage-directories" title="Permalink to this headline">¶</a></h3>
<p>If you will be using ephemeral (run-time) storage locations on an OS or
distro on which the directory skeleton does not persist over reboots,
you will need to use your distro’s standard method to ensure that any
such directories your installation depends upon exist <cite>prior</cite> to
launching the daemon.</p>
<p>Here’s how to do so for Debian/Ubuntu. Use the provided
<code class="docutils literal notranslate"><span class="pre">statoverride</span></code> facility to manage the ownership and permissions of
these directories:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">dpkg</span><span class="o">-</span><span class="n">statoverride</span> <span class="n">cyrus</span> <span class="n">mail</span> <span class="mi">755</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span>
<span class="n">sudo</span> <span class="n">dpkg</span><span class="o">-</span><span class="n">statoverride</span> <span class="n">cyrus</span> <span class="n">mail</span> <span class="mi">750</span> <span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">cyrus</span><span class="o">/</span><span class="n">socket</span>
</pre></div>
</div>
<p>Then you can use something like this in your init script (like those
packaged by Debian team):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>dir=$(dpkg-statoverride --list /var/run/cyrus)
[ -z "$dir" ] || createdir $dir
</pre></div>
</div>
<p>where the <code class="docutils literal notranslate"><span class="pre">createdir()</span></code> shell function looks like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>createdir() {
# $1 = user
# $2 = group
# $3 = permissions (octal)
# $4 = path to directory
[ "$VERBOSE" = "yes" ] && OPT="-c"
[ -d "$4" ] || mkdir -p "$4"
chown $OPT -h "$1:$2" "$4"
chmod $OPT "$3" "$4"
}
</pre></div>
</div>
<p>Putting it all together, this blob from the stock Debian packaging
would go between pre-flight checks (checking for config sanity, file
locations, etc.) and initialization:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>createdir() {
# $1 = user
# $2 = group
# $3 = permissions (octal)
# $4 = path to directory
[ "$VERBOSE" = "yes" ] && OPT="-c"
[ -d "$4" ] || mkdir -p "$4"
chown $OPT -h "$1:$2" "$4"
chmod $OPT "$3" "$4"
}
missingstatoverride () {
echo "$0: You are missing a dpkg-statoverride on $1. Add it." >&2
exit 1
}
fixdirs () {
dir=$(dpkg-statoverride --list /run/cyrus) \
|| missingstatoverride /run/cyrus
[ -z "$dir" ] \
|| createdir $dir
dir=$(dpkg-statoverride --list /run/cyrus/socket) \
|| missingstatoverride /run/cyrus/socket
[ -z "$dir" ] \
|| createdir $dir
}
</pre></div>
</div>
</div>
</div>
<div class="section" id="launch-cyrus">
<h2>Launch Cyrus<a class="headerlink" href="#launch-cyrus" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="o">./</span><span class="n">master</span><span class="o">/</span><span class="n">master</span> <span class="o">-</span><span class="n">d</span>
</pre></div>
</div>
<p>Check <code class="docutils literal notranslate"><span class="pre">/var/log/syslog</span></code> for errors so you can quickly understand any
problems.</p>
<p>When you’re ready, you can create init scripts to start and stop your
daemons. This
<a class="reference external" href="https://www.linux.com/learn/managing-linux-daemons-init-scripts">https://www.linux.com/learn/managing-linux-daemons-init-scripts</a> is old,
but has a good explanation of the concepts required.</p>
</div>
<div class="section" id="send-a-test-email">
<h2>Send a test email<a class="headerlink" href="#send-a-test-email" title="Permalink to this headline">¶</a></h2>
<p>We will send a test email to our local development environment to check
if:</p>
<ul class="simple">
<li><p>The SMTP server* accepts the incoming email,</p></li>
<li><p>LMTP transmits the email to Cyrus IMAP,</p></li>
<li><p>You can see the email stored on your filesystem.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>*SMTP servers are also often called an “MTA,” for Mail Transport
Agent</p>
</div>
<p>But first, create a mailbox to send the test email to. We’ll call this
test mailbox <cite>example@localhost</cite>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s1">'createmailbox user/example@localhost'</span> <span class="o">|</span> <span class="n">cyradm</span> <span class="o">-</span><span class="n">u</span> <span class="n">imapuser</span> <span class="o">-</span><span class="n">w</span> <span class="n">secret</span> <span class="n">localhost</span>
</pre></div>
</div>
<p>We seem to be creating a mailbox named <code class="docutils literal notranslate"><span class="pre">user/example@localhost</span></code>. In
fact, Cyrus understands this to be a user called <code class="docutils literal notranslate"><span class="pre">example@localhost</span></code>.
As usual, adjust the password via the <code class="docutils literal notranslate"><span class="pre">-w</span></code> option to the password you
set above.</p>
<p>If you have explicitly disabled <code class="docutils literal notranslate"><span class="pre">unixhierarchysep</span></code> in
<code class="docutils literal notranslate"><span class="pre">/etc/imapd.conf</span></code> (it is enabled by default in 3.0+), you should
replace <code class="docutils literal notranslate"><span class="pre">user/example@localhost</span></code> with <code class="docutils literal notranslate"><span class="pre">user.example@localhost</span></code>. You
can read more about <code class="docutils literal notranslate"><span class="pre">unixhierarchysep</span></code> in <a class="reference internal" href="reference/manpages/configs/imapd.conf.html#std-cyrusman-imapd.conf-5">imapd.conf(5)</a>.</p>
<p>The command will produce the following output:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">localhost</span><span class="o">></span> <span class="n">localhost</span><span class="o">></span>
</pre></div>
</div>
<p>This happens because cyradm is normally used interactively, with a
prompt. We aren’t using a prompt, so this output is expected.</p>
<p>Now that the mailbox exists, we can send an email using telnet with raw
SMTP commands.</p>
<p>First, connect to the MTA:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">telnet</span> <span class="n">localhost</span> <span class="n">smtp</span>
</pre></div>
</div>
<p>You should see a prompt appear:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Trying</span> <span class="p">::</span><span class="mf">1.</span><span class="o">..</span>
<span class="n">Trying</span> <span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="o">...</span>
<span class="n">Connected</span> <span class="n">to</span> <span class="n">localhost</span><span class="o">.</span>
<span class="n">Escape</span> <span class="n">character</span> <span class="ow">is</span> <span class="s1">'^]'</span><span class="o">.</span>
<span class="mi">220</span> <span class="o">...</span> <span class="n">ESMTP</span> <span class="n">Sendmail</span> <span class="o">...</span>
</pre></div>
</div>
<p>Now, we’ll send the <a class="reference external" href="https://www.ietf.org/rfc/rfc2821.txt">SMTP commands</a> to the server. These are responsible for ordering the MTA to store an email:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>EHLO localhost
MAIL FROM:<hello@localhost>
RCPT TO:<example@localhost>
DATA
Hello world!
.
QUIT
</pre></div>
</div>
<p>If you are using Sendmail as your SMTP server, you should be able to
safely copy and paste this bit into the terminal before hitting your
ENTER key. If not, you may want to paste these commands one by one (or
make sure you enable <cite>PIPELINING</cite> in the SMTP config).</p>
<p>If you see a message like <strong>250 2.0.0 … Message accepted for
delivery</strong>, you did it! You should now have a file called <cite>1.</cite> in the
<cite>/var/spool/cyrus/user/example</cite> directory, with the content of the email
you sent just before.</p>
<p>If not, you may want to check <cite>syslog</cite> to see if any error messages
show up and go through the previous steps again.</p>
<p>To let the example user log in via IMAP on a normal mail client, you
need to add them to SASL (as before):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">echo</span> <span class="s1">'mypassword'</span> <span class="o">|</span> <span class="n">saslpasswd2</span> <span class="o">-</span><span class="n">p</span> <span class="o">-</span><span class="n">c</span> <span class="n">example</span>
</pre></div>
</div>
<p>Check your two users are there:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sasldblistusers2</span>
</pre></div>
</div>
<p>You can now configure a mail client to access your new mailserver and
connect to the mailbox for <a class="reference external" href="mailto:example%40localhost">example<span>@</span>localhost</a> via IMAP and see the
message.</p>
</div>
<div class="section" id="checking-carddav-and-caldav">
<h2>Checking CardDAV and CalDAV<a class="headerlink" href="#checking-carddav-and-caldav" title="Permalink to this headline">¶</a></h2>
<p>Modify <code class="docutils literal notranslate"><span class="pre">/etc/cyrus.conf</span></code> and add (or uncomment) this line in the
SERVICES section:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">http</span> <span class="n">cmd</span><span class="o">=</span><span class="s2">"httpd"</span> <span class="n">listen</span><span class="o">=</span><span class="s2">"http"</span> <span class="n">prefork</span><span class="o">=</span><span class="mi">0</span>
</pre></div>
</div>
<p>Modify <code class="docutils literal notranslate"><span class="pre">/etc/imapd.conf</span></code> and add (or uncomment) this line:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">httpmodules</span><span class="p">:</span> <span class="n">caldav</span> <span class="n">carddav</span>
</pre></div>
</div>
<p>Running the following commands should return you sample entry
addressbook and calendar entry for the sample example user:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">curl</span> <span class="o">-</span><span class="n">u</span> <span class="n">example</span><span class="o">@</span><span class="p">[</span><span class="n">hostname</span><span class="p">]:</span><span class="n">mypassword</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">X</span> <span class="n">PROPFIND</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Depth: 1'</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">8080</span><span class="o">/</span><span class="n">dav</span><span class="o">/</span><span class="n">addressbooks</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">example</span><span class="o">@</span><span class="p">[</span><span class="n">hostname</span><span class="p">]</span><span class="o">/</span><span class="n">Default</span>
<span class="n">curl</span> <span class="o">-</span><span class="n">u</span> <span class="n">example</span><span class="o">@</span><span class="p">[</span><span class="n">hostname</span><span class="p">]:</span><span class="n">mypassword</span> <span class="o">-</span><span class="n">i</span> <span class="o">-</span><span class="n">X</span> <span class="n">PROPFIND</span> <span class="o">-</span><span class="n">H</span> <span class="s1">'Depth: 1'</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">8080</span><span class="o">/</span><span class="n">dav</span><span class="o">/</span><span class="n">principals</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">example</span><span class="o">@</span><span class="p">[</span><span class="n">hostname</span><span class="p">]</span><span class="o">/</span>
</pre></div>
</div>
</div>
<hr class="docutils" />
<div class="section" id="troubleshooting">
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
<p>Some common issues are explained below.</p>
<p class="rubric">I have all kinds of weird Perl errors when running cyradm</p>
<p>The solution is to set the Perl library path right. To be honest, I was too lazy to figure out exactly which path was right, so I added this snippet to my <code class="docutils literal notranslate"><span class="pre">~/.bashrc</span></code> file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">PERL5LIB</span><span class="o">=</span><span class="s2">"$PERL5LIB:$(find path/to/cyrus/perl -type d | tr "</span>\\<span class="n">n</span><span class="s2">" "</span><span class="p">:</span><span class="s2">")"</span>
</pre></div>
</div>
<p>Just make sure to change <strong>path/to/cyrus</strong> to the actual path to the Cyrus source code directory. This should be something like <code class="docutils literal notranslate"><span class="pre">/home/jack/cyrus-src/perl</span></code>.</p>
<p class="rubric">I can’t connect to the IMAP server</p>
<p>Make sure that the SASL auth daemon is running. You can start it with this command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">saslauthd</span> <span class="n">start</span>
</pre></div>
</div>
<p>You can safely run this command even if you don’t know whether the SASL auth daemon is already running or not.</p>
<p class="rubric">Emails are not being delivered to Cyrus</p>
<p>Make sure that you have started Sendmail, which you can do like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">sendmail</span> <span class="n">start</span>
</pre></div>
</div>
<p class="rubric">My IMAP server (master) can’t authenticate users to SASL</p>
<p>Check that the groups setting on your cyrus user is correct.</p>
<p>Ubuntu uses <cite>saslauth</cite> group, Debian uses <cite>sasl</cite> group.</p>
<p>Check the output of <cite>groups cyrus</cite> to see what groups it currently belongs to.</p>
<p>Incorrect groups settings results in saslauthd reporting permission failures:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">SASL</span> <span class="n">cannot</span> <span class="n">connect</span> <span class="n">to</span> <span class="n">saslauthd</span> <span class="n">server</span><span class="p">:</span> <span class="n">Permission</span> <span class="n">denied</span>
<span class="n">SASL</span> <span class="n">unable</span> <span class="n">to</span> <span class="nb">open</span> <span class="n">Berkeley</span> <span class="n">db</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">sasldb2</span><span class="p">:</span> <span class="n">Permission</span> <span class="n">denied</span>
</pre></div>
</div>
<p>Master will need to be restarted if you needed to change the groups.</p>
<p class="rubric">Something is not working but I can’t figure out why</p>
<p>More information is almost always logged to <strong>syslog</strong>. Make sure you start syslog with this command before starting the Cyrus server:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">init</span><span class="o">.</span><span class="n">d</span><span class="o">/</span><span class="n">rsyslog</span> <span class="n">start</span>
</pre></div>
</div>
<p class="rubric">My question isn’t answered here</p>
<p>Join us on the <a class="reference internal" href="support/feedback-mailing-lists.html#feedback-mailing-lists"><span class="std std-ref">mailing lists</span></a> if you need help
or just want to chat about Cyrus, IMAP, etc.</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="download/installation/manage-dav.html" class="btn btn-neutral float-right" title="HTTP modules" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="developer/compiling.html" class="btn btn-neutral" title="Compiling" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 1993–2023, The Cyrus Team. Last updated on Jan 08 2022
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3 using a modified <a href="https://readthedocs.org">Read the Docs</a> <a href="https://github.com/snide/sphinx_rtd_theme">theme</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'3.6.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
<!-- jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
}); -->
</script>
</body>
</html>
|
