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
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
|
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="generator" content="hevea 2.09">
<style type="text/css">
.li-itemize{margin:1ex 0ex;}
.li-enumerate{margin:1ex 0ex;}
.dd-description{margin:0ex 0ex 1ex 4ex;}
.dt-description{margin:0ex;}
.toc{list-style:none;}
.footnotetext{margin:0ex; padding:0ex;}
div.footnotetext P{margin:0px; text-indent:1em;}
.thefootnotes{text-align:left;margin:0ex;}
.dt-thefootnotes{margin:0em;}
.dd-thefootnotes{margin:0em 0em 0em 2em;}
.footnoterule{margin:1em auto 1em 0px;width:50%;}
.caption{padding-left:2ex; padding-right:2ex; margin-left:auto; margin-right:auto}
.title{margin:2ex auto;text-align:center}
.titlemain{margin:1ex 2ex 2ex 1ex;}
.titlerest{margin:0ex 2ex;}
.center{text-align:center;margin-left:auto;margin-right:auto;}
.flushleft{text-align:left;margin-left:0ex;margin-right:auto;}
.flushright{text-align:right;margin-left:auto;margin-right:0ex;}
div table{margin-left:inherit;margin-right:inherit;margin-bottom:2px;margin-top:2px}
td table{margin:auto;}
table{border-collapse:collapse;}
td{padding:0;}
.cellpadding0 tr td{padding:0;}
.cellpadding1 tr td{padding:1px;}
pre{text-align:left;margin-left:0ex;margin-right:auto;}
blockquote{margin-left:4ex;margin-right:4ex;text-align:left;}
td p{margin:0px;}
.boxed{border:1px solid black}
.textboxed{border:1px solid black}
.vbar{border:none;width:2px;background-color:black;}
.hbar{border:none;height:2px;width:100%;background-color:black;}
.hfill{border:none;height:1px;width:200%;background-color:black;}
.vdisplay{border-collapse:separate;border-spacing:2px;width:auto; empty-cells:show; border:2px solid red;}
.vdcell{white-space:nowrap;padding:0px; border:2px solid green;}
.display{border-collapse:separate;border-spacing:2px;width:auto; border:none;}
.dcell{white-space:nowrap;padding:0px; border:none;}
.dcenter{margin:0ex auto;}
.vdcenter{border:solid #FF8000 2px; margin:0ex auto;}
.minipage{text-align:left; margin-left:0em; margin-right:auto;}
.marginpar{border:solid thin black; width:20%; text-align:left;}
.marginparleft{float:left; margin-left:0ex; margin-right:1ex;}
.marginparright{float:right; margin-left:1ex; margin-right:0ex;}
.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
.part{margin:2ex auto;text-align:center}
.SPAN{width:20%; float:right; text-align:left; margin-left:auto;}
H1.titlemain HR{display:none;}
TABLE.title{border-top:1px solid grey;border-bottom:1px solid grey; background: #efefef}
H1.chapter A, H2.section A, H3.subsection A, H4.subsubsection A, H5.paragraph A{color:#000000; text-decoration:none;}
H1.chapter, H2.section, H3.subsection, H4.subsubsection, H5.paragraph{border-top: 1px solid grey; background: #efefef; padding: 0.5ex}
pre.verbatim{margin:1ex 2ex;border:1px dashed lightgrey;background-color:#f9f9f9;padding:0.5ex;}
.dt-description{margin:0ex 2ex;}
table[border="1"]{border-collapse:collapse;margin-bottom:1em;}
table[border="1"] td{border:1px solid #aaa;padding:2px}
BLOCKQUOTE.table DIV.center DIV.center HR{display:none;}
BLOCKQUOTE.figure DIV.center DIV.center HR{display:none;}
</style>
<title>
ejabberd community
Installation and Operation Guide
</title>
</head>
<body >
<!--HEVEA command line is: /usr/bin/hevea -fix -pedantic guide.tex -->
<!--CUT STYLE book--><!--CUT DEF chapter 1 --><p><a id="titlepage"></a>
</p><table class="title"><tr><td style="padding:1ex"><h1 class="titlemain">
<hr style="height:2"><br>
<br>
<table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:right;white-space:nowrap" > <span style="font-size:xx-large"><span style="font-weight:bold">ejabberd community 13.12-119-g47a39ce </span></span> </td></tr>
<tr><td style="text-align:right;white-space:nowrap" > </td></tr>
<tr><td style="text-align:right;white-space:nowrap" > <span style="font-size:xx-large">Installation and Operation Guide</span>
</td></tr>
</table><br>
<br>
<hr style="height:2">
</h1></td></tr>
</table><p><a id="toc"></a>
</p><!--TOC chapter id="sec1" Contents-->
<h1 id="sec1" class="chapter">Contents</h1><!--SEC END --><ul class="toc"><li class="li-toc">
<a href="#sec2">Chapter 1  Introduction</a>
<ul class="toc"><li class="li-toc">
<a href="#sec3">1.1  Key Features</a>
</li><li class="li-toc"><a href="#sec4">1.2  Additional Features</a>
</li></ul>
</li><li class="li-toc"><a href="#sec5">Chapter 2  Installing <span style="font-family:monospace">ejabberd</span></a>
<ul class="toc"><li class="li-toc">
<a href="#sec6">2.1  Installing <span style="font-family:monospace">ejabberd</span> with Binary Installer</a>
</li><li class="li-toc"><a href="#sec7">2.2  Installing <span style="font-family:monospace">ejabberd</span> with Operating System Specific Packages</a>
</li><li class="li-toc"><a href="#sec8">2.3  Installing <span style="font-family:monospace">ejabberd</span> with CEAN</a>
</li><li class="li-toc"><a href="#sec9">2.4  Installing <span style="font-family:monospace">ejabberd</span> from Source Code</a>
<ul class="toc"><li class="li-toc">
<a href="#sec10">2.4.1  Requirements</a>
</li><li class="li-toc"><a href="#sec11">2.4.2  Download Source Code</a>
</li><li class="li-toc"><a href="#sec12">2.4.3  Compile</a>
</li><li class="li-toc"><a href="#sec13">2.4.4  Install</a>
</li><li class="li-toc"><a href="#sec14">2.4.5  Start</a>
</li><li class="li-toc"><a href="#sec15">2.4.6  Specific Notes for BSD</a>
</li><li class="li-toc"><a href="#sec16">2.4.7  Specific Notes for Sun Solaris</a>
</li><li class="li-toc"><a href="#sec17">2.4.8  Specific Notes for Microsoft Windows</a>
</li></ul>
</li><li class="li-toc"><a href="#sec20">2.5  Create an XMPP Account for Administration</a>
</li><li class="li-toc"><a href="#sec21">2.6  Upgrading <span style="font-family:monospace">ejabberd</span></a>
</li></ul>
</li><li class="li-toc"><a href="#sec22">Chapter 3  Configuring <span style="font-family:monospace">ejabberd</span></a>
<ul class="toc"><li class="li-toc">
<a href="#sec23">3.1  Basic Configuration</a>
<ul class="toc"><li class="li-toc">
<a href="#sec24">3.1.1  Legacy Configuration File</a>
</li><li class="li-toc"><a href="#sec25">3.1.2  Host Names</a>
</li><li class="li-toc"><a href="#sec26">3.1.3  Virtual Hosting</a>
</li><li class="li-toc"><a href="#sec27">3.1.4  Listening Ports</a>
</li><li class="li-toc"><a href="#sec32">3.1.5  Authentication</a>
</li><li class="li-toc"><a href="#sec37">3.1.6  Access Rules</a>
</li><li class="li-toc"><a href="#sec42">3.1.7  Shapers</a>
</li><li class="li-toc"><a href="#sec43">3.1.8  Default Language</a>
</li><li class="li-toc"><a href="#sec44">3.1.9  CAPTCHA</a>
</li><li class="li-toc"><a href="#sec45">3.1.10  STUN</a>
</li><li class="li-toc"><a href="#sec46">3.1.11  SIP</a>
</li><li class="li-toc"><a href="#sec47">3.1.12  Include Additional Configuration Files</a>
</li><li class="li-toc"><a href="#sec48">3.1.13  Option Macros in Configuration File</a>
</li></ul>
</li><li class="li-toc"><a href="#sec49">3.2  Database and LDAP Configuration</a>
<ul class="toc"><li class="li-toc">
<a href="#sec50">3.2.1  ODBC</a>
</li><li class="li-toc"><a href="#sec52">3.2.2  LDAP</a>
</li></ul>
</li><li class="li-toc"><a href="#sec58">3.3  Modules Configuration</a>
<ul class="toc"><li class="li-toc">
<a href="#sec59">3.3.1  Modules Overview</a>
</li><li class="li-toc"><a href="#sec60">3.3.2  Common Options</a>
</li><li class="li-toc"><a href="#sec63">3.3.3  <span style="font-family:monospace">mod_announce</span></a>
</li><li class="li-toc"><a href="#sec64">3.3.4  <span style="font-family:monospace">mod_disco</span></a>
</li><li class="li-toc"><a href="#sec65">3.3.5  <span style="font-family:monospace">mod_echo</span></a>
</li><li class="li-toc"><a href="#sec66">3.3.6  <span style="font-family:monospace">mod_http_bind</span></a>
</li><li class="li-toc"><a href="#sec67">3.3.7  <span style="font-family:monospace">mod_http_fileserver</span></a>
</li><li class="li-toc"><a href="#sec68">3.3.8  <span style="font-family:monospace">mod_irc</span></a>
</li><li class="li-toc"><a href="#sec69">3.3.9  <span style="font-family:monospace">mod_last</span></a>
</li><li class="li-toc"><a href="#sec70">3.3.10  <span style="font-family:monospace">mod_muc</span></a>
</li><li class="li-toc"><a href="#sec71">3.3.11  <span style="font-family:monospace">mod_muc_log</span></a>
</li><li class="li-toc"><a href="#sec72">3.3.12  <span style="font-family:monospace">mod_offline</span></a>
</li><li class="li-toc"><a href="#sec73">3.3.13  <span style="font-family:monospace">mod_ping</span></a>
</li><li class="li-toc"><a href="#sec74">3.3.14  <span style="font-family:monospace">mod_pres_counter</span></a>
</li><li class="li-toc"><a href="#sec75">3.3.15  <span style="font-family:monospace">mod_privacy</span></a>
</li><li class="li-toc"><a href="#sec76">3.3.16  <span style="font-family:monospace">mod_private</span></a>
</li><li class="li-toc"><a href="#sec77">3.3.17  <span style="font-family:monospace">mod_proxy65</span></a>
</li><li class="li-toc"><a href="#sec78">3.3.18  <span style="font-family:monospace">mod_pubsub</span></a>
</li><li class="li-toc"><a href="#sec79">3.3.19  <span style="font-family:monospace">mod_register</span></a>
</li><li class="li-toc"><a href="#sec80">3.3.20  <span style="font-family:monospace">mod_register_web</span></a>
</li><li class="li-toc"><a href="#sec81">3.3.21  <span style="font-family:monospace">mod_roster</span></a>
</li><li class="li-toc"><a href="#sec82">3.3.22  <span style="font-family:monospace">mod_service_log</span></a>
</li><li class="li-toc"><a href="#sec83">3.3.23  <span style="font-family:monospace">mod_shared_roster</span></a>
</li><li class="li-toc"><a href="#sec84">3.3.24  <span style="font-family:monospace">mod_shared_roster_ldap</span></a>
</li><li class="li-toc"><a href="#sec94">3.3.25  <span style="font-family:monospace">mod_sic</span></a>
</li><li class="li-toc"><a href="#sec95">3.3.26  <span style="font-family:monospace">mod_sip</span></a>
</li><li class="li-toc"><a href="#sec96">3.3.27  <span style="font-family:monospace">mod_stats</span></a>
</li><li class="li-toc"><a href="#sec97">3.3.28  <span style="font-family:monospace">mod_time</span></a>
</li><li class="li-toc"><a href="#sec98">3.3.29  <span style="font-family:monospace">mod_vcard</span></a>
</li><li class="li-toc"><a href="#sec99">3.3.30  <span style="font-family:monospace">mod_vcard_ldap</span></a>
</li><li class="li-toc"><a href="#sec100">3.3.31  <span style="font-family:monospace">mod_vcard_xupdate</span></a>
</li><li class="li-toc"><a href="#sec101">3.3.32  <span style="font-family:monospace">mod_version</span></a>
</li></ul>
</li></ul>
</li><li class="li-toc"><a href="#sec102">Chapter 4  Managing an <span style="font-family:monospace">ejabberd</span> Server</a>
<ul class="toc"><li class="li-toc">
<a href="#sec103">4.1  <span style="font-family:monospace">ejabberdctl</span></a>
<ul class="toc"><li class="li-toc">
<a href="#sec104">4.1.1  ejabberdctl Commands</a>
</li><li class="li-toc"><a href="#sec105">4.1.2  Erlang Runtime System</a>
</li></ul>
</li><li class="li-toc"><a href="#sec106">4.2  <span style="font-family:monospace">ejabberd</span> Commands</a>
<ul class="toc"><li class="li-toc">
<a href="#sec107">4.2.1  List of ejabberd Commands</a>
</li><li class="li-toc"><a href="#sec108">4.2.2  Restrict Execution with AccessCommands</a>
</li></ul>
</li><li class="li-toc"><a href="#sec109">4.3  Web Admin</a>
</li><li class="li-toc"><a href="#sec110">4.4  Ad-hoc Commands</a>
</li><li class="li-toc"><a href="#sec111">4.5  Change Computer Hostname</a>
</li></ul>
</li><li class="li-toc"><a href="#sec112">Chapter 5  Securing <span style="font-family:monospace">ejabberd</span></a>
<ul class="toc"><li class="li-toc">
<a href="#sec113">5.1  Firewall Settings</a>
</li><li class="li-toc"><a href="#sec114">5.2  epmd</a>
</li><li class="li-toc"><a href="#sec115">5.3  Erlang Cookie</a>
</li><li class="li-toc"><a href="#sec116">5.4  Erlang Node Name</a>
</li><li class="li-toc"><a href="#sec117">5.5  Securing Sensitive Files</a>
</li></ul>
</li><li class="li-toc"><a href="#sec118">Chapter 6  Clustering</a>
<ul class="toc"><li class="li-toc">
<a href="#sec119">6.1  How it Works</a>
<ul class="toc"><li class="li-toc">
<a href="#sec120">6.1.1  Router</a>
</li><li class="li-toc"><a href="#sec121">6.1.2  Local Router</a>
</li><li class="li-toc"><a href="#sec122">6.1.3  Session Manager</a>
</li><li class="li-toc"><a href="#sec123">6.1.4  s2s Manager</a>
</li></ul>
</li><li class="li-toc"><a href="#sec124">6.2  Clustering Setup</a>
</li><li class="li-toc"><a href="#sec125">6.3  Service Load-Balancing</a>
<ul class="toc"><li class="li-toc">
<a href="#sec126">6.3.1  Domain Load-Balancing Algorithm</a>
</li><li class="li-toc"><a href="#sec127">6.3.2  Load-Balancing Buckets</a>
</li></ul>
</li></ul>
</li><li class="li-toc"><a href="#sec128">Chapter 7  Debugging</a>
<ul class="toc"><li class="li-toc">
<a href="#sec129">7.1  Log Files</a>
</li><li class="li-toc"><a href="#sec130">7.2  Debug Console</a>
</li><li class="li-toc"><a href="#sec131">7.3  Watchdog Alerts</a>
</li></ul>
</li><li class="li-toc"><a href="#sec132">Appendix A  Internationalization and Localization</a>
</li><li class="li-toc"><a href="#sec133">Appendix B  Release Notes</a>
</li><li class="li-toc"><a href="#sec134">Appendix C  Acknowledgements</a>
</li><li class="li-toc"><a href="#sec135">Appendix D  Copyright Information</a>
</li></ul>
<!--TOC chapter id="sec2" Introduction-->
<h1 id="sec2" class="chapter">Chapter 1  Introduction</h1><!--SEC END --><p>
<a id="intro"></a></p><p><span style="font-family:monospace">ejabberd</span> is a free and open source instant messaging server written in <a href="http://www.erlang.org/">Erlang/OTP</a>.</p><p><span style="font-family:monospace">ejabberd</span> is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.</p><p><span style="font-family:monospace">ejabberd</span> is designed to be a rock-solid and feature rich XMPP server.</p><p><span style="font-family:monospace">ejabberd</span> is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.</p>
<!--TOC section id="sec3" Key Features-->
<h2 id="sec3" class="section">1.1  Key Features</h2><!--SEC END --><p>
<a id="keyfeatures"></a>
</p><p><span style="font-family:monospace">ejabberd</span> is:
</p><ul class="itemize"><li class="li-itemize">
Cross-platform: <span style="font-family:monospace">ejabberd</span> runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.</li><li class="li-itemize">Distributed: You can run <span style="font-family:monospace">ejabberd</span> on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.</li><li class="li-itemize">Fault-tolerant: You can deploy an <span style="font-family:monospace">ejabberd</span> cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘on the fly’.</li><li class="li-itemize">Administrator Friendly: <span style="font-family:monospace">ejabberd</span> is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include:
<ul class="itemize"><li class="li-itemize">
Comprehensive documentation.
</li><li class="li-itemize">Straightforward installers for Linux, Mac OS X, and Windows. </li><li class="li-itemize">Web Administration.
</li><li class="li-itemize">Shared Roster Groups.
</li><li class="li-itemize">Command line administration tool. </li><li class="li-itemize">Can integrate with existing authentication mechanisms.
</li><li class="li-itemize">Capability to send announce messages.
</li></ul></li><li class="li-itemize">Internationalized: <span style="font-family:monospace">ejabberd</span> leads in internationalization. Hence it is very well suited in a globalized world. Related features are:
<ul class="itemize"><li class="li-itemize">
Translated to 25 languages. </li><li class="li-itemize">Support for <a href="http://www.ietf.org/rfc/rfc3490.txt">IDNA</a>.
</li></ul></li><li class="li-itemize">Open Standards: <span style="font-family:monospace">ejabberd</span> is the first Open Source Jabber server claiming to fully comply to the XMPP standard.
<ul class="itemize"><li class="li-itemize">
Fully XMPP compliant.
</li><li class="li-itemize">XML-based protocol.
</li><li class="li-itemize"><a href="http://www.ejabberd.im/protocols">Many protocols supported</a>.
</li></ul></li></ul>
<!--TOC section id="sec4" Additional Features-->
<h2 id="sec4" class="section">1.2  Additional Features</h2><!--SEC END --><p>
<a id="addfeatures"></a>
</p><p>Moreover, <span style="font-family:monospace">ejabberd</span> comes with a wide range of other state-of-the-art features:
</p><ul class="itemize"><li class="li-itemize">
Modular
<ul class="itemize"><li class="li-itemize">
Load only the modules you want.
</li><li class="li-itemize">Extend <span style="font-family:monospace">ejabberd</span> with your own custom modules.
</li></ul>
</li><li class="li-itemize">Security
<ul class="itemize"><li class="li-itemize">
SASL and STARTTLS for c2s and s2s connections.
</li><li class="li-itemize">STARTTLS and Dialback s2s connections.
</li><li class="li-itemize">Web Admin accessible via HTTPS secure access.
</li></ul>
</li><li class="li-itemize">Databases
<ul class="itemize"><li class="li-itemize">
Internal database for fast deployment (Mnesia).
</li><li class="li-itemize">Native MySQL support.
</li><li class="li-itemize">Native PostgreSQL support.
</li><li class="li-itemize">ODBC data storage support.
</li><li class="li-itemize">Microsoft SQL Server support. </li></ul>
</li><li class="li-itemize">Authentication
<ul class="itemize"><li class="li-itemize">
Internal Authentication.
</li><li class="li-itemize">PAM, LDAP and ODBC. </li><li class="li-itemize">External Authentication script.
</li></ul>
</li><li class="li-itemize">Others
<ul class="itemize"><li class="li-itemize">
Support for virtual hosting.
</li><li class="li-itemize">Compressing XML streams with Stream Compression (<a href="http://xmpp.org/extensions/xep-0138.html">XEP-0138</a>).
</li><li class="li-itemize">Statistics via Statistics Gathering (<a href="http://xmpp.org/extensions/xep-0039.html">XEP-0039</a>).
</li><li class="li-itemize">IPv6 support both for c2s and s2s connections.
</li><li class="li-itemize"><a href="http://xmpp.org/extensions/xep-0045.html">Multi-User Chat</a> module with support for clustering and HTML logging. </li><li class="li-itemize">Users Directory based on users vCards.
</li><li class="li-itemize"><a href="http://xmpp.org/extensions/xep-0060.html">Publish-Subscribe</a> component with support for <a href="http://xmpp.org/extensions/xep-0163.html">Personal Eventing via Pubsub</a>.
</li><li class="li-itemize">Support for web clients: <a href="http://xmpp.org/extensions/xep-0025.html">HTTP Polling</a> and <a href="http://xmpp.org/extensions/xep-0206.html">HTTP Binding (BOSH)</a> services.
</li><li class="li-itemize">IRC transport.
</li><li class="li-itemize">SIP support.
</li><li class="li-itemize">Component support: interface with networks such as AIM, ICQ and MSN installing special tranports.
</li></ul>
</li></ul><p> <a id="installing"></a> </p>
<!--TOC chapter id="sec5" Installing <span style="font-family:monospace">ejabberd</span>-->
<h1 id="sec5" class="chapter">Chapter 2  <a href="#installing">Installing <span style="font-family:monospace">ejabberd</span></a></h1><!--SEC END --><p> <a id="installing"></a> </p><p> <a id="install.binary"></a> </p>
<!--TOC section id="sec6" Installing <span style="font-family:monospace">ejabberd</span> with Binary Installer-->
<h2 id="sec6" class="section">2.1  <a href="#install.binary">Installing <span style="font-family:monospace">ejabberd</span> with Binary Installer</a></h2><!--SEC END --><p> <a id="install.binary"></a> </p><p>Probably the easiest way to install an <span style="font-family:monospace">ejabberd</span> instant messaging server
is using the binary installer published by ProcessOne.
The binary installers of released <span style="font-family:monospace">ejabberd</span> versions
are available in the ProcessOne <span style="font-family:monospace">ejabberd</span> downloads page:
<a href="http://www.process-one.net/en/ejabberd/downloads"><span style="font-family:monospace">http://www.process-one.net/en/ejabberd/downloads</span></a></p><p>The installer will deploy and configure a full featured <span style="font-family:monospace">ejabberd</span>
server and does not require any extra dependencies.</p><p>In *nix systems, remember to set executable the binary installer before starting it. For example:
</p><pre class="verbatim">chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin
./ejabberd-2.0.0_1-linux-x86-installer.bin
</pre><p><span style="font-family:monospace">ejabberd</span> can be started manually at any time,
or automatically by the operating system at system boot time.</p><p>To start and stop <span style="font-family:monospace">ejabberd</span> manually,
use the desktop shortcuts created by the installer.
If the machine doesn’t have a graphical system, use the scripts ’start’
and ’stop’ in the ’bin’ directory where <span style="font-family:monospace">ejabberd</span> is installed.</p><p>The Windows installer also adds ejabberd as a system service,
and a shortcut to a debug console for experienced administrators.
If you want ejabberd to be started automatically at boot time,
go to the Windows service settings and set ejabberd to be automatically started.
Note that the Windows service is a feature still in development,
and for example it doesn’t read the file ejabberdctl.cfg.</p><p>On a *nix system, if you want ejabberd to be started as daemon at boot time,
copy <span style="font-family:monospace">ejabberd.init</span> from the ’bin’ directory to something like <span style="font-family:monospace">/etc/init.d/ejabberd</span>
(depending on your distribution).
Create a system user called <span style="font-family:monospace">ejabberd</span>,
give it write access to the directories <span style="font-family:monospace">database/</span> and <span style="font-family:monospace">logs/</span>, and set that as home;
the script will start the server with that user.
Then you can call <span style="font-family:monospace">/etc/inid.d/ejabberd start</span> as root to start the server.</p><p>When ejabberd is started, the processes that are started in the system
are <span style="font-family:monospace">beam</span> or <span style="font-family:monospace">beam.smp</span>, and also <span style="font-family:monospace">epmd</span>.
In Microsoft Windows, the processes are <span style="font-family:monospace">erl.exe</span> and <span style="font-family:monospace">epmd.exe</span>.
For more information regarding <span style="font-family:monospace">epmd</span> consult the section <a href="#epmd">5.2</a>.</p><p>If <span style="font-family:monospace">ejabberd</span> doesn’t start correctly in Windows,
try to start it using the shortcut in desktop or start menu.
If the window shows error 14001, the solution is to install:
"Microsoft Visual C++ 2005 SP1 Redistributable Package".
You can download it from
<a href="http://www.microsoft.com/">www.microsoft.com</a>.
Then uninstall <span style="font-family:monospace">ejabberd</span> and install it again.</p><p>If <span style="font-family:monospace">ejabberd</span> doesn’t start correctly and a crash dump is generated,
there was a severe problem.
You can try starting <span style="font-family:monospace">ejabberd</span> with
the script <span style="font-family:monospace">bin/live.bat</span> in Windows,
or with the command <span style="font-family:monospace">bin/ejabberdctl live</span> in other Operating Systems.
This way you see the error message provided by Erlang
and can identify what is exactly the problem.</p><p>The <span style="font-family:monospace">ejabberdctl</span> administration script is included in the <span style="font-family:monospace">bin</span> directory.
Please refer to the section <a href="#ejabberdctl">4.1</a> for details about <span style="font-family:monospace">ejabberdctl</span>,
and configurable options to fine tune the Erlang runtime system.</p><p> <a id="install.os"></a> </p>
<!--TOC section id="sec7" Installing <span style="font-family:monospace">ejabberd</span> with Operating System Specific Packages-->
<h2 id="sec7" class="section">2.2  <a href="#install.os">Installing <span style="font-family:monospace">ejabberd</span> with Operating System Specific Packages</a></h2><!--SEC END --><p> <a id="install.os"></a> </p><p>Some Operating Systems provide a specific <span style="font-family:monospace">ejabberd</span> package adapted to
the system architecture and libraries.
It usually also checks dependencies
and performs basic configuration tasks like creating the initial
administrator account. Some examples are Debian and Gentoo. Consult the
resources provided by your Operating System for more information.</p><p>Usually those packages create a script like <span style="font-family:monospace">/etc/init.d/ejabberd</span>
to start and stop <span style="font-family:monospace">ejabberd</span> as a service at boot time.</p><p> <a id="install.cean"></a> </p>
<!--TOC section id="sec8" Installing <span style="font-family:monospace">ejabberd</span> with CEAN-->
<h2 id="sec8" class="section">2.3  <a href="#install.cean">Installing <span style="font-family:monospace">ejabberd</span> with CEAN</a></h2><!--SEC END --><p> <a id="install.cean"></a> </p><p><a href="http://cean.process-one.net/">CEAN</a>
(Comprehensive Erlang Archive Network) is a repository that hosts binary
packages from many Erlang programs, including <span style="font-family:monospace">ejabberd</span> and all its dependencies.
The binaries are available for many different system architectures, so this is an
alternative to the binary installer and Operating System’s <span style="font-family:monospace">ejabberd</span> packages.</p><p>You will have to create your own <span style="font-family:monospace">ejabberd</span> start
script depending of how you handle your CEAN installation.
The default <span style="font-family:monospace">ejabberdctl</span> script is located
into <span style="font-family:monospace">ejabberd</span>’s priv directory and can be used as an example.</p><p> <a id="installation"></a> </p>
<!--TOC section id="sec9" Installing <span style="font-family:monospace">ejabberd</span> from Source Code-->
<h2 id="sec9" class="section">2.4  <a href="#installation">Installing <span style="font-family:monospace">ejabberd</span> from Source Code</a></h2><!--SEC END --><p> <a id="installation"></a>
</p><p>The canonical form for distribution of <span style="font-family:monospace">ejabberd</span> stable releases is the source code package.
Compiling <span style="font-family:monospace">ejabberd</span> from source code is quite easy in *nix systems,
as long as your system have all the dependencies.</p><p> <a id="installreq"></a> </p>
<!--TOC subsection id="sec10" Requirements-->
<h3 id="sec10" class="subsection">2.4.1  <a href="#installreq">Requirements</a></h3><!--SEC END --><p> <a id="installreq"></a>
</p><p>To compile <span style="font-family:monospace">ejabberd</span> on a ‘Unix-like’ operating system, you need:
</p><ul class="itemize"><li class="li-itemize">
GNU Make
</li><li class="li-itemize">GCC
</li><li class="li-itemize">pkg-config
</li><li class="li-itemize">Libexpat 1.95 or higher
</li><li class="li-itemize">Erlang/OTP R15B or higher.
</li><li class="li-itemize">Libyaml 1.4 or higher
</li><li class="li-itemize">OpenSSL 0.9.8 or higher, for STARTTLS, SASL and SSL encryption.
</li><li class="li-itemize">Zlib 1.2.3 or higher, for Stream Compression support (<a href="http://xmpp.org/extensions/xep-0138.html">XEP-0138</a>). Optional.
</li><li class="li-itemize">PAM library. Optional. For Pluggable Authentication Modules (PAM). See section <a href="#pam">3.1.5</a>.
</li><li class="li-itemize">GNU Iconv 1.8 or higher, for the IRC Transport (mod_irc). Optional. Not needed on systems with GNU Libc. See section <a href="#modirc">3.3.8</a>.
</li><li class="li-itemize">ImageMagick’s Convert program. Optional. For CAPTCHA challenges. See section <a href="#captcha">3.1.9</a>.
</li><li class="li-itemize">exmpp 0.9.6 or higher. Optional. For import/export user data with <a href="http://xmpp.org/extensions/xep-0227.html">XEP-0227</a> XML files.
</li></ul><p> <a id="download"></a> </p>
<!--TOC subsection id="sec11" Download Source Code-->
<h3 id="sec11" class="subsection">2.4.2  <a href="#download">Download Source Code</a></h3><!--SEC END --><p> <a id="download"></a>
</p><p>Released versions of <span style="font-family:monospace">ejabberd</span> are available in the ProcessOne <span style="font-family:monospace">ejabberd</span> downloads page:
<a href="http://www.process-one.net/en/ejabberd/downloads"><span style="font-family:monospace">http://www.process-one.net/en/ejabberd/downloads</span></a></p><p>
Alternatively, the latest development source code can be retrieved from the Git repository using the commands:
</p><pre class="verbatim">git clone git://github.com/processone/ejabberd.git ejabberd
cd ejabberd
git checkout -b 2.1.x origin/2.1.x
</pre><p> <a id="compile"></a> </p>
<!--TOC subsection id="sec12" Compile-->
<h3 id="sec12" class="subsection">2.4.3  <a href="#compile">Compile</a></h3><!--SEC END --><p> <a id="compile"></a>
</p><p>To compile <span style="font-family:monospace">ejabberd</span> execute the commands:
</p><pre class="verbatim">./configure
make
</pre><p>The build configuration script allows several options.
To get the full list run the command:
</p><pre class="verbatim">./configure --help
</pre><p>Some options that you may be interested in modifying:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">--prefix=/</span></span></dt><dd class="dd-description">
Specify the path prefix where the files will be copied when running
the <span style="font-family:monospace">make install</span> command.<p> </p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-user[=USER]</span></span></dt><dd class="dd-description">
Allow this normal system user to execute the ejabberdctl script
(see section <a href="#ejabberdctl">4.1</a>),
read the configuration files,
read and write in the spool directory,
read and write in the log directory.
The account user and group must exist in the machine
before running <span style="font-family:monospace">make install</span>.
This account doesn’t need an explicit HOME directory, because
<span style="font-family:monospace">/var/lib/ejabberd/</span> will be used by default.<p> </p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-pam</span></span></dt><dd class="dd-description">
Enable the PAM authentication method (see section <a href="#pam">3.1.5</a>).<p> </p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-mssql</span></span></dt><dd class="dd-description">
Required if you want to use an external database.
See section <a href="#database">3.2</a> for more information.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-tools</span></span></dt><dd class="dd-description">
Enable the use of development tools.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-mysql</span></span></dt><dd class="dd-description">
Enable MySQL support (see section <a href="#odbc">3.2.1</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-pgsql</span></span></dt><dd class="dd-description">
Enable PostgreSQL support (see section <a href="#odbc">3.2.1</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-zlib</span></span></dt><dd class="dd-description">
Enable Stream Compression (XEP-0138) using zlib.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-stun</span></span></dt><dd class="dd-description">
Enable STUN support (see section <a href="#stun">3.1.10</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-iconv</span></span></dt><dd class="dd-description">
Enable iconv support. This is needed for <span style="font-family:monospace">mod_irc</span> (see seciont <a href="#modirc">3.3.8</a>).</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-debug</span></span></dt><dd class="dd-description">
Compile with <span style="font-family:monospace">+debug_info</span> enabled.<p> </p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-full-xml</span></span></dt><dd class="dd-description">
Enable the use of XML based optimisations.
It will for example use CDATA to escape characters in the XMPP stream.
Use this option only if you are sure your XMPP clients include a fully compliant XML parser.<p> </p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--disable-transient-supervisors</span></span></dt><dd class="dd-description">
Disable the use of Erlang/OTP supervision for transient processes.<p> </p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">--enable-nif</span></span></dt><dd class="dd-description">
Replaces some critical Erlang functions with equivalents written in C to improve performance.
</dd></dl><p> <a id="install"></a> </p>
<!--TOC subsection id="sec13" Install-->
<h3 id="sec13" class="subsection">2.4.4  <a href="#install">Install</a></h3><!--SEC END --><p> <a id="install"></a>
</p><p>To install <span style="font-family:monospace">ejabberd</span> in the destination directories, run the command:
</p><pre class="verbatim">make install
</pre><p>Note that you probably need administrative privileges in the system
to install <span style="font-family:monospace">ejabberd</span>.</p><p>The files and directories created are, by default:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">/etc/ejabberd/</span></span></dt><dd class="dd-description"> Configuration directory:
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ejabberd.yml</span></span></dt><dd class="dd-description"> ejabberd configuration file
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberdctl.cfg</span></span></dt><dd class="dd-description"> Configuration file of the administration script
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">inetrc</span></span></dt><dd class="dd-description"> Network DNS configuration file
</dd></dl>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">/lib/ejabberd/</span></span></dt><dd class="dd-description">
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ebin/</span></span></dt><dd class="dd-description"> Erlang binary files (*.beam)
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">include/</span></span></dt><dd class="dd-description"> Erlang header files (*.hrl)
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">priv/</span></span></dt><dd class="dd-description"> Additional files required at runtime
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">bin/</span></span></dt><dd class="dd-description"> Executable programs
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">lib/</span></span></dt><dd class="dd-description"> Binary system libraries (*.so)
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">msgs/</span></span></dt><dd class="dd-description"> Translation files (*.msgs)
</dd></dl>
</dd></dl>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">/sbin/ejabberdctl</span></span></dt><dd class="dd-description"> Administration script (see section <a href="#ejabberdctl">4.1</a>)
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">/share/doc/ejabberd/</span></span></dt><dd class="dd-description"> Documentation of ejabberd
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">/var/lib/ejabberd/</span></span></dt><dd class="dd-description"> Spool directory:
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">.erlang.cookie</span></span></dt><dd class="dd-description"> Erlang cookie file (see section <a href="#cookie">5.3</a>)
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">acl.DCD, ...</span></span></dt><dd class="dd-description"> Mnesia database spool files (*.DCD, *.DCL, *.DAT)
</dd></dl>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">/var/log/ejabberd/</span></span></dt><dd class="dd-description"> Log directory (see section <a href="#logfiles">7.1</a>):
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ejabberd.log</span></span></dt><dd class="dd-description"> ejabberd service log
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">erlang.log</span></span></dt><dd class="dd-description"> Erlang/OTP system log
</dd></dl>
</dd></dl><p> <a id="start"></a> </p>
<!--TOC subsection id="sec14" Start-->
<h3 id="sec14" class="subsection">2.4.5  <a href="#start">Start</a></h3><!--SEC END --><p> <a id="start"></a>
</p><p>You can use the <span style="font-family:monospace">ejabberdctl</span> command line administration script to start and stop <span style="font-family:monospace">ejabberd</span>.
If you provided the configure option <span style="font-family:monospace">--enable-user=USER</span> (see <a href="#compile">2.4.3</a>),
you can execute <span style="font-family:monospace">ejabberdctl</span> with either that system account or root.</p><p>Usage example:
</p><pre class="verbatim">ejabberdctl start
ejabberdctl status
The node ejabberd@localhost is started with status: started
ejabberd is running in that node
ejabberdctl stop
</pre><p>If <span style="font-family:monospace">ejabberd</span> doesn’t start correctly and a crash dump is generated,
there was a severe problem.
You can try starting <span style="font-family:monospace">ejabberd</span> with
the command <span style="font-family:monospace">ejabberdctl live</span>
to see the error message provided by Erlang
and can identify what is exactly the problem.</p><p>Please refer to the section <a href="#ejabberdctl">4.1</a> for details about <span style="font-family:monospace">ejabberdctl</span>,
and configurable options to fine tune the Erlang runtime system.</p><p>If you want ejabberd to be started as daemon at boot time,
copy <span style="font-family:monospace">ejabberd.init</span> to something like <span style="font-family:monospace">/etc/init.d/ejabberd</span>
(depending on your distribution).
Create a system user called <span style="font-family:monospace">ejabberd</span>;
it will be used by the script to start the server.
Then you can call <span style="font-family:monospace">/etc/inid.d/ejabberd start</span> as root to start the server.</p><p> <a id="bsd"></a> </p>
<!--TOC subsection id="sec15" Specific Notes for BSD-->
<h3 id="sec15" class="subsection">2.4.6  <a href="#bsd">Specific Notes for BSD</a></h3><!--SEC END --><p> <a id="bsd"></a>
</p><p>The command to compile <span style="font-family:monospace">ejabberd</span> in BSD systems is:
</p><pre class="verbatim">gmake
</pre><p> <a id="solaris"></a> </p>
<!--TOC subsection id="sec16" Specific Notes for Sun Solaris-->
<h3 id="sec16" class="subsection">2.4.7  <a href="#solaris">Specific Notes for Sun Solaris</a></h3><!--SEC END --><p> <a id="solaris"></a>
</p><p>You need to have <span style="font-family:monospace">GNU install</span>,
but it isn’t included in Solaris.
It can be easily installed if your Solaris system
is set up for <a href="http://www.blastwave.org/">blastwave.org</a>
package repository.
Make sure <span style="font-family:monospace">/opt/csw/bin</span> is in your <span style="font-family:monospace">PATH</span> and run:
</p><pre class="verbatim">pkg-get -i fileutils
</pre><p>If that program is called <span style="font-family:monospace">ginstall</span>,
modify the <span style="font-family:monospace">ejabberd</span> <span style="font-family:monospace">Makefile</span> script to suit your system,
for example:
</p><pre class="verbatim">cat Makefile | sed s/install/ginstall/ > Makefile.gi
</pre><p>And finally install <span style="font-family:monospace">ejabberd</span> with:
</p><pre class="verbatim">gmake -f Makefile.gi ginstall
</pre><p> <a id="windows"></a> </p>
<!--TOC subsection id="sec17" Specific Notes for Microsoft Windows-->
<h3 id="sec17" class="subsection">2.4.8  <a href="#windows">Specific Notes for Microsoft Windows</a></h3><!--SEC END --><p> <a id="windows"></a>
</p><p> <a id="windowsreq"></a> </p>
<!--TOC subsubsection id="sec18" Requirements-->
<h4 id="sec18" class="subsubsection"><a href="#windowsreq">Requirements</a></h4><!--SEC END --><p> <a id="windowsreq"></a> </p><p>To compile <span style="font-family:monospace">ejabberd</span> on a Microsoft Windows system, you need:
</p><ul class="itemize"><li class="li-itemize">
MS Visual C++ 6.0 Compiler
</li><li class="li-itemize"><a href="http://www.erlang.org/download.html">Erlang/OTP R11B-5</a>
</li><li class="li-itemize"><a href="http://sourceforge.net/project/showfiles.php?group_id=10127&package_id=11277">Expat 2.0.0 or higher</a>
</li><li class="li-itemize"><a href="http://www.gnu.org/software/libiconv/">GNU Iconv 1.9.2</a>
(optional)
</li><li class="li-itemize"><a href="http://www.slproweb.com/products/Win32OpenSSL.html">Shining Light OpenSSL 0.9.8d or higher</a>
(to enable SSL connections)
</li><li class="li-itemize"><a href="http://www.zlib.net/">Zlib 1.2.3 or higher</a>
</li></ul><p> <a id="windowscom"></a> </p>
<!--TOC subsubsection id="sec19" Compilation-->
<h4 id="sec19" class="subsubsection"><a href="#windowscom">Compilation</a></h4><!--SEC END --><p> <a id="windowscom"></a> </p><p>We assume that we will try to put as much library as possible into <code>C:\sdk\</code> to make it easier to track what is install for <span style="font-family:monospace">ejabberd</span>.</p><ol class="enumerate" type=1><li class="li-enumerate">
Install Erlang emulator (for example, into <code>C:\sdk\erl5.5.5</code>).
</li><li class="li-enumerate">Install Expat library into <code>C:\sdk\Expat-2.0.0</code>
directory.<p>Copy file <code>C:\sdk\Expat-2.0.0\Libs\libexpat.dll</code>
to your Windows system directory (for example, <code>C:\WINNT</code> or
<code>C:\WINNT\System32</code>)
</p></li><li class="li-enumerate">Build and install the Iconv library into the directory
<code>C:\sdk\GnuWin32</code>.<p>Copy file <code>C:\sdk\GnuWin32\bin\lib*.dll</code> to your
Windows system directory (more installation instructions can be found in the
file README.woe32 in the iconv distribution).</p><p>Note: instead of copying libexpat.dll and iconv.dll to the Windows
directory, you can add the directories
<code>C:\sdk\Expat-2.0.0\Libs</code> and
<code>C:\sdk\GnuWin32\bin</code> to the <code>PATH</code> environment
variable.
</p></li><li class="li-enumerate">Install OpenSSL in <code>C:\sdk\OpenSSL</code> and add <code>C:\sdk\OpenSSL\lib\VC</code> to your path or copy the binaries to your system directory.
</li><li class="li-enumerate">Install ZLib in <code>C:\sdk\gnuWin32</code>. Copy
<code>C:\sdk\GnuWin32\bin\zlib1.dll</code> to your system directory. If you change your path it should already be set after libiconv install.
</li><li class="li-enumerate">Make sure the you can access Erlang binaries from your path. For example: <code>set PATH=%PATH%;"C:\sdk\erl5.6.5\bin"</code>
</li><li class="li-enumerate">Depending on how you end up actually installing the library you might need to check and tweak the paths in the file configure.erl.
</li><li class="li-enumerate">While in the directory <code>ejabberd\src</code> run:
<pre class="verbatim">configure.bat
nmake -f Makefile.win32
</pre></li><li class="li-enumerate">Edit the file <code>ejabberd\src\ejabberd.yml</code> and run
<pre class="verbatim">werl -s ejabberd -name ejabberd
</pre></li></ol><p> <a id="initialadmin"></a> </p>
<!--TOC section id="sec20" Create an XMPP Account for Administration-->
<h2 id="sec20" class="section">2.5  <a href="#initialadmin">Create an XMPP Account for Administration</a></h2><!--SEC END --><p> <a id="initialadmin"></a> </p><p>You need an XMPP account and grant him administrative privileges
to enter the <span style="font-family:monospace">ejabberd</span> Web Admin:
</p><ol class="enumerate" type=1><li class="li-enumerate">
Register an XMPP account on your <span style="font-family:monospace">ejabberd</span> server, for example <span style="font-family:monospace">admin1@example.org</span>.
There are two ways to register an XMPP account:
<ol class="enumerate" type=a><li class="li-enumerate">
Using <span style="font-family:monospace">ejabberdctl</span> (see section <a href="#ejabberdctl">4.1</a>):
<pre class="verbatim">ejabberdctl register admin1 example.org FgT5bk3
</pre></li><li class="li-enumerate">Using an XMPP client and In-Band Registration (see section <a href="#modregister">3.3.19</a>).
</li></ol>
</li><li class="li-enumerate">Edit the <span style="font-family:monospace">ejabberd</span> configuration file to give administration rights to the XMPP account you created:
<pre class="verbatim">acl:
admin:
user:
- "admin1": "example.org"
access:
configure:
admin: allow
</pre>You can grant administrative privileges to many XMPP accounts,
and also to accounts in other XMPP servers.
</li><li class="li-enumerate">Restart <span style="font-family:monospace">ejabberd</span> to load the new configuration.
</li><li class="li-enumerate">Open the Web Admin (<code>http://server:port/admin/</code>) in your
favourite browser. Make sure to enter the <em>full</em> JID as username (in this
example: <span style="font-family:monospace">admin1@example.org</span>. The reason that you also need to enter the
suffix, is because <span style="font-family:monospace">ejabberd</span>’s virtual hosting support.
</li></ol><p> <a id="upgrade"></a> </p>
<!--TOC section id="sec21" Upgrading <span style="font-family:monospace">ejabberd</span>-->
<h2 id="sec21" class="section">2.6  <a href="#upgrade">Upgrading <span style="font-family:monospace">ejabberd</span></a></h2><!--SEC END --><p> <a id="upgrade"></a> </p><p>To upgrade an ejabberd installation to a new version,
simply uninstall the old version, and then install the new one.
Of course, it is important that the configuration file
and Mnesia database spool directory are not removed.</p><p><span style="font-family:monospace">ejabberd</span> automatically updates the Mnesia table definitions at startup when needed.
If you also use an external database for storage of some modules,
check if the release notes of the new ejabberd version
indicates you need to also update those tables.</p><p> <a id="configure"></a> </p>
<!--TOC chapter id="sec22" Configuring <span style="font-family:monospace">ejabberd</span>-->
<h1 id="sec22" class="chapter">Chapter 3  <a href="#configure">Configuring <span style="font-family:monospace">ejabberd</span></a></h1><!--SEC END --><p> <a id="configure"></a>
</p><p> <a id="basicconfig"></a> </p>
<!--TOC section id="sec23" Basic Configuration-->
<h2 id="sec23" class="section">3.1  <a href="#basicconfig">Basic Configuration</a></h2><!--SEC END --><p> <a id="basicconfig"></a> </p><p>The configuration file will be loaded the first time you start <span style="font-family:monospace">ejabberd</span>.
The configuration file name MUST have “.yml” extension. This helps ejabberd
to differentiate between the new and legacy file formats (see section <a href="#oldconfig">3.1.1</a>).</p><p>Note that <span style="font-family:monospace">ejabberd</span> never edits the configuration file.</p><p>The configuration file is written in
<a href="http://en.wikipedia.org/wiki/YAML">YAML</a>.
However, different scalars are treated as different types:
</p><ul class="itemize"><li class="li-itemize">
unquoted or single-quoted strings. The type is called <code>atom()</code>
in this document.
Examples: <code>dog</code>, <code>'Jupiter'</code>, <code>'3.14159'</code>, <code>YELLOW</code>.
</li><li class="li-itemize">numeric literals. The type is called <code>integer()</code>, <code>float()</code> or,
if both are allowed, <code>number()</code>.
Examples: <code>3</code>, <code>-45.0</code>, <code>.0</code>
</li><li class="li-itemize">double-quoted or folded strings. The type is called <code>string()</code>.
Examples of a double-quoted string:
<code>"Lizzard"</code>, <code>"orange"</code>, <code>"3.14159"</code>.
Examples of a folded string:
<pre class="verbatim">> Art thou not Romeo,
and a Montague?
</pre><pre class="verbatim">| Neither, fair saint,
if either thee dislike.
</pre>For associative arrays ("mappings") and lists you can use both outline
indentation and compact syntax (aka “JSON style”). For example, the following is equivalent:
<pre class="verbatim">{param1: ["val1", "val2"], param2: ["val3", "val4"]}
</pre>and
<pre class="verbatim">param1:
- "val1"
- "val2"
param2:
- "val3"
- "val4"
</pre>Note that both styles are used in this document.
</li></ul><p> <a id="oldconfig"></a> </p>
<!--TOC subsection id="sec24" Legacy Configuration File-->
<h3 id="sec24" class="subsection">3.1.1  <a href="#oldconfig">Legacy Configuration File</a></h3><!--SEC END --><p> <a id="oldconfig"></a>
In previous <span style="font-family:monospace">ejabberd</span> version the configuration file should be written
in Erlang terms. The format is still supported, but it is highly recommended
to convert it to the new YAML format using <span style="font-family:monospace">convert_to_yaml</span> command
from <span style="font-family:monospace">ejabberdctl</span> (see <a href="#ejabberdctl">4.1</a> and <a href="#list-eja-commands">4.2.1</a> for details).</p><p> <a id="hostnames"></a> </p>
<!--TOC subsection id="sec25" Host Names-->
<h3 id="sec25" class="subsection">3.1.2  <a href="#hostnames">Host Names</a></h3><!--SEC END --><p> <a id="hostnames"></a>
</p><p>The option <span style="font-family:monospace">hosts</span> defines a list containing one or more domains that
<span style="font-family:monospace">ejabberd</span> will serve.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">[HostName]</span></span></dt></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
Serving one domain:
<pre class="verbatim">hosts: ["example.org"]
</pre></li><li class="li-itemize">Serving three domains:
<pre class="verbatim">hosts:
- "example.net"
- "example.com"
- "jabber.somesite.org"
</pre></li></ul><p> <a id="virtualhost"></a> </p>
<!--TOC subsection id="sec26" Virtual Hosting-->
<h3 id="sec26" class="subsection">3.1.3  <a href="#virtualhost">Virtual Hosting</a></h3><!--SEC END --><p> <a id="virtualhost"></a>
</p><p>Options can be defined separately for every virtual host using the
<span style="font-family:monospace">host_config</span> option.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{HostName: [Option, ...]}</span></span></dt></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
Domain <span style="font-family:monospace">example.net</span> is using the internal authentication method while
domain <span style="font-family:monospace">example.com</span> is using the LDAP server running on the
domain <span style="font-family:monospace">localhost</span> to perform authentication:
<pre class="verbatim">host_config:
"example.net"
auth_method: internal
"example.com":
auth_method: ldap
ldap_servers:
- "localhost"
ldap_uids:
- "uid"
ldap_rootdn: "dc=localdomain"
ldap_rootdn: "dc=example,dc=com"
ldap_password: ""
</pre></li><li class="li-itemize">Domain <span style="font-family:monospace">example.net</span> is using ODBC to perform authentication
while domain <span style="font-family:monospace">example.com</span> is using the LDAP servers running on the domains
<span style="font-family:monospace">localhost</span> and <span style="font-family:monospace">otherhost</span>:
<pre class="verbatim">host_config:
"example.net":
auth_method: odbc
odbc_type: odbc
odbc_server: "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"
"example.com":
auth_method: ldap
ldap_servers:
- "localhost"
- "otherhost"
ldap_uids:
- "uid"
ldap_rootdn: "dc=localdomain"
ldap_rootdn: "dc=example,dc=com"
ldap_password: ""
</pre></li></ul><p>To define specific ejabberd modules in a virtual host,
you can define the global <span style="font-family:monospace">modules</span> option with the common modules,
and later add specific modules to certain virtual hosts.
To accomplish that, instead of defining each option in <span style="font-family:monospace">host_config</span>
use <span style="font-family:monospace">append_host_config</span> with the same syntax.</p><p>In this example three virtual hosts have some similar modules, but there are also
other different modules for some specific virtual hosts:
</p><pre class="verbatim">## This ejabberd server has three vhosts:
hosts:
- "one.example.org"
- "two.example.org"
- "three.example.org"
## Configuration of modules that are common to all vhosts
modules:
mod_roster: {}
mod_configure: {}
mod_disco: {}
mod_private: {}
mod_time: {}
mod_last: {}
mod_version: {}
## Add some modules to vhost one:
append_host_config:
"one.example.org":
modules:
mod_echo:
host: "echo-service.one.example.org"
mod_http_bind: {}
mod_logxml: {}
## Add a module just to vhost two:
append_host_config:
"two.example.org":
modules:
mod_echo:
host: "mirror.two.example.org"
</pre><p> <a id="listened"></a> </p>
<!--TOC subsection id="sec27" Listening Ports-->
<h3 id="sec27" class="subsection">3.1.4  <a href="#listened">Listening Ports</a></h3><!--SEC END --><p> <a id="listened"></a>
</p><p>The option <span style="font-family:monospace">listen</span> defines for which ports, addresses and network protocols <span style="font-family:monospace">ejabberd</span>
will listen and what services will be run on them. Each element of the list is an
associative array with the following elements:
</p><ul class="itemize"><li class="li-itemize">
Port number. Optionally also the IP address and/or a transport protocol.
</li><li class="li-itemize">Listening module that serves this port.
</li><li class="li-itemize">Options for the TCP socket and for the listening module.
</li></ul><p>The option syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">[Listener, ...]</span></span></dt></dl><p>
Example:
</p><pre class="verbatim">listen:
-
port: 5222
module: ejabberd_c2s
starttls: true
certfile: "/path/to/certfile.pem"
-
port: 5269
module: ejabberd_s2s_in
transport: tcp
</pre><p> <a id="listened-port"></a> </p>
<!--TOC subsubsection id="sec28" Port Number, IP Address and Transport Protocol-->
<h4 id="sec28" class="subsubsection"><a href="#listened-port">Port Number, IP Address and Transport Protocol</a></h4><!--SEC END --><p> <a id="listened-port"></a> </p><p>The port number defines which port to listen for incoming connections.
It can be a Jabber/XMPP standard port
(see section <a href="#firewall">5.1</a>) or any other valid port number.</p><p>The IP address can be represented as a string.
The socket will listen only in that network interface.
It is possible to specify a generic address,
so <span style="font-family:monospace">ejabberd</span> will listen in all addresses.
Depending in the type of the IP address, IPv4 or IPv6 will be used.
When not specified the IP address, it will listen on all IPv4 network addresses.</p><p>Some example values for IP address:
</p><ul class="itemize"><li class="li-itemize">
<code>"0.0.0.0"</code> to listen in all IPv4 network interfaces. This is the default value when no IP is specified.
</li><li class="li-itemize"><code>"::"</code> to listen in all IPv6 network interfaces
</li><li class="li-itemize"><code>"10.11.12.13"</code> is the IPv4 address <code>10.11.12.13</code>
</li><li class="li-itemize"><code>"::FFFF:127.0.0.1"</code> is the IPv6 address <code>::FFFF:127.0.0.1/128</code>
</li></ul><p>The transport protocol can be <span style="font-family:monospace">tcp</span> or <span style="font-family:monospace">udp</span>.
Default is <span style="font-family:monospace">tcp</span>.</p><p> <a id="listened-module"></a> </p>
<!--TOC subsubsection id="sec29" Listening Module-->
<h4 id="sec29" class="subsubsection"><a href="#listened-module">Listening Module</a></h4><!--SEC END --><p> <a id="listened-module"></a> </p><p>
The available modules, their purpose and the options allowed by each one are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ejabberd_c2s</span></span></dt><dd class="dd-description">
Handles c2s connections.<br>
Options: <span style="font-family:monospace">access</span>, <span style="font-family:monospace">certfile</span>, <span style="font-family:monospace">ciphers</span>, <span style="font-family:monospace">protocol_options</span>
<span style="font-family:monospace">max_fsm_queue</span>,
<span style="font-family:monospace">max_stanza_size</span>, <span style="font-family:monospace">shaper</span>,
<span style="font-family:monospace">starttls</span>, <span style="font-family:monospace">starttls_required</span>, <span style="font-family:monospace">tls</span>,
<span style="font-family:monospace">zlib</span>, <span style="font-family:monospace">tls_compression</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberd_s2s_in</span></span></dt><dd class="dd-description">
Handles incoming s2s connections.<br>
Options: <span style="font-family:monospace">max_stanza_size</span>, <span style="font-family:monospace">shaper</span>, <span style="font-family:monospace">tls_compression</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberd_service</span></span></dt><dd class="dd-description">
Interacts with an <a href="http://www.ejabberd.im/tutorials-transports">external component</a>
(as defined in the Jabber Component Protocol (<a href="http://xmpp.org/extensions/xep-0114.html">XEP-0114</a>).<br>
Options: <span style="font-family:monospace">access</span>, <span style="font-family:monospace">hosts</span>, <span style="font-family:monospace">max_fsm_queue</span>,
<span style="font-family:monospace">service_check_from</span>, <span style="font-family:monospace">shaper_rule</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberd_sip</span></span></dt><dd class="dd-description">
Handles SIP requests as defined in
<a href="http://tools.ietf.org/html/rfc3261">RFC 3261</a>.<br>
Options: <span style="font-family:monospace">certfile</span>, <span style="font-family:monospace">tls</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberd_stun</span></span></dt><dd class="dd-description">
Handles STUN Binding requests as defined in
<a href="http://tools.ietf.org/html/rfc5389">RFC 5389</a>.<br>
Options: <span style="font-family:monospace">certfile</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberd_http</span></span></dt><dd class="dd-description">
Handles incoming HTTP connections.<br>
Options: <span style="font-family:monospace">captcha</span>, <span style="font-family:monospace">certfile</span>, <span style="font-family:monospace">default_host</span>, <span style="font-family:monospace">http_bind</span>, <span style="font-family:monospace">http_poll</span>,
<span style="font-family:monospace">request_handlers</span>, <span style="font-family:monospace">tls</span>, <span style="font-family:monospace">tls_compression</span>, <span style="font-family:monospace">trusted_proxies</span>, <span style="font-family:monospace">web_admin</span><br>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberd_xmlrpc</span></span></dt><dd class="dd-description">
Handles XML-RPC requests to execute ejabberd commands (<a href="#eja-commands">4.2</a>).<br>
Options: <span style="font-family:monospace">access_commands</span>, <span style="font-family:monospace">maxsessions</span>, <span style="font-family:monospace">timeout</span>.<br>
You can find option explanations, example configuration in old and new format,
and example calls in several languages in the old
<a href="https://raw.github.com/processone/ejabberd-contrib/master/ejabberd_xmlrpc/README.txt">ejabberd_xmlrpc README.txt</a>
</dd></dl><p> <a id="listened-options"></a> </p>
<!--TOC subsubsection id="sec30" Options-->
<h4 id="sec30" class="subsubsection"><a href="#listened-options">Options</a></h4><!--SEC END --><p> <a id="listened-options"></a> </p><p>This is a detailed description of each option allowed by the listening modules:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">access: AccessName</span></span></dt><dd class="dd-description"> This option defines
access to the port. The default value is <span style="font-family:monospace">all</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">backlog: Value</span></span></dt><dd class="dd-description"> The backlog value
defines the maximum length that the queue of pending connections may
grow to. This should be increased if the server is going to handle
lots of new incoming connections as they may be dropped if there is
no space in the queue (and ejabberd was not able to accept them
immediately). Default value is 5.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">captcha: true|false</span></span></dt><dd class="dd-description">
Simple web page that allows a user to fill a CAPTCHA challenge (see section <a href="#captcha">3.1.9</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">certfile: Path</span></span></dt><dd class="dd-description"> Full path to a file containing the default SSL certificate.
To define a certificate file specific for a given domain, use the global option <span style="font-family:monospace">domain_certfile</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ciphers: Ciphers</span></span></dt><dd class="dd-description"> OpenSSL ciphers list in the same format accepted by
‘<code>openssl ciphers</code>’ command.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">protocol_options: ProtocolOpts</span></span></dt><dd class="dd-description">
List of general options relating to SSL/TLS. These map to <code><a href="https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html">OpenSSL's set_options()</a></code>.
For a full list of options available in ejabberd, <code><a href="https://github.com/processone/tls/blob/master/c_src/options.h">see the source</a></code>.
The default entry is: <code>"no_sslv2"</code>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">default_host: undefined|HostName}</span></span></dt><dd class="dd-description">
If the HTTP request received by ejabberd contains the HTTP header <span style="font-family:monospace">Host</span>
with an ambiguous virtual host that doesn’t match any one defined in ejabberd (see <a href="#hostnames">3.1.2</a>),
then this configured HostName is set as the request Host.
The default value of this option is: <span style="font-family:monospace">undefined</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">hosts: {Hostname: [HostOption, ...]}</span></span></dt><dd class="dd-description">
The external Jabber component that connects to this <span style="font-family:monospace">ejabberd_service</span>
can serve one or more hostnames.
As <span style="font-family:monospace">HostOption</span> you can define options for the component;
currently the only allowed option is the password required to the component
when attempt to connect to ejabberd: <span style="font-family:monospace">password: Secret</span>.
Note that you cannot define in a single <span style="font-family:monospace">ejabberd_service</span> components of
different services: add an <span style="font-family:monospace">ejabberd_service</span> for each service,
as seen in an example below.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">http_bind: true|false</span></span></dt><dd class="dd-description">
This option enables HTTP Binding (<a href="http://xmpp.org/extensions/xep-0124.html">XEP-0124</a> and <a href="http://xmpp.org/extensions/xep-0206.html">XEP-0206</a>) support. HTTP Bind
enables access via HTTP requests to <span style="font-family:monospace">ejabberd</span> from behind firewalls which
do not allow outgoing sockets on port 5222.<p>Remember that you must also install and enable the module mod_http_bind.</p><p>If HTTP Bind is enabled, it will be available at
<code>http://server:port/http-bind/</code>. Be aware that support for HTTP Bind
is also needed in the XMPP client. Remark also that HTTP Bind can be
interesting to host a web-based XMPP client such as
<a href="http://jwchat.sourceforge.net/">JWChat</a>
(check the tutorials to install JWChat with ejabberd and an
<a href="http://www.ejabberd.im/jwchat-localserver">embedded local web server</a>
or <a href="http://www.ejabberd.im/jwchat-apache">Apache</a>).
</p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">http_poll: true|false</span></span></dt><dd class="dd-description">
This option enables HTTP Polling (<a href="http://xmpp.org/extensions/xep-0025.html">XEP-0025</a>) support. HTTP Polling
enables access via HTTP requests to <span style="font-family:monospace">ejabberd</span> from behind firewalls which
do not allow outgoing sockets on port 5222.<p>If HTTP Polling is enabled, it will be available at
<code>http://server:port/http-poll/</code>. Be aware that support for HTTP Polling
is also needed in the XMPP client. Remark also that HTTP Polling can be
interesting to host a web-based XMPP client such as
<a href="http://jwchat.sourceforge.net/">JWChat</a>.</p><p>The maximum period of time to keep a client session active without
an incoming POST request can be configured with the global option
<span style="font-family:monospace">http_poll_timeout</span>. The default value is five minutes.
The option can be defined in <span style="font-family:monospace">ejabberd.yml</span>, expressing the time
in seconds: <code>{http_poll_timeout, 300}.</code>
</p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_fsm_queue: Size</span></span></dt><dd class="dd-description">
This option specifies the maximum number of elements in the queue of the FSM
(Finite State Machine).
Roughly speaking, each message in such queues represents one XML
stanza queued to be sent into its relevant outgoing stream. If queue size
reaches the limit (because, for example, the receiver of stanzas is too slow),
the FSM and the corresponding connection (if any) will be terminated
and error message will be logged.
The reasonable value for this option depends on your hardware configuration.
However, there is no much sense to set the size above 1000 elements.
This option can be specified for <span style="font-family:monospace">ejabberd_service</span> and
<span style="font-family:monospace">ejabberd_c2s</span> listeners,
or also globally for <span style="font-family:monospace">ejabberd_s2s_out</span>.
If the option is not specified for <span style="font-family:monospace">ejabberd_service</span> or
<span style="font-family:monospace">ejabberd_c2s</span> listeners,
the globally configured value is used.
The allowed values are integers and ’undefined’.
Default value: ’undefined’.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_stanza_size: Size</span></span></dt><dd class="dd-description">
This option specifies an
approximate maximum size in bytes of XML stanzas. Approximate,
because it is calculated with the precision of one block of read
data. For example <code>{max_stanza_size, 65536}</code>. The default
value is <span style="font-family:monospace">infinity</span>. Recommended values are 65536 for c2s
connections and 131072 for s2s connections. s2s max stanza size
must always much higher than c2s limit. Change this value with
extreme care as it can cause unwanted disconnect if set too low.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">request_handlers: {Path: Module}</span></span></dt><dd class="dd-description"> To define one or several handlers that will serve HTTP requests.
The Path is a string; so the URIs that start with that Path will be served by Module.
For example, if you want <span style="font-family:monospace">mod_foo</span> to serve the URIs that start with <span style="font-family:monospace">/a/b/</span>,
and you also want <span style="font-family:monospace">mod_http_bind</span> to serve the URIs <span style="font-family:monospace">/http-bind/</span>,
use this option:
<pre class="verbatim">request_handlers:
/"a"/"b": mod_foo
/"http-bind": mod_http_bind
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">service_check_from: true|false</span></span></dt><dd class="dd-description">
This option can be used with <span style="font-family:monospace">ejabberd_service</span> only.
<a href="http://xmpp.org/extensions/xep-0114.html">XEP-0114</a> requires that the domain must match the hostname of the component.
If this option is set to <span style="font-family:monospace">false</span>, <span style="font-family:monospace">ejabberd</span> will allow the component
to send stanzas with any arbitrary domain in the ’from’ attribute.
Only use this option if you are completely sure about it.
The default value is <span style="font-family:monospace">true</span>, to be compliant with <a href="http://xmpp.org/extensions/xep-0114.html">XEP-0114</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">shaper: none|ShaperName</span></span></dt><dd class="dd-description"> This option defines a
shaper for the port (see section <a href="#shapers">3.1.7</a>). The default value
is <span style="font-family:monospace">none</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">shaper_rule: none|ShaperRule</span></span></dt><dd class="dd-description"> This option defines a
shaper rule for the <span style="font-family:monospace">ejabberd_service</span> (see section <a href="#shapers">3.1.7</a>). The recommended value
is <span style="font-family:monospace">fast</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">starttls: true|false</span></span></dt><dd class="dd-description"> This option
specifies that STARTTLS encryption is available on connections to the port.
You should also set the <span style="font-family:monospace">certfile</span> option.
You can define a certificate file for a specific domain using the global option <span style="font-family:monospace">domain_certfile</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">starttls_required: true|false</span></span></dt><dd class="dd-description"> This option
specifies that STARTTLS encryption is required on connections to the port.
No unencrypted connections will be allowed.
You should also set the <span style="font-family:monospace">certfile</span> option.
You can define a certificate file for a specific domain using the global option <span style="font-family:monospace">domain_certfile</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">timeout: Integer</span></span></dt><dd class="dd-description">
Timeout of the connections, expressed in milliseconds.
Default: 5000
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">tls: true|false</span></span></dt><dd class="dd-description"> This option specifies that traffic on
the port will be encrypted using SSL immediately after connecting.
This was the traditional encryption method in the early Jabber software,
commonly on port 5223 for client-to-server communications.
But this method is nowadays deprecated and not recommended.
The preferable encryption method is STARTTLS on port 5222, as defined
<a href="http://xmpp.org/rfcs/rfc3920.html#tls">RFC 3920: XMPP Core</a>,
which can be enabled in <span style="font-family:monospace">ejabberd</span> with the option <span style="font-family:monospace">starttls</span>.
If this option is set, you should also set the <span style="font-family:monospace">certfile</span> option.
The option <span style="font-family:monospace">tls</span> can also be used in <span style="font-family:monospace">ejabberd_http</span> to support HTTPS.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">tls_compression: true|false</span></span></dt><dd class="dd-description">
Whether to enable or disable TLS compression. The default value is <span style="font-family:monospace">true</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">trusted_proxies: all | [IpString]</span></span></dt><dd class="dd-description">
Specify what proxies are trusted when an HTTP request contains the header <span style="font-family:monospace">X-Forwarded-For</span>
You can specify <span style="font-family:monospace">all</span> to allow all proxies, or specify a list of IPs in string format.
The default value is: <span style="font-family:monospace">["127.0.0.1"]</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">web_admin: true|false</span></span></dt><dd class="dd-description"> This option
enables the Web Admin for <span style="font-family:monospace">ejabberd</span> administration which is available
at <code>http://server:port/admin/</code>. Login and password are the username and
password of one of the registered users who are granted access by the
‘configure’ access rule.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">zlib: true|false</span></span></dt><dd class="dd-description"> This
option specifies that Zlib stream compression (as defined in <a href="http://xmpp.org/extensions/xep-0138.html">XEP-0138</a>)
is available on connections to the port.
</dd></dl><p>There are some additional global options that can be specified in the ejabberd configuration file (outside <span style="font-family:monospace">listen</span>):
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">s2s_use_starttls: false|optional|required|required_trusted</span></span></dt><dd class="dd-description">
This option defines if
s2s connections don’t use STARTTLS encryption; if STARTTLS can be used optionally;
if STARTTLS is required to establish the connection;
or if STARTTLS is required and the remote certificate must be valid and trusted.
The default value is to not use STARTTLS: <span style="font-family:monospace">false</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_certfile: Path</span></span></dt><dd class="dd-description"> Full path to a
file containing a SSL certificate.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">domain_certfile: Path</span></span></dt><dd class="dd-description">
Full path to the file containing the SSL certificate for a specific domain.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_ciphers: Ciphers</span></span></dt><dd class="dd-description"> OpenSSL ciphers list
in the same format accepted by ‘<code>openssl ciphers</code>’ command.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_protocol_options: ProtocolOpts</span></span></dt><dd class="dd-description">
List of general options relating to SSL/TLS. These map to <code><a href="https://www.openssl.org/docs/ssl/SSL_CTX_set_options.html">OpenSSL's set_options()</a></code>.
For a full list of options available in ejabberd, <code><a href="https://github.com/processone/tls/blob/protocol_options/c_src/options.h">see the source</a></code>.
The default entry is: <code>"no_sslv2"</code>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">outgoing_s2s_families: [Family, ...]</span></span></dt><dd class="dd-description">
Specify which address families to try, in what order.
By default it first tries connecting with IPv4, if that fails it tries using IPv6.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">outgoing_s2s_timeout: Timeout</span></span></dt><dd class="dd-description">
The timeout in milliseconds for outgoing S2S connection attempts.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_dns_timeout: Timeout</span></span></dt><dd class="dd-description">
The timeout in seconds for DNS resolving. The default value is <span style="font-family:monospace">10</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_dns_retries: Number</span></span></dt><dd class="dd-description">
DNS resolving retries in seconds. The default value is <span style="font-family:monospace">2</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_policy: Access</span></span></dt><dd class="dd-description">
The policy for incoming and outgoing s2s connections to other XMPP servers.
The default value is <span style="font-family:monospace">all</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_max_retry_delay: Seconds</span></span></dt><dd class="dd-description">
The maximum allowed delay for retry to connect after a failed connection attempt.
Specified in seconds. The default value is 300 seconds (5 minutes).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">s2s_tls_compression: true|false</span></span></dt><dd class="dd-description">
Whether to enable or disable TLS compression for s2s connections.
The default value is <span style="font-family:monospace">true</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_fsm_queue: Size</span></span></dt><dd class="dd-description">
This option specifies the maximum number of elements in the queue of the FSM
(Finite State Machine).
Roughly speaking, each message in such queues represents one XML
stanza queued to be sent into its relevant outgoing stream. If queue size
reaches the limit (because, for example, the receiver of stanzas is too slow),
the FSM and the corresponding connection (if any) will be terminated
and error message will be logged.
The reasonable value for this option depends on your hardware configuration.
However, there is no much sense to set the size above 1000 elements.
This option can be specified for <span style="font-family:monospace">ejabberd_service</span> and
<span style="font-family:monospace">ejabberd_c2s</span> listeners,
or also globally for <span style="font-family:monospace">ejabberd_s2s_out</span>.
If the option is not specified for <span style="font-family:monospace">ejabberd_service</span> or
<span style="font-family:monospace">ejabberd_c2s</span> listeners,
the globally configured value is used.
The allowed values are integers and ’undefined’.
Default value: ’undefined’.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">route_subdomains: local|s2s</span></span></dt><dd class="dd-description">
Defines if ejabberd must route stanzas directed to subdomains locally (compliant with
<a href="http://xmpp.org/rfcs/rfc3920.html#rules.subdomain">RFC 3920: XMPP Core</a>),
or to foreign server using S2S (compliant with
<a href="http://tools.ietf.org/html/draft-saintandre-rfc3920bis-09#section-11.3">RFC 3920 bis</a>).
</dd></dl><p> <a id="listened-examples"></a> </p>
<!--TOC subsubsection id="sec31" Examples-->
<h4 id="sec31" class="subsubsection"><a href="#listened-examples">Examples</a></h4><!--SEC END --><p> <a id="listened-examples"></a> </p><p>For example, the following simple configuration defines:
</p><ul class="itemize"><li class="li-itemize">
There are three domains. The default certificate file is <span style="font-family:monospace">server.pem</span>.
However, the c2s and s2s connections to the domain <span style="font-family:monospace">example.com</span> use the file <span style="font-family:monospace">example_com.pem</span>.
</li><li class="li-itemize">Port 5222 listens for c2s connections with STARTTLS,
and also allows plain connections for old clients.
</li><li class="li-itemize">Port 5223 listens for c2s connections with the old SSL.
</li><li class="li-itemize">Port 5269 listens for s2s connections with STARTTLS. The socket is set for IPv6 instead of IPv4.
</li><li class="li-itemize">Port 3478 listens for STUN requests over UDP.
</li><li class="li-itemize">Port 5280 listens for HTTP requests, and serves the HTTP Poll service.
</li><li class="li-itemize">Port 5281 listens for HTTP requests, using HTTPS to serve HTTP-Bind (BOSH) and the Web Admin as explained in
section <a href="#webadmin">4.3</a>. The socket only listens connections to the IP address 127.0.0.1.
</li></ul><pre class="verbatim">hosts:
- "example.com"
- "example.org"
- "example.net"
listen:
-
port: 5222
module: ejabberd_c2s
access: c2s
shaper: c2s_shaper
starttls: true
certfile: "/etc/ejabberd/server.pem"
max_stanza_size: 65536
-
port: 5223
module: ejabberd_c2s
access: c2s
shaper: c2s_shaper
tls: true
certfile: "/etc/ejabberd/server.pem"
max_stanza_size: 65536
-
port: 5269
ip: "::"
module: ejabberd_s2s_in
shaper: s2s_shaper
max_stanza_size: 131072
-
port: 3478
transport: udp
module: ejabberd_stun
-
port: 5280
module: ejabberd_http
http_poll: true
-
port: 5281
ip: "127.0.0.1"
module: ejabberd_http
web_admin: true
http_bind: true
tls: true
certfile: "/etc/ejabberd/server.pem"
s2s_use_starttls: optional
s2s_certfile: "/etc/ejabberd/server.pem"
host_config:
"example.com":
domain_certfile: "/etc/ejabberd/example_com.pem"
outgoing_s2s_families:
- ipv4
- ipv6
outgoing_s2s_timeout: 10000
</pre><p>In this example, the following configuration defines that:
</p><ul class="itemize"><li class="li-itemize">
c2s connections are listened for on port 5222 (all IPv4 addresses) and
on port 5223 (SSL, IP 192.168.0.1 and fdca:8ab6:a243:75ef::1) and denied
for the user called ‘<span style="font-family:monospace">bad</span>’.
</li><li class="li-itemize">s2s connections are listened for on port 5269 (all IPv4 addresses)
with STARTTLS for secured traffic strictly required, and the certificates are verified.
Incoming and outgoing connections of remote XMPP servers are denied,
only two servers can connect: "jabber.example.org" and "example.com".
</li><li class="li-itemize">Port 5280 is serving the Web Admin and the HTTP Polling service
in all the IPv4 addresses. Note
that it is also possible to serve them on different ports. The second
example in section <a href="#webadmin">4.3</a> shows how exactly this can be done.
</li><li class="li-itemize">All users except for the administrators have a traffic of limit
1,000 Bytes/second
</li><li class="li-itemize">The
<a href="http://www.ejabberd.im/pyaimt">AIM transport</a>
<span style="font-family:monospace">aim.example.org</span> is connected to port 5233 on localhost IP addresses
(127.0.0.1 and ::1) with password ‘<span style="font-family:monospace">aimsecret</span>’.
</li><li class="li-itemize">The ICQ transport JIT (<span style="font-family:monospace">icq.example.org</span> and
<span style="font-family:monospace">sms.example.org</span>) is connected to port 5234 with password
‘<span style="font-family:monospace">jitsecret</span>’.
</li><li class="li-itemize">The
<a href="http://www.ejabberd.im/pymsnt">MSN transport</a>
<span style="font-family:monospace">msn.example.org</span> is connected to port 5235 with password
‘<span style="font-family:monospace">msnsecret</span>’.
</li><li class="li-itemize">The
<a href="http://www.ejabberd.im/yahoo-transport-2">Yahoo! transport</a>
<span style="font-family:monospace">yahoo.example.org</span> is connected to port 5236 with password
‘<span style="font-family:monospace">yahoosecret</span>’.
</li><li class="li-itemize">The <a href="http://www.ejabberd.im/jabber-gg-transport">Gadu-Gadu transport</a> <span style="font-family:monospace">gg.example.org</span> is
connected to port 5237 with password ‘<span style="font-family:monospace">ggsecret</span>’.
</li><li class="li-itemize">The
<a href="http://www.ejabberd.im/jmc">Jabber Mail Component</a>
<span style="font-family:monospace">jmc.example.org</span> is connected to port 5238 with password
‘<span style="font-family:monospace">jmcsecret</span>’.
</li><li class="li-itemize">The service custom has enabled the special option to avoiding checking the <span style="font-family:monospace">from</span> attribute in the packets send by this component. The component can send packets in behalf of any users from the server, or even on behalf of any server.
</li></ul><pre class="verbatim">acl:
blocked:
user: "bad"
trusted_servers:
server:
- "example.com"
- "jabber.example.org"
xmlrpc_bot:
user:
- "xmlrpc-robot": "example.org"
shaper:
normal: 1000
access:
c2s:
blocked: deny
all: allow
c2s_shaper:
admin: none
all: normal
xmlrpc_access:
xmlrpc_bot: allow
s2s_access:
trusted_servers: allow
all: deny
s2s_certfile: "/path/to/ssl.pem"
s2s_policy: s2s_access
s2s_use_starttls: required_trusted
listen:
-
port: 5222
module: ejabberd_c2s
shaper: c2s_shaper
access: c2s
-
ip: "192.168.0.1"
port: 5223
module: ejabberd_c2s
certfile: "/path/to/ssl.pem"
tls: true
access: c2s
-
ip: "FDCA:8AB6:A243:75EF::1"
port: 5223
module: ejabberd_c2s
certfile: "/path/to/ssl.pem"
tls: true
access: c2s
-
port: 5269
module: ejabberd_s2s_in
-
port: 5280
module: ejabberd_http
web_admin: true
http_poll: true
-
port: 4560
module: ejabberd_xmlrpc
-
ip: "127.0.0.1"
port: 5233
module: ejabberd_service
hosts:
"aim.example.org":
password: "aimsecret"
-
ip: "::1"
port: 5233
module: ejabberd_service
hosts:
"aim.example.org":
password: "aimsecret"
-
port: 5234
module: ejabberd_service
hosts:
"icq.example.org":
password: "jitsecret"
"sms.example.org":
password: "jitsecret"
-
port: 5235
module: ejabberd_service
hosts:
"msn.example.org":
password: "msnsecret"
-
port: 5236
module: ejabberd_service
hosts:
"yahoo.example.org":
password: "yahoosecret"
-
port: 5237
module: ejabberd_service
hosts:
"gg.example.org":
password: "ggsecret"
-
port: 5238
module: ejabberd_service
hosts:
"jmc.example.org":
password: "jmcsecret"
-
port: 5239
module: ejabberd_service
service_check_from: false
hosts:
"custom.example.org":
password: "customsecret"
</pre><p>Note, that for services based in jabberd14 or WPJabber
you have to make the transports log and do XDB by themselves:
</p><pre class="verbatim"> <!--
You have to add elogger and rlogger entries here when using ejabberd.
In this case the transport will do the logging.
-->
<log id='logger'>
<host/>
<logtype/>
<format>%d: [%t] (%h): %s</format>
<file>/var/log/jabber/service.log</file>
</log>
<!--
Some XMPP server implementations do not provide
XDB services (for example, jabberd2 and ejabberd).
xdb_file.so is loaded in to handle all XDB requests.
-->
<xdb id="xdb">
<host/>
<load>
<!-- this is a lib of wpjabber or jabberd14 -->
<xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file>
</load>
<xdb_file xmlns="jabber:config:xdb_file">
<spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool>
</xdb_file>
</xdb>
</pre><p> <a id="auth"></a> </p>
<!--TOC subsection id="sec32" Authentication-->
<h3 id="sec32" class="subsection">3.1.5  <a href="#auth">Authentication</a></h3><!--SEC END --><p> <a id="auth"></a>
</p><p>The option <span style="font-family:monospace">auth_method</span> defines the authentication methods that are used
for user authentication. The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">[Method, ...]</span></span></dt></dl><p>The following authentication methods are supported by <span style="font-family:monospace">ejabberd</span>:
</p><ul class="itemize"><li class="li-itemize">
internal (default) — See section <a href="#internalauth">3.1.5</a>.
</li><li class="li-itemize">external — See section <a href="#extauth">3.1.5</a>.
</li><li class="li-itemize">ldap — See section <a href="#ldap">3.2.2</a>.
</li><li class="li-itemize">odbc — See section <a href="#odbc">3.2.1</a>.
</li><li class="li-itemize">anonymous — See section <a href="#saslanonymous">3.1.5</a>.
</li><li class="li-itemize">pam — See section <a href="#pam">3.1.5</a>.
</li></ul><p>Account creation is only supported by internal, external and odbc methods.</p><p>The option <span style="font-family:monospace">resource_conflict</span> defines the action when a client attempts to
login to an account with a resource that is already connected.
The option syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">resource_conflict: setresource|closenew|closeold</span></span></dt></dl><p>
The possible values match exactly the three possibilities described in
<a href="http://tools.ietf.org/html/rfc6120#section-7.7.2.2">XMPP Core: section 7.7.2.2</a>.
The default value is <span style="font-family:monospace">closeold</span>.
If the client uses old Jabber Non-SASL authentication (<a href="http://xmpp.org/extensions/xep-0078.html">XEP-0078</a>),
then this option is not respected, and the action performed is <span style="font-family:monospace">closeold</span>.</p><p>The option <span style="font-family:monospace">fqdn</span> allows you to define the Fully Qualified Domain Name
of the machine, in case it isn’t detected automatically.
The FQDN is used to authenticate some clients that use the DIGEST-MD5 SASL mechanism.
The option syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">fqdn: undefined|FqdnString|[FqdnString]</span></span></dt></dl><p> <a id="internalauth"></a> </p>
<!--TOC subsubsection id="sec33" Internal-->
<h4 id="sec33" class="subsubsection"><a href="#internalauth">Internal</a></h4><!--SEC END --><p> <a id="internalauth"></a>
</p><p><span style="font-family:monospace">ejabberd</span> uses its internal Mnesia database as the default authentication method.
The value <span style="font-family:monospace">internal</span> will enable the internal authentication method.</p><p>The option <span style="font-family:monospace">auth_password_format: plain|scram</span>
defines in what format the users passwords are stored:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">plain</span></span></dt><dd class="dd-description">
The password is stored as plain text in the database.
This is risky because the passwords can be read if your database gets compromised.
This is the default value.
This format allows clients to authenticate using:
the old Jabber Non-SASL (<a href="http://xmpp.org/extensions/xep-0078.html">XEP-0078</a>), <span style="font-family:monospace">SASL PLAIN</span>,
<span style="font-family:monospace">SASL DIGEST-MD5</span>, and <span style="font-family:monospace">SASL SCRAM-SHA-1</span>.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">scram</span></span></dt><dd class="dd-description">
The password is not stored, only some information that allows to verify the hash provided by the client.
It is impossible to obtain the original plain password from the stored information;
for this reason, when this value is configured it cannot be changed to <span style="font-family:monospace">plain</span> anymore.
This format allows clients to authenticate using: <span style="font-family:monospace">SASL PLAIN</span> and <span style="font-family:monospace">SASL SCRAM-SHA-1</span>.
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
To use internal authentication on <span style="font-family:monospace">example.org</span> and LDAP
authentication on <span style="font-family:monospace">example.net</span>:
<pre class="verbatim">host_config:
"example.org":
auth_method: [internal]
"example.net":
auth_method: [ldap]
</pre></li><li class="li-itemize">To use internal authentication with hashed passwords on all virtual hosts:
<pre class="verbatim">auth_method: internal
auth_password_format: scram
</pre></li></ul><p> <a id="extauth"></a> </p>
<!--TOC subsubsection id="sec34" External Script-->
<h4 id="sec34" class="subsubsection"><a href="#extauth">External Script</a></h4><!--SEC END --><p> <a id="extauth"></a>
</p><p>In this authentication method, when <span style="font-family:monospace">ejabberd</span> starts,
it start a script, and calls it to perform authentication tasks.</p><p>The server administrator can write the external authentication script
in any language.
The details on the interface between ejabberd and the script are described
in the <span style="font-family:monospace">ejabberd Developers Guide</span>.
There are also <a href="http://www.ejabberd.im/extauth">several example authentication scripts</a>.</p><p>These are the specific options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">extauth_program: PathToScript</span></span></dt><dd class="dd-description">
Indicate in this option the full path to the external authentication script.
The script must be executable by ejabberd.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">extauth_instances: Integer</span></span></dt><dd class="dd-description">
Indicate how many instances of the script to run simultaneously to serve authentication in the virtual host.
The default value is the minimum number: 1.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">extauth_cache: false|CacheTimeInteger</span></span></dt><dd class="dd-description">
The value <span style="font-family:monospace">false</span> disables the caching feature, this is the default.
The integer <span style="font-family:monospace">0</span> (zero) enables caching for statistics, but doesn’t use that cached information to authenticate users.
If another integer value is set, caching is enabled both for statistics and for authentication:
the CacheTimeInteger indicates the number of seconds that ejabberd can reuse
the authentication information since the user last disconnected,
to verify again the user authentication without querying again the extauth script.
Note: caching should not be enabled in a host if internal auth is also enabled.
If caching is enabled, <span style="font-family:monospace">mod_last</span> must be enabled also in that vhost.
</dd></dl><p>This example sets external authentication, the extauth script, enables caching for 10 minutes,
and starts three instances of the script for each virtual host defined in ejabberd:
</p><pre class="verbatim">auth_method: [external]
extauth_program: "/etc/ejabberd/JabberAuth.class.php"
extauth_cache: 600
extauth_instances: 3
</pre><p> <a id="saslanonymous"></a> </p>
<!--TOC subsubsection id="sec35" Anonymous Login and SASL Anonymous-->
<h4 id="sec35" class="subsubsection"><a href="#saslanonymous">Anonymous Login and SASL Anonymous</a></h4><!--SEC END --><p> <a id="saslanonymous"></a>
</p><p>The <span style="font-family:monospace">anonymous</span> authentication method enables two modes for anonymous authentication:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">Anonymous login:</span></span></dt><dd class="dd-description"> This is a standard login, that use the
classical login and password mechanisms, but where password is
accepted or preconfigured for all anonymous users. This login is
compliant with SASL authentication, password and digest non-SASL
authentication, so this option will work with almost all XMPP
clients</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">SASL Anonymous:</span></span></dt><dd class="dd-description"> This is a special SASL authentication
mechanism that allows to login without providing username or
password (see <a href="http://xmpp.org/extensions/xep-0175.html">XEP-0175</a>). The main advantage of SASL Anonymous
is that the protocol was designed to give the user a login. This is
useful to avoid in some case, where the server has many users
already logged or registered and when it is hard to find a free
username. The main disavantage is that you need a client that
specifically supports the SASL Anonymous protocol.
</dd></dl><p>The anonymous authentication method can be configured with the following
options. Remember that you can use the <span style="font-family:monospace">host_config</span> option to set virtual
host specific options (see section <a href="#virtualhost">3.1.3</a>).</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">allow_multiple_connections: false|true</span></span></dt><dd class="dd-description"> This option is only used
when the anonymous mode is
enabled. Setting it to <span style="font-family:monospace">true</span> means that the same username can be taken
multiple times in anonymous login mode if different resource are used to
connect. This option is only useful in very special occasions. The default
value is <span style="font-family:monospace">false</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">anonymous_protocol: login_anon | sasl_anon | both</span></span></dt><dd class="dd-description">
<span style="font-family:monospace">login_anon</span> means that the anonymous login method will be used.
<span style="font-family:monospace">sasl_anon</span> means that the SASL Anonymous method will be used.
<span style="font-family:monospace">both</span> means that SASL Anonymous and login anonymous are both enabled.
</dd></dl><p>Those options are defined for each virtual host with the <span style="font-family:monospace">host_config</span>
parameter (see section <a href="#virtualhost">3.1.3</a>).</p><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
To enable anonymous login on all virtual hosts:
<pre class="verbatim">auth_method: [anonymous]
anonymous_protocol: login_anon
</pre></li><li class="li-itemize">Similar as previous example, but limited to <span style="font-family:monospace">public.example.org</span>:
<pre class="verbatim">host_config:
"public.example.org":
auth_method: [anonymous]
anonymous_protoco: login_anon
</pre></li><li class="li-itemize">To enable anonymous login and internal authentication on a virtual host:
<pre class="verbatim">host_config:
"public.example.org":
auth_method:
- internal
- anonymous
anonymous_protocol: login_anon
</pre></li><li class="li-itemize">To enable SASL Anonymous on a virtual host:
<pre class="verbatim">host_config:
"public.example.org":
auth_method: [anonymous]
anonymous_protocol: sasl_anon
</pre></li><li class="li-itemize">To enable SASL Anonymous and anonymous login on a virtual host:
<pre class="verbatim">host_config:
"public.example.org":
auth_method: [anonymous]
anonymous_protocol: both
</pre></li><li class="li-itemize">To enable SASL Anonymous, anonymous login, and internal authentication on
a virtual host:
<pre class="verbatim">host_config:
"public.example.org":
auth_method:
- internal
- anonymous
anonymous_protocol: both
</pre></li></ul><p>There are more configuration examples and XMPP client example stanzas in
<a href="http://www.ejabberd.im/Anonymous-users-support">Anonymous users support</a>.</p><p> <a id="pam"></a> </p>
<!--TOC subsubsection id="sec36" PAM Authentication-->
<h4 id="sec36" class="subsubsection"><a href="#pam">PAM Authentication</a></h4><!--SEC END --><p> <a id="pam"></a>
</p><p><span style="font-family:monospace">ejabberd</span> supports authentication via Pluggable Authentication Modules (PAM).
PAM is currently supported in AIX, FreeBSD, HP-UX, Linux, Mac OS X, NetBSD and Solaris.
PAM authentication is disabled by default, so you have to configure and compile
<span style="font-family:monospace">ejabberd</span> with PAM support enabled:
</p><pre class="verbatim">./configure --enable-pam && make install
</pre><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">pam_service: Name</span></span></dt><dd class="dd-description">This option defines the PAM service name.
Default is <span style="font-family:monospace">"ejabberd"</span>. Refer to the PAM documentation of your operation system
for more information.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">pam_userinfotype: username|jid</span></span></dt><dd class="dd-description">
This option defines what type of information about the user ejabberd
provides to the PAM service: only the username, or the user JID.
Default is <span style="font-family:monospace">username</span>.
</dd></dl><p>Example:
</p><pre class="verbatim">auth_method: [pam]
pam_service: "ejabberd"
</pre><p>Though it is quite easy to set up PAM support in <span style="font-family:monospace">ejabberd</span>, PAM itself introduces some
security issues:</p><ul class="itemize"><li class="li-itemize">
To perform PAM authentication <span style="font-family:monospace">ejabberd</span> uses external C-program called
<span style="font-family:monospace">epam</span>. By default, it is located in <code>/var/lib/ejabberd/priv/bin/</code>
directory. You have to set it root on execution in the case when your PAM module
requires root privileges (<span style="font-family:monospace">pam_unix.so</span> for example). Also you have to grant access
for <span style="font-family:monospace">ejabberd</span> to this file and remove all other permissions from it.
Execute with root privileges:
<pre class="verbatim">chown root:ejabberd /var/lib/ejabberd/priv/bin/epam
chmod 4750 /var/lib/ejabberd/priv/bin/epam
</pre></li><li class="li-itemize">Make sure you have the latest version of PAM installed on your system.
Some old versions of PAM modules cause memory leaks. If you are not able to use the latest
version, you can <span style="font-family:monospace">kill(1)</span> <span style="font-family:monospace">epam</span> process periodically to reduce its memory
consumption: <span style="font-family:monospace">ejabberd</span> will restart this process immediately.
</li><li class="li-itemize"><span style="font-family:monospace">epam</span> program tries to turn off delays on authentication failures.
However, some PAM modules ignore this behavior and rely on their own configuration options.
You can create a configuration file <span style="font-family:monospace">ejabberd.pam</span>.
This example shows how to turn off delays in <span style="font-family:monospace">pam_unix.so</span> module:
<pre class="verbatim">#%PAM-1.0
auth sufficient pam_unix.so likeauth nullok nodelay
account sufficient pam_unix.so
</pre>That is not a ready to use configuration file: you must use it
as a hint when building your own PAM configuration instead. Note that if you want to disable
delays on authentication failures in the PAM configuration file, you have to restrict access
to this file, so a malicious user can’t use your configuration to perform brute-force
attacks.
</li><li class="li-itemize">You may want to allow login access only for certain users. <span style="font-family:monospace">pam_listfile.so</span>
module provides such functionality.
</li><li class="li-itemize">If you use <span style="font-family:monospace">pam_winbind</span> to authorise against a Windows Active Directory,
then <span style="font-family:monospace">/etc/nsswitch.conf</span> must be configured to use <span style="font-family:monospace">winbind</span> as well.
</li></ul><p> <a id="accessrules"></a> </p>
<!--TOC subsection id="sec37" Access Rules-->
<h3 id="sec37" class="subsection">3.1.6  <a href="#accessrules">Access Rules</a></h3><!--SEC END --><p> <a id="accessrules"></a>
</p><p> <a id="ACLDefinition"></a> </p>
<!--TOC subsubsection id="sec38" ACL Definition-->
<h4 id="sec38" class="subsubsection"><a href="#ACLDefinition">ACL Definition</a></h4><!--SEC END --><p> <a id="ACLDefinition"></a>
</p><p>Access control in <span style="font-family:monospace">ejabberd</span> is performed via Access Control Lists (ACLs). The
declarations of ACLs in the configuration file have the following syntax:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">acl: { ACLName: { ACLType: ACLValue } }</span></span></dt></dl><p><span style="font-family:monospace">ACLType: ACLValue</span> can be one of the following:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">all</span></span></dt><dd class="dd-description"> Matches all JIDs. Example:
<pre class="verbatim">acl:
world: all
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">user: Username</span></span></dt><dd class="dd-description"> Matches the user with the name
<span style="font-family:monospace">Username</span> at the first virtual host. Example:
<pre class="verbatim">acl:
admin:
user: "yozhik"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">user: {Username: Server}</span></span></dt><dd class="dd-description"> Matches the user with the JID
<span style="font-family:monospace">Username@Server</span> and any resource. Example:
<pre class="verbatim">acl:
admin:
user:
"yozhik": "example.org"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">server: Server</span></span></dt><dd class="dd-description"> Matches any JID from server
<span style="font-family:monospace">Server</span>. Example:
<pre class="verbatim">acl:
exampleorg:
server: "example.org"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">resource: Resource</span></span></dt><dd class="dd-description"> Matches any JID with a resource
<span style="font-family:monospace">Resource</span>. Example:
<pre class="verbatim">acl:
mucklres:
resource: "muckl"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">shared_group: Groupname</span></span></dt><dd class="dd-description"> Matches any member of a Shared Roster Group with name <span style="font-family:monospace">Groupname</span> in the virtual host. Example:
<pre class="verbatim">acl:
techgroupmembers:
shared_group: "techteam"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">shared_group: {Groupname: Server}</span></span></dt><dd class="dd-description"> Matches any member of a Shared Roster Group with name <span style="font-family:monospace">Groupname</span> in the virtual host <span style="font-family:monospace">Server</span>. Example:
<pre class="verbatim">acl:
techgroupmembers:
shared_group:
"techteam": "example.org"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ip: Network</span></span></dt><dd class="dd-description"> Matches any IP address from the <span style="font-family:monospace">Network</span>. Example:
<pre class="verbatim">acl:
loopback:
ip:
- "127.0.0.0/8"
- "::"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">user_regexp: Regexp</span></span></dt><dd class="dd-description"> Matches any local user with a name that
matches <span style="font-family:monospace">Regexp</span> on local virtual hosts. Example:
<pre class="verbatim">acl:
tests:
user_regexp: "^test[0-9]*$"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">user_regexp: {Regexp: Server}</span></span></dt><dd class="dd-description"> Matches any user with a name
that matches <span style="font-family:monospace">Regexp</span> at server <span style="font-family:monospace">Server</span>. Example:
<pre class="verbatim">acl:
tests:
user_regexp:
"^test": "example.org"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">server_regexp: Regexp</span></span></dt><dd class="dd-description"> Matches any JID from the server that
matches <span style="font-family:monospace">Regexp</span>. Example:
<pre class="verbatim">acl:
icq:
server_regexp: "^icq\\."
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">resource_regexp: Regexp</span></span></dt><dd class="dd-description"> Matches any JID with a resource that
matches <span style="font-family:monospace">Regexp</span>. Example:
<pre class="verbatim">acl:
icq:
resource_regexp: "^laptop\\."
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">node_regexp: {UserRegexp: ServerRegexp}</span></span></dt><dd class="dd-description"> Matches any user
with a name that matches <span style="font-family:monospace">UserRegexp</span> at any server that matches
<span style="font-family:monospace">ServerRegexp</span>. Example:
<pre class="verbatim">acl:
yozhik:
node_regexp:
"^yozhik$": "^example.(com|org)$"
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">user_glob: Glob}</span></span></dt><dd class="dd-description">
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">user_glob: {Glob: Server}</span></span></dt><dd class="dd-description">
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">server_glob: Glob</span></span></dt><dd class="dd-description">
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">resource_glob: Glob</span></span></dt><dd class="dd-description">
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">node_glob: {UserGlob: ServerGlob}</span></span></dt><dd class="dd-description"> This is the same as
above. However, it uses shell glob patterns instead of regexp. These patterns
can have the following special characters:
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">*</span></span></dt><dd class="dd-description"> matches any string including the null string.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">?</span></span></dt><dd class="dd-description"> matches any single character.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">[...]</span></span></dt><dd class="dd-description"> matches any of the enclosed characters. Character
ranges are specified by a pair of characters separated by a <span style="font-family:monospace">‘-’</span>.
If the first character after <span style="font-family:monospace">‘[’</span> is a <span style="font-family:monospace">‘!’</span>, any
character not enclosed is matched.
</dd></dl>
</dd></dl><p>The following <span style="font-family:monospace">ACLName</span> are pre-defined:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">all</span></span></dt><dd class="dd-description"> Matches any JID.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">none</span></span></dt><dd class="dd-description"> Matches no JID.
</dd></dl><p> <a id="AccessRights"></a> </p>
<!--TOC subsubsection id="sec39" Access Rights-->
<h4 id="sec39" class="subsubsection"><a href="#AccessRights">Access Rights</a></h4><!--SEC END --><p> <a id="AccessRights"></a>
</p><p>An entry allowing or denying access to different services.
The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access: { AccessName: { ACLName: allow|deny } }</span></span></dt></dl><p>When a JID is checked to have access to <span style="font-family:monospace">Accessname</span>, the server
sequentially checks if that JID matches any of the ACLs that are named in the
first elements of the tuples in the list. If it matches, the second element of
the first matched tuple is returned, otherwise the value ‘<span style="font-family:monospace">deny</span>’ is
returned.</p><p>If you define specific Access rights in a virtual host,
remember that the globally defined Access rights have precedence over those.
This means that, in case of conflict, the Access granted or denied in the global server is used
and the Access of a virtual host doesn’t have effect.</p><p>Example:
</p><pre class="verbatim">access:
configure:
admin: allow
something
badmans: deny
all: allow
</pre><p>The following <span style="font-family:monospace">AccessName</span> are pre-defined:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">all</span></span></dt><dd class="dd-description"> Always returns the value ‘<span style="font-family:monospace">allow</span>’.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">none</span></span></dt><dd class="dd-description"> Always returns the value ‘<span style="font-family:monospace">deny</span>’.
</dd></dl><p> <a id="configmaxsessions"></a> </p>
<!--TOC subsubsection id="sec40" Limiting Opened Sessions with ACL-->
<h4 id="sec40" class="subsubsection"><a href="#configmaxsessions">Limiting Opened Sessions with ACL</a></h4><!--SEC END --><p> <a id="configmaxsessions"></a>
</p><p>The special access <span style="font-family:monospace">max_user_sessions</span> specifies the maximum
number of sessions (authenticated connections) per user. If a user
tries to open more sessions by using different resources, the first
opened session will be disconnected. The error <span style="font-family:monospace">session replaced</span>
will be sent to the disconnected session. The value for this option
can be either a number, or <span style="font-family:monospace">infinity</span>. The default value is
<span style="font-family:monospace">infinity</span>.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{ max_user_sessions: { ACLName: MaxNumber } }</span></span></dt></dl><p>This example limits the number of sessions per user to 5 for all users, and to 10 for admins:
</p><pre class="verbatim">access:
max_user_sessions:
admin: 10
all: 5
</pre><p> <a id="configmaxs2sconns"></a> </p>
<!--TOC subsubsection id="sec41" Several connections to a remote XMPP server with ACL-->
<h4 id="sec41" class="subsubsection"><a href="#configmaxs2sconns">Several connections to a remote XMPP server with ACL</a></h4><!--SEC END --><p> <a id="configmaxs2sconns"></a>
</p><p>The special access <span style="font-family:monospace">max_s2s_connections</span> specifies how many
simultaneous S2S connections can be established to a specific remote XMPP server.
The default value is <span style="font-family:monospace">1</span>.
There’s also available the access <span style="font-family:monospace">max_s2s_connections_per_node</span>.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{ max_s2s_connections: { ACLName: MaxNumber } }</span></span></dt></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
Allow up to 3 connections with each remote server:
<pre class="verbatim">access:
max_s2s_connections:
all: 3
</pre></li></ul><p> <a id="shapers"></a> </p>
<!--TOC subsection id="sec42" Shapers-->
<h3 id="sec42" class="subsection">3.1.7  <a href="#shapers">Shapers</a></h3><!--SEC END --><p> <a id="shapers"></a>
</p><p>Shapers enable you to limit connection traffic.
The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">shaper: { ShaperName: Rate }</span></span></dt></dl><p>
where <span style="font-family:monospace">Rate</span> stands for the maximum allowed incoming rate in bytes per
second.
When a connection exceeds this limit, <span style="font-family:monospace">ejabberd</span> stops reading from the socket
until the average rate is again below the allowed maximum.</p><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
To define a shaper named ‘<span style="font-family:monospace">normal</span>’ with traffic speed limited to
1,000 bytes/second:
<pre class="verbatim">shaper:
normal: 1000
</pre></li><li class="li-itemize">To define a shaper named ‘<span style="font-family:monospace">fast</span>’ with traffic speed limited to
50,000 bytes/second:
<pre class="verbatim">shaper:
fast: 50000
</pre></li></ul><p> <a id="language"></a> </p>
<!--TOC subsection id="sec43" Default Language-->
<h3 id="sec43" class="subsection">3.1.8  <a href="#language">Default Language</a></h3><!--SEC END --><p> <a id="language"></a>
</p><p>The option <span style="font-family:monospace">language</span> defines the default language of server strings that
can be seen by XMPP clients. If a XMPP client does not support
<span style="font-family:monospace">xml:lang</span>, the specified language is used.</p><p>The option syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">language: Language</span></span></dt></dl><p>The default value is <span style="font-family:monospace">en</span>.
In order to take effect there must be a translation file
<span style="font-family:monospace">Language.msg</span> in <span style="font-family:monospace">ejabberd</span>’s <span style="font-family:monospace">msgs</span> directory.</p><p>For example, to set Russian as default language:
</p><pre class="verbatim">language: "ru"
</pre><p>Appendix <a href="#i18ni10n">A</a> provides more details about internationalization and localization.</p><p> <a id="captcha"></a> </p>
<!--TOC subsection id="sec44" CAPTCHA-->
<h3 id="sec44" class="subsection">3.1.9  <a href="#captcha">CAPTCHA</a></h3><!--SEC END --><p> <a id="captcha"></a>
</p><p>Some <span style="font-family:monospace">ejabberd</span> modules can be configured to require a CAPTCHA challenge on certain actions.
If the client does not support CAPTCHA Forms (<a href="http://xmpp.org/extensions/xep-0158.html">XEP-0158</a>),
a web link is provided so the user can fill the challenge in a web browser.</p><p>An example script is provided that generates the image
using ImageMagick’s Convert program.</p><p>The configurable options are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">captcha_cmd: Path</span></span></dt><dd class="dd-description">
Full path to a script that generates the image.
The default value disables the feature: <span style="font-family:monospace">undefined</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">captcha_host: ProtocolHostPort</span></span></dt><dd class="dd-description">
ProtocolHostPort is a string with the host, and optionally the Protocol and Port number.
It must identify where ejabberd listens for CAPTCHA requests.
The URL sent to the user is formed by: <span style="font-family:monospace">Protocol://Host:Port/captcha/</span>
The default value is: protocol <span style="font-family:monospace">http</span>, the first hostname configured, and port <span style="font-family:monospace">80</span>.
If you specify a port number that does not match exactly an ejabberd listener
(because you are using a reverse proxy or other port-forwarding tool),
then you must specify the transfer protocol, as seen in the example below.
</dd></dl><p>Additionally, an <span style="font-family:monospace">ejabberd_http</span> listener must be enabled with the <span style="font-family:monospace">captcha</span> option.
See section <a href="#listened-module">3.1.4</a>.</p><p>Example configuration:
</p><pre class="verbatim">hosts: ["example.org"]
captcha_cmd: "/lib/ejabberd/priv/bin/captcha.sh"
captcha_host: "example.org:5280"
## captcha_host: "https://example.org:443"
## captcha_host: "http://example.com"
listen:
...
-
port: 5280
module: ejabberd_http
captcha: true
...
</pre><p> <a id="stun"></a> </p>
<!--TOC subsection id="sec45" STUN-->
<h3 id="sec45" class="subsection">3.1.10  <a href="#stun">STUN</a></h3><!--SEC END --><p> <a id="stun"></a>
</p><p><span style="font-family:monospace">ejabberd</span> is able to act as a stand-alone STUN server
(<a href="http://tools.ietf.org/html/rfc5389">RFC 5389</a>). Currently only Binding usage
is supported. In that role <span style="font-family:monospace">ejabberd</span> helps clients with ICE (<a href="http://tools.ietf.org/html/rfc5245">RFC 5245</a>) or Jingle ICE (<a href="http://xmpp.org/extensions/xep-0176.html">XEP-0176</a>) support to discover their external addresses and ports.</p><p>You should configure <span style="font-family:monospace">ejabberd_stun</span> listening module as described in <a href="#listened">3.1.4</a> section.
If <span style="font-family:monospace">certfile</span> option is defined, <span style="font-family:monospace">ejabberd</span> multiplexes TCP and
TLS over TCP connections on the same port. Obviously, <span style="font-family:monospace">certfile</span> option
is defined for <span style="font-family:monospace">tcp</span> only. Note however that TCP or TLS over TCP
support is not required for Binding usage and is reserved for
<a href="http://tools.ietf.org/html/draft-ietf-behave-turn-16">TURN</a>
functionality. Feel free to configure <span style="font-family:monospace">udp</span> transport only.</p><p>Example configuration:
</p><pre class="verbatim">listen:
...
-
port: 3478
transport: udp
module: ejabberd_stun
-
port: 3478
module: ejabberd_stun
-
port: 5349
module: ejabberd_stun
certfile: "/etc/ejabberd/server.pem"
...
</pre><p>You also need to configure DNS SRV records properly so clients can easily discover a
STUN server serving your XMPP domain. Refer to section
<a href="http://tools.ietf.org/html/rfc5389#section-9">DNS Discovery of a Server</a>
of <a href="http://tools.ietf.org/html/rfc5389">RFC 5389</a> for details.</p><p>Example DNS SRV configuration:
</p><pre class="verbatim">_stun._udp IN SRV 0 0 3478 stun.example.com.
_stun._tcp IN SRV 0 0 3478 stun.example.com.
_stuns._tcp IN SRV 0 0 5349 stun.example.com.
</pre><p> <a id="sip"></a> </p>
<!--TOC subsection id="sec46" SIP-->
<h3 id="sec46" class="subsection">3.1.11  <a href="#sip">SIP</a></h3><!--SEC END --><p> <a id="sip"></a>
</p><p><span style="font-family:monospace">ejabberd</span> has built-in SIP support. In order to activate it you need to add
listeners for it, configure DNS properly and enable <span style="font-family:monospace">mod_sip</span> for
the desired virtual host.</p><p>To add a listener you should configure <span style="font-family:monospace">ejabberd_sip</span> listening module as
described in <a href="#listened">3.1.4</a> section. If option <span style="font-family:monospace">tls</span> is specified, option
<span style="font-family:monospace">certfile</span> must be specified as well, otherwise incoming TLS connections would fail.</p><p>Example configuration with standard ports
(as per <a href="http://tools.ietf.org/html/rfc3261">RFC 3261</a>):
</p><pre class="verbatim">listen:
...
-
port: 5060
transport: udp
module: ejabberd_sip
-
port: 5060
module: ejabberd_sip
-
port: 5061
module: ejabberd_sip
tls: true
certfile: "/etc/ejabberd/server.pem"
...
</pre><p>Note that there is no StartTLS support in SIP and <a href="http://en.wikipedia.org/wiki/Server_Name_Indication">SNI</a> support is somewhat tricky, so for TLS you have to configure
different virtual hosts on different ports if you have different certificate files for them.</p><p>Next you need to configure DNS SIP records for your virtual domains.
Refer to <a href="http://tools.ietf.org/html/rfc3263">RFC 3263</a> for the detailed explanation.
Simply put, you should add NAPTR and SRV records for your domains.
Skip NAPTR configuration if your DNS provider doesn’t support this type of records.
It’s not fatal, however, highly recommended.</p><p>Example configuration of NAPTR records:
</p><pre class="verbatim">example.com IN NAPTR 10 0 "s" "SIPS+D2T" "" _sips._tcp.example.com.
example.com IN NAPTR 20 0 "s" "SIP+D2T" "" _sip._tcp.example.com.
example.com IN NAPTR 30 0 "s" "SIP+D2U" "" _sip._udp.example.com.
</pre><p>Example configuration of SRV records with standard ports
(as per <a href="http://tools.ietf.org/html/rfc3261">RFC 3261</a>):
</p><pre class="verbatim">_sip._udp IN SRV 0 0 5060 sip.example.com.
_sip._tcp IN SRV 0 0 5060 sip.example.com.
_sips._tcp IN SRV 0 0 5061 sip.example.com.
</pre><p> <a id="includeconfigfile"></a> </p>
<!--TOC subsection id="sec47" Include Additional Configuration Files-->
<h3 id="sec47" class="subsection">3.1.12  <a href="#includeconfigfile">Include Additional Configuration Files</a></h3><!--SEC END --><p> <a id="includeconfigfile"></a>
</p><p>The option <span style="font-family:monospace">include_config_file</span> in a configuration file instructs <span style="font-family:monospace">ejabberd</span> to include other configuration files immediately.</p><p>The basic syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">include_config_file: [Filename]</span></span></dt></dl><p>
It is possible to specify suboptions using the full syntax:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">include_config_file: { Filename: [Suboption, ...] }</span></span></dt></dl><p>The filename can be indicated either as an absolute path,
or relative to the main <span style="font-family:monospace">ejabberd</span> configuration file.
It isn’t possible to use wildcards.
The file must exist and be readable.</p><p>The allowed suboptions are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">disallow: [Optionname, ...]</span></span></dt><dd class="dd-description"> Disallows the usage of those options in the included configuration file.
The options that match this criteria are not accepted.
The default value is an empty list: <span style="font-family:monospace">[]</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_only: [Optionname, ...]</span></span></dt><dd class="dd-description"> Allows only the usage of those options in the included configuration file.
The options that do not match this criteria are not accepted.
The default value is: <span style="font-family:monospace">all</span>
</dd></dl><p>This is a basic example:
</p><pre class="verbatim">include_config_file: "/etc/ejabberd/additional.yml"
</pre><p>In this example, the included file is not allowed to contain a <span style="font-family:monospace">listen</span> option.
If such an option is present, the option will not be accepted.
The file is in a subdirectory from where the main configuration file is.
</p><pre class="verbatim">include_config_file:
"./example.org/additional_not_listen.yml":
disallow: [listen]
</pre><p>In this example, <span style="font-family:monospace">ejabberd.yml</span> defines some ACL and Access rules,
and later includes another file with additional rules:
</p><pre class="verbatim">acl:
admin:
user:
- "admin": "localhost"
access:
announce:
admin: allow
include_config_file:
"/etc/ejabberd/acl_and_access.yml":
allow_only:
- acl
- access
</pre><p>and content of the file <span style="font-family:monospace">acl_and_access.yml</span> can be, for example:
</p><pre class="verbatim">acl:
admin:
user:
- "bob": "localhost"
- "jan": "localhost"
</pre><p> <a id="optionmacros"></a> </p>
<!--TOC subsection id="sec48" Option Macros in Configuration File-->
<h3 id="sec48" class="subsection">3.1.13  <a href="#optionmacros">Option Macros in Configuration File</a></h3><!--SEC END --><p> <a id="optionmacros"></a>
</p><p>In the <span style="font-family:monospace">ejabberd</span> configuration file,
it is possible to define a macro for a value
and later use this macro when defining an option.</p><p>A macro is defined with this syntax:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">define_macro: { ’MACRO’: Value }</span></span></dt></dl><p>
The <span style="font-family:monospace">MACRO</span> must be surrounded by single quotation marks,
and all letters in uppercase; check the examples bellow.
The <span style="font-family:monospace">value</span> can be any valid arbitrary Erlang term.</p><p>The first definition of a macro is preserved,
and additional definitions of the same macro are forgotten.</p><p>Macros are processed after
additional configuration files have been included,
so it is possible to use macros that
are defined in configuration files included before the usage.</p><p>It isn’t possible to use a macro in the definition
of another macro.</p><p>This example shows the basic usage of a macro:
</p><pre class="verbatim">define_macro:
'LOG_LEVEL_NUMBER': 5
loglevel: 'LOG_LEVEL_NUMBER'
</pre><p>The resulting option interpreted by <span style="font-family:monospace">ejabberd</span> is: <span style="font-family:monospace">loglevel: 5</span>.</p><p>This example shows that values can be any arbitrary Erlang term:
</p><pre class="verbatim">define_macro:
'USERBOB':
user:
- "bob": "localhost"
acl:
admin: 'USERBOB'
</pre><p>The resulting option interpreted by <span style="font-family:monospace">ejabberd</span> is:
</p><pre class="verbatim">acl:
admin:
user:
- "bob": "localhost"
</pre><p>This complex example:
</p><pre class="verbatim">define_macro:
'NUMBER_PORT_C2S': 5222
'NUMBER_PORT_HTTP': 5280
listen:
-
port: 'NUMBER_PORT_C2S'
module: ejabberd_c2s
-
port: 'NUMBER_PORT_HTTP'
module: ejabberd_http
</pre><p>produces this result after being interpreted:
</p><pre class="verbatim">listen:
-
port: 5222
module: ejabberd_c2s
-
port: 5280
module: ejabberd_http
</pre><p> <a id="database"></a> </p>
<!--TOC section id="sec49" Database and LDAP Configuration-->
<h2 id="sec49" class="section">3.2  <a href="#database">Database and LDAP Configuration</a></h2><!--SEC END --><p> <a id="database"></a>
</p><p><span style="font-family:monospace">ejabberd</span> uses its internal Mnesia database by default. However, it is
possible to use a relational database or an LDAP server to store persistent,
long-living data. <span style="font-family:monospace">ejabberd</span> is very flexible: you can configure different
authentication methods for different virtual hosts, you can configure different
authentication mechanisms for the same virtual host (fallback), you can set
different storage systems for modules, and so forth.</p><p>The following databases are supported by <span style="font-family:monospace">ejabberd</span>:
</p><ul class="itemize"><li class="li-itemize">
<a href="http://www.erlang.org/doc/apps/mnesia/index.html">Mnesia</a>
</li><li class="li-itemize"><a href="http://www.mysql.com/">MySQL</a>
</li><li class="li-itemize"><a href="http://en.wikipedia.org/wiki/Open_Database_Connectivity">Any ODBC compatible database</a>
</li><li class="li-itemize"><a href="http://www.postgresql.org/">PostgreSQL</a>
</li></ul><p>The following LDAP servers are tested with <span style="font-family:monospace">ejabberd</span>:
</p><ul class="itemize"><li class="li-itemize">
<a href="http://www.microsoft.com/activedirectory/">Active Directory</a>
(see section <a href="#ad">3.2.2</a>)
</li><li class="li-itemize"><a href="http://www.openldap.org/">OpenLDAP</a>
</li><li class="li-itemize"><a href="http://www.communigate.com/">CommuniGate Pro</a>
</li><li class="li-itemize">Normally any LDAP compatible server should work; inform us about your
success with a not-listed server so that we can list it here.
</li></ul><p>Important note about virtual hosting:
if you define several domains in ejabberd.yml (see section <a href="#hostnames">3.1.2</a>),
you probably want that each virtual host uses a different configuration of database, authentication and storage,
so that usernames do not conflict and mix between different virtual hosts.
For that purpose, the options described in the next sections
must be set inside a <span style="font-family:monospace">host_config</span> for each vhost (see section <a href="#virtualhost">3.1.3</a>).
For example:
</p><pre class="verbatim">host_config:
"public.example.org":
odbc_type: pgsql
odbc_server: "localhost"
odbc_database: "database-public-example-org"
odbc_username: "ejabberd"
odbc_password: "password"
auth_method: [odbc]
</pre><p> <a id="odbc"></a> </p>
<!--TOC subsection id="sec50" ODBC-->
<h3 id="sec50" class="subsection">3.2.1  <a href="#odbc">ODBC</a></h3><!--SEC END --><p> <a id="odbc"></a> </p><p>The actual database access is defined in the options with <span style="font-family:monospace">odbc_</span> prefix. The
values are used to define if we want to use ODBC, or one of the two native
interface available, PostgreSQL or MySQL.</p><p>The following paramaters are available:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">odbc_type: mysql | pgsql | odbc</span></span></dt><dd class="dd-description"> The type of an ODBC connection.
The default is <span style="font-family:monospace">odbc</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_server: String</span></span></dt><dd class="dd-description"> A hostname of the ODBC server. The default is
<span style="font-family:monospace">‘‘localhost’’</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_port: Port</span></span></dt><dd class="dd-description"> The port where the ODBC server is accepting connections.
The option is only valid for <span style="font-family:monospace">mysql</span> and <span style="font-family:monospace">pgsql</span>. The default is
<span style="font-family:monospace">3306</span> and <span style="font-family:monospace">5432</span> respectively.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_database: String</span></span></dt><dd class="dd-description"> The database name. The default is <span style="font-family:monospace">‘‘ejabberd’’</span>.
The option is only valid for <span style="font-family:monospace">mysql</span> and <span style="font-family:monospace">pgsql</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_username: String</span></span></dt><dd class="dd-description"> The username. The default is <span style="font-family:monospace">‘‘ejabberd’’</span>.
The option is only valid for <span style="font-family:monospace">mysql</span> and <span style="font-family:monospace">pgsql</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_password: String</span></span></dt><dd class="dd-description"> The password. The default is empty string.
The option is only valid for <span style="font-family:monospace">mysql</span> and <span style="font-family:monospace">pgsql</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_pool_size: N</span></span></dt><dd class="dd-description"> By default <span style="font-family:monospace">ejabberd</span> opens 10 connections to
the database for each virtual host. You can change this number by using this option.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_keepalive_interval: N</span></span></dt><dd class="dd-description"> You can configure an interval to
make a dummy SQL request to keep alive the connections to the database.
The default value is ’undefined’, so no keepalive requests are made.
Specify in seconds: for example 28800 means 8 hours.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">odbc_start_interval: N</span></span></dt><dd class="dd-description"> If the connection to the database fails,
<span style="font-family:monospace">ejabberd</span> waits 30 seconds before retrying.
You can modify this interval with this option.
</dd></dl><p>Example of plain ODBC connection:
</p><pre class="verbatim">odbc_server: "DSN=database;UID=ejabberd;PWD=password"
</pre><p>Example of MySQL connection:
</p><pre class="verbatim">odbc_type: mysql
odbc_server: "server.company.com"
odbc_port: 3306 # the default
odbc_database: "mydb"
odbc_username: "user1"
odbc_password: "**********"
odbc_pool_size: 5
</pre><p> <a id="odbcstorage"></a> </p>
<!--TOC subsubsection id="sec51" Storage-->
<h4 id="sec51" class="subsubsection"><a href="#odbcstorage">Storage</a></h4><!--SEC END --><p> <a id="odbcstorage"></a>
</p><p>An ODBC compatible database also can be used to store information into from
several <span style="font-family:monospace">ejabberd</span>
modules. See section <a href="#modoverview">3.3.1</a> to see which modules can be used with
relational databases like MySQL. To enable storage to your database, just make
sure that your database is running well (see previous sections), and add the
module option <span style="font-family:monospace">db_type: odbc</span>.</p><p> <a id="ldap"></a> </p>
<!--TOC subsection id="sec52" LDAP-->
<h3 id="sec52" class="subsection">3.2.2  <a href="#ldap">LDAP</a></h3><!--SEC END --><p> <a id="ldap"></a>
</p><p><span style="font-family:monospace">ejabberd</span> has built-in LDAP support. You can authenticate users against LDAP
server and use LDAP directory as vCard storage.</p><p>Usually <span style="font-family:monospace">ejabberd</span> treats LDAP as a read-only storage:
it is possible to consult data, but not possible to
create accounts or edit vCard that is stored in LDAP.
However, it is possible to change passwords if <span style="font-family:monospace">mod_register</span> module is enabled
and LDAP server supports
<a href="http://tools.ietf.org/html/rfc3062">RFC 3062</a>.</p><p> <a id="ldapconnection"></a> </p>
<!--TOC subsubsection id="sec53" Connection-->
<h4 id="sec53" class="subsubsection"><a href="#ldapconnection">Connection</a></h4><!--SEC END --><p> <a id="ldapconnection"></a> </p><p>Two connections are established to the LDAP server per vhost,
one for authentication and other for regular calls.</p><p>Parameters:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ldap_servers: [Servers, ...]</span></span></dt><dd class="dd-description"> List of IP addresses or DNS names of your
LDAP servers. This option is required.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_encrypt: none|tls</span></span></dt><dd class="dd-description"> Type of connection encryption to the LDAP server.
Allowed values are: <span style="font-family:monospace">none</span>, <span style="font-family:monospace">tls</span>.
The value <span style="font-family:monospace">tls</span> enables encryption by using LDAP over SSL.
Note that STARTTLS encryption is not supported.
The default value is: <span style="font-family:monospace">none</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_tls_verify: false|soft|hard</span></span></dt><dd class="dd-description">
This option specifies whether to verify LDAP server certificate or not when TLS is enabled.
When <span style="font-family:monospace">hard</span> is enabled <span style="font-family:monospace">ejabberd</span> doesn’t proceed if a certificate is invalid.
When <span style="font-family:monospace">soft</span> is enabled <span style="font-family:monospace">ejabberd</span> proceeds even if check fails.
The default is <span style="font-family:monospace">false</span> which means no checks are performed.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_tls_cacertfile: Path</span></span></dt><dd class="dd-description">
Path to file containing PEM encoded CA certificates. This option is needed
(and required) when TLS verification is enabled.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_tls_depth: Number</span></span></dt><dd class="dd-description">
Specifies the maximum verification depth when TLS verification is enabled,
i.e. how far in a chain of certificates the verification process can proceed
before the verification is considered to fail.
Peer certificate = 0, CA certificate = 1, higher level CA certificate = 2, etc.
The value 2 thus means that a chain can at most contain peer cert,
CA cert, next CA cert, and an additional CA cert. The default value is 1.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_port: Number</span></span></dt><dd class="dd-description"> Port to connect to your LDAP server.
The default port is 389 if encryption is disabled; and 636 if encryption is enabled.
If you configure a value, it is stored in <span style="font-family:monospace">ejabberd</span>’s database.
Then, if you remove that value from the configuration file,
the value previously stored in the database will be used instead of the default port.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_rootdn: RootDN</span></span></dt><dd class="dd-description"> Bind DN. The default value
is <span style="font-family:monospace">""</span> which means ‘anonymous connection’.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_password: Password</span></span></dt><dd class="dd-description"> Bind password. The default
value is <span style="font-family:monospace">""</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_deref_aliases: never|always|finding|searching</span></span></dt><dd class="dd-description"> Whether or not to dereference aliases. The default is <span style="font-family:monospace">never</span>.
</dd></dl><p>Example:
</p><pre class="verbatim">auth_method: [ldap]
ldap_servers:
- "ldap1.example.org"
ldap_port: 389
ldap_rootdn: "cn=Manager,dc=domain,dc=org"
ldap_password: "**********"
</pre><p> <a id="ldapauth"></a> </p>
<!--TOC subsubsection id="sec54" Authentication-->
<h4 id="sec54" class="subsubsection"><a href="#ldapauth">Authentication</a></h4><!--SEC END --><p> <a id="ldapauth"></a> </p><p>You can authenticate users against an LDAP directory.
Note that current LDAP implementation does not support SASL authentication.</p><p>Available options are:</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ldap_base: Base</span></span></dt><dd class="dd-description">LDAP base directory which stores
users accounts. This option is required.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_uids: [ ldap_uidattr | {ldap_uidattr: ldap_uidattr_format} ]</span></span></dt><dd class="dd-description">
LDAP attribute which holds a list of attributes to use as alternatives for getting the JID.
The default attributes are <span style="font-family:monospace">[{"uid", "%u"}]</span>.
The attributes are of the form:
<span style="font-family:monospace">[{ldap_uidattr}]</span> or <span style="font-family:monospace">[{ldap_uidattr, ldap_uidattr_format}]</span>.
You can use as many comma separated attributes as needed.
The values for <span style="font-family:monospace">ldap_uidattr</span> and
<span style="font-family:monospace">ldap_uidattr_format</span> are described as follow:
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ldap_uidattr</span></span></dt><dd class="dd-description">LDAP attribute which holds
the user’s part of a JID. The default value is <span style="font-family:monospace">"uid"</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_uidattr_format</span></span></dt><dd class="dd-description">Format of
the <span style="font-family:monospace">ldap_uidattr</span> variable. The format <em>must</em> contain one and
only one pattern variable <span style="font-family:monospace">"%u"</span> which will be replaced by the
user’s part of a JID. For example, <span style="font-family:monospace">"%u@example.org"</span>. The default
value is <span style="font-family:monospace">"%u"</span>.
</dd></dl>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_filter: Filter</span></span></dt><dd class="dd-description">
<a href="http://tools.ietf.org/html/rfc4515">RFC 4515</a> LDAP filter. The
default Filter value is: <span style="font-family:monospace">undefined</span>. Example:
<span style="font-family:monospace">"(&(objectClass=shadowAccount)(memberOf=Jabber Users))"</span>. Please, do
not forget to close brackets and do not use superfluous whitespaces. Also you
<em>must not</em> use <span style="font-family:monospace">ldap_uidattr</span> attribute in filter because this
attribute will be substituted in LDAP filter automatically.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_dn_filter: { Filter: FilterAttrs }</span></span></dt><dd class="dd-description">
This filter is applied on the results returned by the main filter. This filter
performs additional LDAP lookup to make the complete result. This is useful
when you are unable to define all filter rules in <span style="font-family:monospace">ldap_filter</span>. You
can define <span style="font-family:monospace">"%u"</span>, <span style="font-family:monospace">"%d"</span>, <span style="font-family:monospace">"%s"</span> and <span style="font-family:monospace">"%D"</span> pattern
variables in Filter: <span style="font-family:monospace">"%u"</span> is replaced by a user’s part of a JID,
<span style="font-family:monospace">"%d"</span> is replaced by the corresponding domain (virtual host),
all <span style="font-family:monospace">"%s"</span> variables are consecutively replaced by values of FilterAttrs
attributes and <span style="font-family:monospace">"%D"</span> is replaced by Distinguished Name. By default
<span style="font-family:monospace">ldap_dn_filter</span> is undefined.
Example:
<pre class="verbatim">ldap_dn_filter:
"(&(name=%s)(owner=%D)(user=%u@%d))": ["sn"]
</pre>Since this filter makes additional LDAP lookups, use it only in the
last resort: try to define all filter rules in <span style="font-family:monospace">ldap_filter</span> if possible.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{ldap_local_filter, Filter}</span></span></dt><dd class="dd-description">
If you can’t use <span style="font-family:monospace">ldap_filter</span> due to performance reasons
(the LDAP server has many users registered),
you can use this local filter.
The local filter checks an attribute in ejabberd,
not in LDAP, so this limits the load on the LDAP directory.
The default filter is: <span style="font-family:monospace">undefined</span>.
Example values:
<pre class="verbatim">{ldap_local_filter, {notequal, {"accountStatus",["disabled"]}}}.
{ldap_local_filter, {equal, {"accountStatus",["enabled"]}}}.
{ldap_local_filter, undefined}.
</pre></dd></dl><p> <a id="ldapexamples"></a> </p>
<!--TOC subsubsection id="sec55" Examples-->
<h4 id="sec55" class="subsubsection"><a href="#ldapexamples">Examples</a></h4><!--SEC END --><p> <a id="ldapexamples"></a> </p><p> <a id="ldapcommonexample"></a> </p>
<!--TOC paragraph id="sec56" Common example-->
<h5 id="sec56" class="paragraph"><a href="#ldapcommonexample">Common example</a></h5><!--SEC END --><p> <a id="ldapcommonexample"></a> </p><p>Let’s say <span style="font-family:monospace">ldap.example.org</span> is the name of our LDAP server. We have
users with their passwords in <span style="font-family:monospace">"ou=Users,dc=example,dc=org"</span> directory.
Also we have addressbook, which contains users emails and their additional
infos in <span style="font-family:monospace">"ou=AddressBook,dc=example,dc=org"</span> directory.
The connection to the LDAP server is encrypted using TLS,
and using the custom port 6123.
Corresponding authentication section should looks like this:</p><pre class="verbatim">## Authentication method
auth_method: [ldap]
## DNS name of our LDAP server
ldap_servers: ["ldap.example.org"]
## Bind to LDAP server as "cn=Manager,dc=example,dc=org" with password "secret"
ldap_rootdn: "cn=Manager,dc=example,dc=org"
ldap_password: "secret"
ldap_encrypt: tls
ldap_port: 6123
## Define the user's base
ldap_base: "ou=Users,dc=example,dc=org"
## We want to authorize users from 'shadowAccount' object class only
ldap_filter: "(objectClass=shadowAccount)"
</pre><p>Now we want to use users LDAP-info as their vCards. We have four attributes
defined in our LDAP schema: <span style="font-family:monospace">"mail"</span> — email address, <span style="font-family:monospace">"givenName"</span>
— first name, <span style="font-family:monospace">"sn"</span> — second name, <span style="font-family:monospace">"birthDay"</span> — birthday.
Also we want users to search each other. Let’s see how we can set it up:</p><pre class="verbatim">modules:
...
mod_vcard_ldap:
## We use the same server and port, but want to bind anonymously because
## our LDAP server accepts anonymous requests to
## "ou=AddressBook,dc=example,dc=org" subtree.
ldap_rootdn: ""
ldap_password: ""
## define the addressbook's base
ldap_base: "ou=AddressBook,dc=example,dc=org"
## uidattr: user's part of JID is located in the "mail" attribute
## uidattr_format: common format for our emails
ldap_uids:
"mail": "%u@mail.example.org"
## We have to define empty filter here, because entries in addressbook does not
## belong to shadowAccount object class
ldap_filter: ""
## Now we want to define vCard pattern
ldap_vcard_map:
"NICKNAME": {"%u": []} # just use user's part of JID as his nickname
"GIVEN": {"%s": ["givenName"]}
"FAMILY": {"%s": ["sn"]}
"FN": {"%s, %s": ["sn", "givenName"]}, # example: "Smith, John"
"EMAIL": {"%s": ["mail"]}
"BDAY": {"%s": ["birthDay"]}]}
## Search form
ldap_search_fields:
"User": "%u"
"Name": "givenName"
"Family Name": "sn"
"Email": "mail"
"Birthday": "birthDay"
## vCard fields to be reported
## Note that JID is always returned with search results
ldap_search_reported:
"Full Name": "FN"
"Nickname": "NICKNAME"
"Birthday": "BDAY"
...
</pre><p>Note that <span style="font-family:monospace">mod_vcard_ldap</span> module checks for the existence of the user before
searching in his information in LDAP.</p><p> <a id="ad"></a> </p>
<!--TOC paragraph id="sec57" Active Directory-->
<h5 id="sec57" class="paragraph"><a href="#ad">Active Directory</a></h5><!--SEC END --><p> <a id="ad"></a>
</p><p>Active Directory is just an LDAP-server with predefined attributes. A sample
configuration is shown below:</p><pre class="verbatim">auth_method: [ldap]
ldap_servers: ["office.org"] # List of LDAP servers
ldap_base: "DC=office,DC=org" # Search base of LDAP directory
ldap_rootdn: "CN=Administrator,CN=Users,DC=office,DC=org" # LDAP manager
ldap_password: "*******" # Password to LDAP manager
ldap_uids: ["sAMAccountName"]
ldap_filter: "(memberOf=*)"
modules:
...
mod_vcard_ldap:
ldap_vcard_map:
"NICKNAME": {"%u", []}
"GIVEN": {"%s", ["givenName"]}
"MIDDLE": {"%s", ["initials"]}
"FAMILY": {"%s", ["sn"]}
"FN": {"%s", ["displayName"]}
"EMAIL": {"%s", ["mail"]}
"ORGNAME": {"%s", ["company"]}
"ORGUNIT": {"%s", ["department"]}
"CTRY": {"%s", ["c"]}
"LOCALITY": {"%s", ["l"]}
"STREET": {"%s", ["streetAddress"]}
"REGION": {"%s", ["st"]}
"PCODE": {"%s", ["postalCode"]}
"TITLE": {"%s", ["title"]}
"URL": {"%s", ["wWWHomePage"]}
"DESC": {"%s", ["description"]}
"TEL": {"%s", ["telephoneNumber"]}]}
ldap_search_fields:
"User": "%u"
"Name": "givenName"
"Family Name": "sn"
"Email": "mail"
"Company": "company"
"Department": "department"
"Role": "title"
"Description": "description"
"Phone": "telephoneNumber"
ldap_search_reported:
"Full Name": "FN"
"Nickname": "NICKNAME"
"Email": "EMAIL"
...
</pre><p> <a id="modules"></a> </p>
<!--TOC section id="sec58" Modules Configuration-->
<h2 id="sec58" class="section">3.3  <a href="#modules">Modules Configuration</a></h2><!--SEC END --><p> <a id="modules"></a>
</p><p>The option <span style="font-family:monospace">modules</span> defines the list of modules that will be loaded after
<span style="font-family:monospace">ejabberd</span>’s startup. Each entry in the list is a tuple in which the first
element is the name of a module and the second is a list of options for that
module.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">modules: { ModuleName: ModuleOptions }</span></span></dt></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
In this example only the module <span style="font-family:monospace">mod_echo</span> is loaded and no module
options are specified between the square brackets:
<pre class="verbatim">modules:
mod_echo: {}
</pre></li><li class="li-itemize">In the second example the modules <span style="font-family:monospace">mod_echo</span>, <span style="font-family:monospace">mod_time</span>, and
<span style="font-family:monospace">mod_version</span> are loaded without options.
<pre class="verbatim">modules:
mod_echo: {}
mod_time: {}
mod_version: {}
</pre></li></ul><p> <a id="modoverview"></a> </p>
<!--TOC subsection id="sec59" Modules Overview-->
<h3 id="sec59" class="subsection">3.3.1  <a href="#modoverview">Modules Overview</a></h3><!--SEC END --><p> <a id="modoverview"></a>
</p><p>The following table lists all modules included in <span style="font-family:monospace">ejabberd</span>.</p><blockquote class="table"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<table border=1 style="border-spacing:0;" class="cellpadding1"><tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Module</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Feature</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Dependencies</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_adhoc</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Ad-Hoc Commands (<a href="http://xmpp.org/extensions/xep-0050.html">XEP-0050</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modannounce"><span style="font-family:monospace">mod_announce</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Manage announcements</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >recommends <span style="font-family:monospace">mod_adhoc</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_blocking</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Simple Communications Blocking (<a href="http://xmpp.org/extensions/xep-0191.html">XEP-0191</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_privacy</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_caps</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Entity Capabilities (<a href="http://xmpp.org/extensions/xep-0115.html">XEP-0115</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_carboncopy</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Message Carbons (<a href="http://xmpp.org/extensions/xep-0280.html">XEP-0280</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_configure</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Server configuration using Ad-Hoc</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_adhoc</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#moddisco"><span style="font-family:monospace">mod_disco</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Service Discovery (<a href="http://xmpp.org/extensions/xep-0030.html">XEP-0030</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modecho"><span style="font-family:monospace">mod_echo</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Echoes XMPP stanzas</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modhttpbind"><span style="font-family:monospace">mod_http_bind</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >XMPP over Bosh service (HTTP Binding)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modhttpfileserver"><span style="font-family:monospace">mod_http_fileserver</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Small HTTP file server</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modirc"><span style="font-family:monospace">mod_irc</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >IRC transport</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modlast"><span style="font-family:monospace">mod_last</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Last Activity (<a href="http://xmpp.org/extensions/xep-0012.html">XEP-0012</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modmuc"><span style="font-family:monospace">mod_muc</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Multi-User Chat (<a href="http://xmpp.org/extensions/xep-0045.html">XEP-0045</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modmuclog"><span style="font-family:monospace">mod_muc_log</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Multi-User Chat room logging</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_muc</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modoffline"><span style="font-family:monospace">mod_offline</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Offline message storage (<a href="http://xmpp.org/extensions/xep-0160.html">XEP-0160</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modping"><span style="font-family:monospace">mod_ping</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >XMPP Ping and periodic keepalives (<a href="http://xmpp.org/extensions/xep-0199.html">XEP-0199</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modprescounter"><span style="font-family:monospace">mod_pres_counter</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Detect presence subscription flood</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modprivacy"><span style="font-family:monospace">mod_privacy</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Blocking Communication (<a href="http://xmpp.org/extensions/xep-0016.html">XEP-0016</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modprivate"><span style="font-family:monospace">mod_private</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Private XML Storage (<a href="http://xmpp.org/extensions/xep-0049.html">XEP-0049</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modproxy"><span style="font-family:monospace">mod_proxy65</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >SOCKS5 Bytestreams (<a href="http://xmpp.org/extensions/xep-0065.html">XEP-0065</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modpubsub"><span style="font-family:monospace">mod_pubsub</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Pub-Sub (<a href="http://xmpp.org/extensions/xep-0060.html">XEP-0060</a>), PEP (<a href="http://xmpp.org/extensions/xep-0163.html">XEP-0163</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_caps</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modpubsub"><span style="font-family:monospace">mod_pubsub_odbc</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Pub-Sub (<a href="http://xmpp.org/extensions/xep-0060.html">XEP-0060</a>), PEP (<a href="http://xmpp.org/extensions/xep-0163.html">XEP-0163</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >supported DB (*) and <span style="font-family:monospace">mod_caps</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modregister"><span style="font-family:monospace">mod_register</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >In-Band Registration (<a href="http://xmpp.org/extensions/xep-0077.html">XEP-0077</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modregisterweb"><span style="font-family:monospace">mod_register_web</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Web for Account Registrations</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modroster"><span style="font-family:monospace">mod_roster</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Roster management (XMPP IM)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modservicelog"><span style="font-family:monospace">mod_service_log</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Copy user messages to logger service</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modsharedroster"><span style="font-family:monospace">mod_shared_roster</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Shared roster management</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_roster</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modsharedrosterldap"><span style="font-family:monospace">mod_shared_roster_ldap</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >LDAP Shared roster management</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_roster</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modsic"><span style="font-family:monospace">mod_sic</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Server IP Check (<a href="http://xmpp.org/extensions/xep-0279.html">XEP-0279</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modsip"><span style="font-family:monospace">mod_sip</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >SIP Registrar/Proxy (<a href="http://tools.ietf.org/html/rfc3261">RFC 3261</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">ejabberd_sip</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modstats"><span style="font-family:monospace">mod_stats</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Statistics Gathering (<a href="http://xmpp.org/extensions/xep-0039.html">XEP-0039</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modtime"><span style="font-family:monospace">mod_time</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Entity Time (<a href="http://xmpp.org/extensions/xep-0202.html">XEP-0202</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modvcard"><span style="font-family:monospace">mod_vcard</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >vcard-temp (<a href="http://xmpp.org/extensions/xep-0054.html">XEP-0054</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modvcardldap"><span style="font-family:monospace">mod_vcard_ldap</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >vcard-temp (<a href="http://xmpp.org/extensions/xep-0054.html">XEP-0054</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >LDAP server </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modvcardxupdate"><span style="font-family:monospace">mod_vcard_xupdate</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >vCard-Based Avatars (<a href="http://xmpp.org/extensions/xep-0153.html">XEP-0153</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">mod_vcard</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><a href="#modversion"><span style="font-family:monospace">mod_version</span></a></td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Software Version (<a href="http://xmpp.org/extensions/xep-0092.html">XEP-0092</a>)</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
</table>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><ul class="itemize"><li class="li-itemize">
(*) This module requires a supported database. For a list of supported databases, see section <a href="#database">3.2</a>.
</li></ul><p>You can see which database backend each module needs by looking at the suffix:
</p><ul class="itemize"><li class="li-itemize">
No suffix, this means that the module uses Erlang’s built-in database
Mnesia as backend, or a ODBC database in some cases (see <a href="#database">3.2</a>).
</li><li class="li-itemize">‘_ldap’, this means that the module needs an LDAP server as backend.
</li></ul><p>You can find more
<a href="http://www.ejabberd.im/contributions">contributed modules</a> on the
<span style="font-family:monospace">ejabberd</span> website. Please remember that these contributions might not work or
that they can contain severe bugs and security leaks. Therefore, use them at
your own risk!</p><p> <a id="modcommonoptions"></a> </p>
<!--TOC subsection id="sec60" Common Options-->
<h3 id="sec60" class="subsection">3.3.2  <a href="#modcommonoptions">Common Options</a></h3><!--SEC END --><p> <a id="modcommonoptions"></a> </p><p>The following options are used by many modules. Therefore, they are described in
this separate section.</p><p> <a id="modiqdiscoption"></a> </p>
<!--TOC subsubsection id="sec61" <span style="font-family:monospace">iqdisc</span>-->
<h4 id="sec61" class="subsubsection"><a href="#modiqdiscoption"><span style="font-family:monospace">iqdisc</span></a></h4><!--SEC END --><p> <a id="modiqdiscoption"></a>
</p><p>Many modules define handlers for processing IQ queries of different namespaces
to this server or to a user (e. g. to <span style="font-family:monospace">example.org</span> or to
<span style="font-family:monospace">user@example.org</span>). This option defines processing discipline for
these queries.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Value</span></span></dt></dl><p>Possible <span style="font-family:monospace">Value</span> are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">no_queue</span></span></dt><dd class="dd-description"> All queries of a namespace with this processing discipline are
processed directly. This means that the XMPP connection that sends this IQ query gets blocked:
no other packets can be processed
until this one has been completely processed. Hence this discipline is not
recommended if the processing of a query can take a relatively long time.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">one_queue</span></span></dt><dd class="dd-description"> In this case a separate queue is created for the processing
of IQ queries of a namespace with this discipline. In addition, the processing
of this queue is done in parallel with that of other packets. This discipline
is most recommended.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">N</span></span></dt><dd class="dd-description"> N separate queues are created to process the
queries. The queries are thus processed in parallel, but in a
controlled way.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">parallel</span></span></dt><dd class="dd-description"> For every packet with this discipline a separate Erlang process
is spawned. Consequently, all these packets are processed in parallel.
Although spawning of Erlang process has a relatively low cost, this can break
the server’s normal work, because the Erlang emulator has a limit on the
number of processes (32000 by default).
</dd></dl><p>Example:
</p><pre class="verbatim">modules:
...
mod_time:
iqdisc: no_queue
...
</pre><p> <a id="modhostoption"></a> </p>
<!--TOC subsubsection id="sec62" <span style="font-family:monospace">host</span>-->
<h4 id="sec62" class="subsubsection"><a href="#modhostoption"><span style="font-family:monospace">host</span></a></h4><!--SEC END --><p> <a id="modhostoption"></a>
</p><p>This option defines the Jabber ID of a service provided by an <span style="font-family:monospace">ejabberd</span> module.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt></dl><p>If you include the keyword "@HOST@" in the HostName,
it is replaced at start time with the real virtual host string.</p><p>This example configures
the echo module to provide its echoing service
in the Jabber ID <span style="font-family:monospace">mirror.example.org</span>:
</p><pre class="verbatim">modules:
...
mod_echo:
host: "mirror.example.org"
...
</pre><p>However, if there are several virtual hosts and this module is enabled in all of them,
the "@HOST@" keyword must be used:
</p><pre class="verbatim">modules:
...
mod_echo:
host: "mirror.@HOST@"
...
</pre><p> <a id="modannounce"></a> </p>
<!--TOC subsection id="sec63" <span style="font-family:monospace">mod_announce</span>-->
<h3 id="sec63" class="subsection">3.3.3  <a href="#modannounce"><span style="font-family:monospace">mod_announce</span></a></h3><!--SEC END --><p> <a id="modannounce"></a>
</p><p>This module enables configured users to broadcast announcements and to set
the message of the day (MOTD).
Configured users can perform these actions with a
XMPP client either using Ad-hoc commands
or sending messages to specific JIDs.</p><p>The Ad-hoc commands are listed in the Server Discovery.
For this feature to work, <span style="font-family:monospace">mod_adhoc</span> must be enabled.</p><p>The specific JIDs where messages can be sent are listed bellow.
The first JID in each entry will apply only to the specified virtual host
<span style="font-family:monospace">example.org</span>, while the JID between brackets will apply to all virtual
hosts in ejabberd.
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">example.org/announce/all (example.org/announce/all-hosts/all)</span></span></dt><dd class="dd-description"> The
message is sent to all registered users. If the user is online and connected
to several resources, only the resource with the highest priority will receive
the message. If the registered user is not connected, the message will be
stored offline in assumption that offline storage
(see section <a href="#modoffline">3.3.12</a>) is enabled.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">example.org/announce/online (example.org/announce/all-hosts/online)</span></span></dt><dd class="dd-description">The
message is sent to all connected users. If the user is online and connected
to several resources, all resources will receive the message.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">example.org/announce/motd (example.org/announce/all-hosts/motd)</span></span></dt><dd class="dd-description">The
message is set as the message of the day (MOTD) and is sent to users when they
login. In addition the message is sent to all connected users (similar to
<span style="font-family:monospace">announce/online</span>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)</span></span></dt><dd class="dd-description">
The message is set as message of the day (MOTD) and is sent to users when they
login. The message is <em>not sent</em> to any currently connected user.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)</span></span></dt><dd class="dd-description">
Any message sent to this JID removes the existing message of the day (MOTD).
</dd></dl><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access: AccessName</span></span></dt><dd class="dd-description"> This option specifies who is allowed to
send announcements and to set the message of the day (by default, nobody is
able to send such messages).
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
Only administrators can send announcements:
<pre class="verbatim">access:
announce:
admin: allow
modules:
...
mod_adhoc: {}
mod_announce:
access: announce
...
</pre></li><li class="li-itemize">Administrators as well as the direction can send announcements:
<pre class="verbatim">acl:
direction:
user:
"big_boss": "example.org"
"assistant": "example.org"
admin:
user:
"admin": "example.org"
access:
announce:
admin: allow
direction: allow
modules:
...
mod_adhoc: {}
mod_announce:
access: announce
...
</pre></li></ul><p>Note that <span style="font-family:monospace">mod_announce</span> can be resource intensive on large
deployments as it can broadcast lot of messages. This module should be
disabled for instances of <span style="font-family:monospace">ejabberd</span> with hundreds of thousands users.</p><p> <a id="moddisco"></a> </p>
<!--TOC subsection id="sec64" <span style="font-family:monospace">mod_disco</span>-->
<h3 id="sec64" class="subsection">3.3.4  <a href="#moddisco"><span style="font-family:monospace">mod_disco</span></a></h3><!--SEC END --><p> <a id="moddisco"></a>
</p><p>This module adds support for Service Discovery (<a href="http://xmpp.org/extensions/xep-0030.html">XEP-0030</a>). With
this module enabled, services on your server can be discovered by
XMPP clients. Note that <span style="font-family:monospace">ejabberd</span> has no modules with support
for the superseded Jabber Browsing (<a href="http://xmpp.org/extensions/xep-0011.html">XEP-0011</a>) and Agent Information
(<a href="http://xmpp.org/extensions/xep-0094.html">XEP-0094</a>). Accordingly, XMPP clients need to have support for
the newer Service Discovery protocol if you want them be able to discover
the services you offer.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Service Discovery (<span style="font-family:monospace">http://jabber.org/protocol/disco#items</span> and
<span style="font-family:monospace">http://jabber.org/protocol/disco#info</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">extra_domains: [Domain, ...]</span></span></dt><dd class="dd-description"> With this option,
you can specify a list of extra domains that are added to the Service Discovery item list.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">server_info: [ { modules: Modules, name: Name, urls: [URL, ...] } ]</span></span></dt><dd class="dd-description">
Specify additional information about the server,
as described in Contact Addresses for XMPP Services (<a href="http://xmpp.org/extensions/xep-0157.html">XEP-0157</a>).
<span style="font-family:monospace">Modules</span> can be the keyword ‘all’,
in which case the information is reported in all the services;
or a list of <span style="font-family:monospace">ejabberd</span> modules,
in which case the information is only specified for the services provided by those modules.
Any arbitrary <span style="font-family:monospace">Name</span> and <span style="font-family:monospace">URL</span> can be specified, not only contact addresses.
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
To serve a link to the Jabber User Directory on <span style="font-family:monospace">jabber.org</span>:
<pre class="verbatim">modules:
...
mod_disco:
extra_domains: ["users.jabber.org"]
...
</pre></li><li class="li-itemize">To serve a link to the transports on another server:
<pre class="verbatim">modules:
...
mod_disco:
extra_domains:
- "icq.example.com"
- "msn.example.com"
...
</pre></li><li class="li-itemize">To serve a link to a few friendly servers:
<pre class="verbatim">modules:
...
mod_disco:
extra_domains:
- "example.org"
- "example.com"
...
</pre></li><li class="li-itemize">With this configuration, all services show abuse addresses,
feedback address on the main server,
and admin addresses for both the main server and the vJUD service:
<pre class="verbatim">modules:
...
mod_disco:
server_info:
-
modules: all
name: "abuse-addresses"
urls: ["mailto:abuse@shakespeare.lit"]
-
modules: [mod_muc]
name: "Web chatroom logs"
urls: ["http://www.example.org/muc-logs"]
-
modules: [mod_disco]
name: "feedback-addresses"
urls:
- "http://shakespeare.lit/feedback.php"
- "mailto:feedback@shakespeare.lit"
- "xmpp:feedback@shakespeare.lit"
-
modules:
- mod_disco
- mod_vcard
name: "admin-addresses"
urls:
- "mailto:xmpp@shakespeare.lit"
- "xmpp:admins@shakespeare.lit"
...
</pre></li></ul><p> <a id="modecho"></a> </p>
<!--TOC subsection id="sec65" <span style="font-family:monospace">mod_echo</span>-->
<h3 id="sec65" class="subsection">3.3.5  <a href="#modecho"><span style="font-family:monospace">mod_echo</span></a></h3><!--SEC END --><p> <a id="modecho"></a>
</p><p>This module simply echoes any XMPP
packet back to the sender. This mirror can be of interest for
<span style="font-family:monospace">ejabberd</span> and XMPP client debugging.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt><dd class="dd-description"> This option defines the Jabber ID of the
service. If the <span style="font-family:monospace">host</span> option is not specified, the Jabber ID will be the
hostname of the virtual host with the prefix ‘<span style="font-family:monospace">echo.</span>’. The keyword "@HOST@"
is replaced at start time with the real virtual host name.
</dd></dl><p>Example: Mirror, mirror, on the wall, who is the most beautiful
of them all?
</p><pre class="verbatim">modules:
...
mod_echo:
host: "mirror.example.org"
...
</pre><p> <a id="modhttpbind"></a> </p>
<!--TOC subsection id="sec66" <span style="font-family:monospace">mod_http_bind</span>-->
<h3 id="sec66" class="subsection">3.3.6  <a href="#modhttpbind"><span style="font-family:monospace">mod_http_bind</span></a></h3><!--SEC END --><p> <a id="modhttpbind"></a>
</p><p>This module implements XMPP over Bosh (formerly known as HTTP Binding)
as defined in <a href="http://xmpp.org/extensions/xep-0124.html">XEP-0124</a> and <a href="http://xmpp.org/extensions/xep-0206.html">XEP-0206</a>.
It extends ejabberd’s built in HTTP service with a configurable
resource at which this service will be hosted.</p><p>To use HTTP-Binding, enable the module:
</p><pre class="verbatim">modules:
...
mod_http_bind: {}
...
</pre><p>and add <code>http_bind</code> in the HTTP service. For example:
</p><pre class="verbatim">listen:
...
-
port: 5280
module: ejabberd_http
http_bind: true
http_poll: true
web_admin: true
...
</pre><p>With this configuration, the module will serve the requests sent to
<code>http://example.org:5280/http-bind/</code>
Remember that this page is not designed to be used by web browsers,
it is used by XMPP clients that support XMPP over Bosh.</p><p>If you want to set the service in a different URI path or use a different module,
you can configure it manually using the option <code>request_handlers</code>.
For example:
</p><pre class="verbatim">listen:
...
-
port: 5280
module: ejabberd_http
request_handlers:
"/http-bind": mod_http_bind
http_poll: true
web_admin: true
...
</pre><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">{max_inactivity, Seconds}</span></span></dt><dd class="dd-description">
Define the maximum inactivity period in seconds.
Default value is 30 seconds.
For example, to set 50 seconds:
<pre class="verbatim">modules:
...
mod_http_bind:
max_inactivity: 50
...
</pre></dd></dl><p> <a id="modhttpfileserver"></a> </p>
<!--TOC subsection id="sec67" <span style="font-family:monospace">mod_http_fileserver</span>-->
<h3 id="sec67" class="subsection">3.3.7  <a href="#modhttpfileserver"><span style="font-family:monospace">mod_http_fileserver</span></a></h3><!--SEC END --><p> <a id="modhttpfileserver"></a>
</p><p>This simple module serves files from the local disk over HTTP.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">docroot: Path</span></span></dt><dd class="dd-description">
Directory to serve the files.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">accesslog: Path</span></span></dt><dd class="dd-description">
File to log accesses using an Apache-like format.
No log will be recorded if this option is not specified.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">directory_indices: [Index, ...]</span></span></dt><dd class="dd-description">
Indicate one or more directory index files, similarly to Apache’s
DirectoryIndex variable. When a web request hits a directory
instead of a regular file, those directory indices are looked in
order, and the first one found is returned.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">custom_headers: {Name: Value}</span></span></dt><dd class="dd-description">
Indicate custom HTTP headers to be included in all responses.
Default value is: <span style="font-family:monospace">[]</span>
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">content_types: {Name: Type}</span></span></dt><dd class="dd-description">
Specify mappings of extension to content type.
There are several content types already defined,
with this option you can add new definitions, modify or delete existing ones.
To delete an existing definition, simply define it with a value: ‘undefined’.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">default_content_type: Type</span></span></dt><dd class="dd-description">
Specify the content type to use for unknown extensions.
Default value is ‘application/octet-stream’.
</dd></dl><p>This example configuration will serve the files from
the local directory <code>/var/www</code>
in the address <code>http://example.org:5280/pub/archive/</code>.
In this example a new content type <span style="font-family:monospace">ogg</span> is defined,
<span style="font-family:monospace">png</span> is redefined, and <span style="font-family:monospace">jpg</span> definition is deleted.
To use this module you must enable it:
</p><pre class="verbatim">modules:
...
mod_http_fileserver:
docroot: "/var/www"
accesslog: "/var/log/ejabberd/access.log"
directory_indices:
- "index.html"
- "main.htm"
custom_headers:
"X-Powered-By": "Erlang/OTP"
"X-Fry": "It's a widely-believed fact!"
content_types:
".ogg": "audio/ogg"
".png": "image/png"
".jpg": undefined
default_content_type: "text/html"
...
</pre><p>And define it as a handler in the HTTP service:
</p><pre class="verbatim">listen:
...
-
port: 5280
module: ejabberd_http
request_handlers:
...
"/pub/archive": mod_http_fileserver
...
...
</pre><p> <a id="modirc"></a> </p>
<!--TOC subsection id="sec68" <span style="font-family:monospace">mod_irc</span>-->
<h3 id="sec68" class="subsection">3.3.8  <a href="#modirc"><span style="font-family:monospace">mod_irc</span></a></h3><!--SEC END --><p> <a id="modirc"></a>
</p><p>This module is an IRC transport that can be used to join channels on IRC
servers.</p><p>End user information:
</p><ul class="itemize"><li class="li-itemize">
A XMPP client with ‘groupchat 1.0’ support or Multi-User
Chat support (<a href="http://xmpp.org/extensions/xep-0045.html">XEP-0045</a>) is necessary to join IRC channels.
</li><li class="li-itemize">An IRC channel can be joined in nearly the same way as joining a
XMPP Multi-User Chat room. The difference is that the room name will
be ‘channel%<span style="font-family:monospace">irc.example.org</span>’ in case <span style="font-family:monospace">irc.example.org</span> is
the IRC server hosting ‘channel’. And of course the host should point
to the IRC transport instead of the Multi-User Chat service.
</li><li class="li-itemize">You can register your nickame by sending ‘IDENTIFY password’ to <br>
<span style="font-family:monospace">nickserver!irc.example.org@irc.jabberserver.org</span>.
</li><li class="li-itemize">Entering your password is possible by sending ‘LOGIN nick password’ <br>
to <span style="font-family:monospace">nickserver!irc.example.org@irc.jabberserver.org</span>.
</li><li class="li-itemize">The IRC transport provides Ad-Hoc Commands (<a href="http://xmpp.org/extensions/xep-0050.html">XEP-0050</a>)
to join a channel, and to set custom IRC username and encoding.
</li><li class="li-itemize">When using a popular XMPP server, it can occur that no
connection can be achieved with some IRC servers because they limit the
number of connections from one IP.
</li></ul><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt><dd class="dd-description"> This option defines the Jabber ID of the
service. If the <span style="font-family:monospace">host</span> option is not specified, the Jabber ID will be the
hostname of the virtual host with the prefix ‘<span style="font-family:monospace">irc.</span>’. The keyword "@HOST@"
is replaced at start time with the real virtual host name.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access: AccessName</span></span></dt><dd class="dd-description"> This option can be used to specify who
may use the IRC transport (default value: <span style="font-family:monospace">all</span>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">default_encoding: Encoding</span></span></dt><dd class="dd-description"> Set the default IRC encoding.
Default value: <span style="font-family:monospace">"iso8859-1"</span>
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
In the first example, the IRC transport is available on (all) your
virtual host(s) with the prefix ‘<span style="font-family:monospace">irc.</span>’. Furthermore, anyone is
able to use the transport. The default encoding is set to "iso8859-15".
<pre class="verbatim">modules:
...
mod_irc:
access: all
default_encoding: "iso8859-15"
...
</pre></li><li class="li-itemize">In next example the IRC transport is available with JIDs with prefix <span style="font-family:monospace">irc-t.net</span>.
Moreover, the transport is only accessible to two users
of <span style="font-family:monospace">example.org</span>, and any user of <span style="font-family:monospace">example.com</span>:
<pre class="verbatim">acl:
paying_customers:
user:
- "customer1": "example.org"
- "customer2": "example.org"
server: "example.com"
access:
irc_users:
paying_customers: allow
all: deny
modules:
...
mod_irc:
access: irc_users
host: "irc.example.net"
...
</pre></li></ul><p> <a id="modlast"></a> </p>
<!--TOC subsection id="sec69" <span style="font-family:monospace">mod_last</span>-->
<h3 id="sec69" class="subsection">3.3.9  <a href="#modlast"><span style="font-family:monospace">mod_last</span></a></h3><!--SEC END --><p> <a id="modlast"></a>
</p><p>This module adds support for Last Activity (<a href="http://xmpp.org/extensions/xep-0012.html">XEP-0012</a>). It can be used to
discover when a disconnected user last accessed the server, to know when a
connected user was last active on the server, or to query the uptime of the
<span style="font-family:monospace">ejabberd</span> server.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Last activity (<span style="font-family:monospace">jabber:iq:last</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modmuc"></a> </p>
<!--TOC subsection id="sec70" <span style="font-family:monospace">mod_muc</span>-->
<h3 id="sec70" class="subsection">3.3.10  <a href="#modmuc"><span style="font-family:monospace">mod_muc</span></a></h3><!--SEC END --><p> <a id="modmuc"></a>
</p><p>This module provides a Multi-User Chat (<a href="http://xmpp.org/extensions/xep-0045.html">XEP-0045</a>) service.
Users can discover existing rooms, join or create them.
Occupants of a room can chat in public or have private chats.</p><p>Some of the features of Multi-User Chat:
</p><ul class="itemize"><li class="li-itemize">
Sending public and private messages to room occupants.
</li><li class="li-itemize">Inviting other users to a room.
</li><li class="li-itemize">Setting a room subject.
</li><li class="li-itemize">Creating password protected rooms.
</li><li class="li-itemize">Kicking and banning occupants.
</li></ul><p>The MUC service allows any Jabber ID to register a nickname,
so nobody else can use that nickname in any room in the MUC service.
To register a nickname, open the Service Discovery in your
XMPP client and register in the MUC service.</p><p>This module supports clustering and load
balancing. One module can be started per cluster node. Rooms are
distributed at creation time on all available MUC module
instances. The multi-user chat module is clustered but the rooms
themselves are not clustered nor fault-tolerant: if the node managing a
set of rooms goes down, the rooms disappear and they will be recreated
on an available node on first connection attempt.</p><p>Module options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt><dd class="dd-description"> This option defines the Jabber ID of the
service. If the <span style="font-family:monospace">host</span> option is not specified, the Jabber ID will be the
hostname of the virtual host with the prefix ‘<span style="font-family:monospace">conference.</span>’. The keyword "@HOST@"
is replaced at start time with the real virtual host name.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access: AccessName</span></span></dt><dd class="dd-description"> You can specify who is allowed to use
the Multi-User Chat service. By default everyone is allowed to use it.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access_create: AccessName</span></span></dt><dd class="dd-description"> To configure who is
allowed to create new rooms at the Multi-User Chat service, this option can be used.
By default any account in the local ejabberd server is allowed to create rooms.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access_persistent: AccessName</span></span></dt><dd class="dd-description"> To configure who is
allowed to modify the ’persistent’ room option.
By default any account in the local ejabberd server is allowed to modify that option.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access_admin: AccessName</span></span></dt><dd class="dd-description"> This option specifies
who is allowed to administrate the Multi-User Chat service. The default
value is <span style="font-family:monospace">none</span>, which means that only the room creator can
administer his room.
The administrators can send a normal message to the service JID,
and it will be shown in all active rooms as a service message.
The administrators can send a groupchat message to the JID of an active room,
and the message will be shown in the room as a service message.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">history_size: Size</span></span></dt><dd class="dd-description"> A small history of
the current discussion is sent to users when they enter the
room. With this option you can define the number of history messages
to keep and send to users joining the room. The value is an
integer. Setting the value to <span style="font-family:monospace">0</span> disables the history feature
and, as a result, nothing is kept in memory. The default value is
<span style="font-family:monospace">20</span>. This value is global and thus affects all rooms on the
service.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_users: Number</span></span></dt><dd class="dd-description"> This option defines at
the service level, the maximum number of users allowed per
room. It can be lowered in each room configuration but cannot be
increased in individual room configuration. The default value is
200.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_users_admin_threshold: Number</span></span></dt><dd class="dd-description">
This option defines the
number of service admins or room owners allowed to enter the room when
the maximum number of allowed occupants was reached. The default limit
is 5.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_user_conferences: Number</span></span></dt><dd class="dd-description">
This option defines the maximum
number of rooms that any given user can join. The default value
is 10. This option is used to prevent possible abuses. Note that
this is a soft limit: some users can sometimes join more conferences
in cluster configurations.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_room_id: Number</span></span></dt><dd class="dd-description">
This option defines the maximum number of characters that Room ID
can have when creating a new room.
The default value is to not limit: infinite.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_room_name: Number</span></span></dt><dd class="dd-description">
This option defines the maximum number of characters that Room Name
can have when configuring the room.
The default value is to not limit: infinite.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_room_desc: Number</span></span></dt><dd class="dd-description">
This option defines the maximum number of characters that Room Description
can have when configuring the room.
The default value is to not limit: infinite.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">min_message_interval: Number</span></span></dt><dd class="dd-description">
This option defines the minimum interval between two messages send
by an occupant in seconds. This option is global and valid for all
rooms. A decimal value can be used. When this option is not defined,
message rate is not limited. This feature can be used to protect a
MUC service from occupant abuses and limit number of messages that will
be broadcasted by the service. A good value for this minimum message
interval is 0.4 second. If an occupant tries to send messages faster, an
error is send back explaining that the message has been discarded
and describing the reason why the message is not acceptable.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">min_presence_interval: Number</span></span></dt><dd class="dd-description">
This option defines the
minimum of time between presence changes coming from a given occupant in
seconds. This option is global and valid for all rooms. A
decimal value can be used. When this option is not defined, no
restriction is applied. This option can be used to protect a MUC
service for occupants abuses. If an occupant tries
to change its presence more often than the specified interval, the
presence is cached by <span style="font-family:monospace">ejabberd</span> and only the last presence is
broadcasted to all occupants in the room after expiration of the
interval delay. Intermediate presence packets are silently
discarded. A good value for this option is 4 seconds.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">default_room_options: {OptionName: OptionValue}</span></span></dt><dd class="dd-description">
This module option allows to define the desired default room options.
Note that the creator of a room can modify the options of his room
at any time using an XMPP client with MUC capability.
The available room options and the default values are:
<dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">allow_change_subj: true|false</span></span></dt><dd class="dd-description"> Allow occupants to change the subject.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_private_messages: true|false</span></span></dt><dd class="dd-description"> Occupants can send private messages to other occupants.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_private_messages_from_visitors: anyone|moderators|nobody</span></span></dt><dd class="dd-description"> Visitors can send private messages to other occupants.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_query_users: true|false</span></span></dt><dd class="dd-description"> Occupants can send IQ queries to other occupants.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_user_invites: false|true</span></span></dt><dd class="dd-description"> Allow occupants to send invitations.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_visitor_nickchange: true|false</span></span></dt><dd class="dd-description"> Allow visitors to
change nickname.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_visitor_status: true|false</span></span></dt><dd class="dd-description"> Allow visitors to send
status text in presence updates. If disallowed, the <span style="font-family:monospace">status</span>
text is stripped before broadcasting the presence update to all
the room occupants.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">anonymous: true|false</span></span></dt><dd class="dd-description"> The room is anonymous:
occupants don’t see the real JIDs of other occupants.
Note that the room moderators can always see the real JIDs of the occupants.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">captcha_protected: false</span></span></dt><dd class="dd-description">
When a user tries to join a room where he has no affiliation (not owner, admin or member),
the room requires him to fill a CAPTCHA challenge (see section <a href="#captcha">3.1.9</a>)
in order to accept her join in the room.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">logging: false|true</span></span></dt><dd class="dd-description"> The public messages are logged using <span style="font-family:monospace">mod_muc_log</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_users: 200</span></span></dt><dd class="dd-description"> Maximum number of occupants in the room.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">members_by_default: true|false</span></span></dt><dd class="dd-description"> The occupants that enter the room are participants by default, so they have ’voice’.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">members_only: false|true</span></span></dt><dd class="dd-description"> Only members of the room can enter.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">moderated: true|false</span></span></dt><dd class="dd-description"> Only occupants with ’voice’ can send public messages.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">password: "roompass123"</span></span></dt><dd class="dd-description"> Password of the room. You may want to enable the next option too.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">password_protected: false|true</span></span></dt><dd class="dd-description"> The password is required to enter the room.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">persistent: false|true</span></span></dt><dd class="dd-description"> The room persists even if the last participant leaves.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">public: true|false</span></span></dt><dd class="dd-description"> The room is public in the list of the MUC service, so it can be discovered.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">public_list: true|false</span></span></dt><dd class="dd-description"> The list of participants is public, without requiring to enter the room.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">title: "Room Title"</span></span></dt><dd class="dd-description"> A human-readable title of the room.
</dd></dl>
All of those room options can be set to <span style="font-family:monospace">true</span> or <span style="font-family:monospace">false</span>,
except <span style="font-family:monospace">password</span> and <span style="font-family:monospace">title</span> which are strings,
and <span style="font-family:monospace">max_users</span> that is integer.
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
In the first example everyone is allowed to use the Multi-User Chat
service. Everyone will also be able to create new rooms but only the user
<span style="font-family:monospace">admin@example.org</span> is allowed to administrate any room. In this
example he is also a global administrator. When <span style="font-family:monospace">admin@example.org</span>
sends a message such as ‘Tomorrow, the XMPP server will be moved
to new hardware. This will involve service breakdowns around 23:00 UMT.
We apologise for this inconvenience.’ to <span style="font-family:monospace">conference.example.org</span>,
it will be displayed in all active rooms. In this example the history
feature is disabled.
<pre class="verbatim">acl:
admin:
user:
- "admin": "example.org"
access:
muc_admin:
admin: allow
modules:
...
mod_muc:
access: all
access_create: all
access_admin: muc_admin
history_size: 0
...
</pre></li><li class="li-itemize">In the second example the Multi-User Chat service is only accessible by
paying customers registered on our domains and on other servers. Of course
the administrator is also allowed to access rooms. In addition, he is the
only authority able to create and administer rooms. When
<span style="font-family:monospace">admin@example.org</span> sends a message such as ‘Tomorrow, the Jabber
server will be moved to new hardware. This will involve service breakdowns
around 23:00 UMT. We apologise for this inconvenience.’ to
<span style="font-family:monospace">conference.example.org</span>, it will be displayed in all active rooms. No
<span style="font-family:monospace">history_size</span> option is used, this means that the feature is enabled
and the default value of 20 history messages will be send to the users.
<pre class="verbatim">acl:
paying_customers:
user:
- "customer1": "example.net"
- "customer2": "example.com"
- "customer3": "example.org"
admin:
user:
- "admin": "example.org"
access:
muc_admin
admin: allow
all: deny
muc_access:
paying_customers: allow
admin: allow
all: deny
modules:
...
mod_muc:
access: muc_access
access_create: muc_admin
access_admin: muc_admin
...
</pre></li><li class="li-itemize">In the following example, MUC anti abuse options are used. An
occupant cannot send more than one message every 0.4 seconds and cannot
change its presence more than once every 4 seconds.
The length of Room IDs and Room Names are limited to 20 characters,
and Room Description to 300 characters. No ACLs are
defined, but some user restriction could be added as well:<pre class="verbatim">modules:
...
mod_muc:
min_message_interval: 0.4
min_presence_interval: 4
max_room_id: 20
max_room_name: 20
max_room_desc: 300
...
</pre></li><li class="li-itemize">This example shows how to use <span style="font-family:monospace">default_room_options</span> to make sure
the newly created rooms have by default those options.
<pre class="verbatim">modules:
...
mod_muc:
access: muc_access
access_create: muc_admin
default_room_options:
allow_change_subj: false
allow_query_users: true
allow_private_messages: true
members_by_default: false
title: "New chatroom"
anonymous: false
access_admin: muc_admin
...
</pre></li></ul><p> <a id="modmuclog"></a> </p>
<!--TOC subsection id="sec71" <span style="font-family:monospace">mod_muc_log</span>-->
<h3 id="sec71" class="subsection">3.3.11  <a href="#modmuclog"><span style="font-family:monospace">mod_muc_log</span></a></h3><!--SEC END --><p> <a id="modmuclog"></a>
</p><p>This module enables optional logging of Multi-User Chat (MUC) public conversations to
HTML. Once you enable this module, users can join a room using a MUC capable
XMPP client, and if they have enough privileges, they can request the
configuration form in which they can set the option to enable room logging.</p><p>Features:
</p><ul class="itemize"><li class="li-itemize">
Room details are added on top of each page: room title, JID,
author, subject and configuration.
</li><li class="li-itemize">
The room JID in the generated HTML is a link to join the room (using
<a href="http://xmpp.org/rfcs/rfc5122.html">XMPP URI</a>).
</li><li class="li-itemize">Subject and room configuration changes are tracked and displayed.
</li><li class="li-itemize">Joins, leaves, nick changes, kicks, bans and ‘/me’ are tracked and
displayed, including the reason if available.
</li><li class="li-itemize">Generated HTML files are XHTML 1.0 Transitional and CSS compliant.
</li><li class="li-itemize">Timestamps are self-referencing links.
</li><li class="li-itemize">Links on top for quicker navigation: Previous day, Next day, Up.
</li><li class="li-itemize">CSS is used for style definition, and a custom CSS file can be used.
</li><li class="li-itemize">URLs on messages and subjects are converted to hyperlinks.
</li><li class="li-itemize">Timezone used on timestamps is shown on the log files.
</li><li class="li-itemize">A custom link can be added on top of each page.
</li></ul><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">access_log: AccessName</span></span></dt><dd class="dd-description">
This option restricts which occupants are allowed to enable or disable room
logging. The default value is <span style="font-family:monospace">muc_admin</span>. Note for this default setting
you need to have an access rule for <span style="font-family:monospace">muc_admin</span> in order to take effect.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">cssfile: false|URL</span></span></dt><dd class="dd-description">
With this option you can set whether the HTML files should have a custom CSS
file or if they need to use the embedded CSS file. Allowed values are
<span style="font-family:monospace">false</span> and an URL to a CSS file. With the first value, HTML files will
include the embedded CSS code. With the latter, you can specify the URL of the
custom CSS file (for example: <span style="font-family:monospace">"http://example.com/my.css"</span>). The default value
is <span style="font-family:monospace">false</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">dirname: room_jid|room_name</span></span></dt><dd class="dd-description">
Allows to configure the name of the room directory.
Allowed values are <span style="font-family:monospace">room_jid</span> and <span style="font-family:monospace">room_name</span>.
With the first value, the room directory name will be the full room JID.
With the latter, the room directory name will be only the room name,
not including the MUC service name.
The default value is <span style="font-family:monospace">room_jid</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">dirtype: subdirs|plain</span></span></dt><dd class="dd-description">
The type of the created directories can be specified with this option. Allowed
values are <span style="font-family:monospace">subdirs</span> and <span style="font-family:monospace">plain</span>. With the first value,
subdirectories are created for each year and month. With the latter, the
names of the log files contain the full date, and there are no subdirectories.
The default value is <span style="font-family:monospace">subdirs</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">file_format: html|plaintext</span></span></dt><dd class="dd-description">
Define the format of the log files:
<span style="font-family:monospace">html</span> stores in HTML format,
<span style="font-family:monospace">plaintext</span> stores in plain text.
The default value is <span style="font-family:monospace">html</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">file_permissions: {mode: Mode, group: Group}</span></span></dt><dd class="dd-description">
Define the permissions that must be used when creating the log files:
the number of the mode, and the numeric id of the group that will own the files.
The default value is <span style="font-family:monospace">{644, 33}</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">outdir: Path</span></span></dt><dd class="dd-description">
This option sets the full path to the directory in which the HTML files should
be stored. Make sure the <span style="font-family:monospace">ejabberd</span> daemon user has write access on that
directory. The default value is <span style="font-family:monospace">"www/muc"</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">spam_prevention: true|false</span></span></dt><dd class="dd-description">
To prevent spam, the <span style="font-family:monospace">spam_prevention</span> option adds a special attribute
to links that prevent their indexation by search engines. The default value
is <span style="font-family:monospace">true</span>, which mean that nofollow attributes will be added to user
submitted links.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">timezone: local|universal</span></span></dt><dd class="dd-description">
The time zone for the logs is configurable with this option. Allowed values
are <span style="font-family:monospace">local</span> and <span style="font-family:monospace">universal</span>. With the first value, the local time,
as reported to Erlang by the operating system, will be used. With the latter,
GMT/UTC time will be used. The default value is <span style="font-family:monospace">local</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">top_link: {URL: Text}</span></span></dt><dd class="dd-description">
With this option you can customize the link on the top right corner of each
log file. The default value is <span style="font-family:monospace">{"/", "Home"}</span>.
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
In the first example any room owner can enable logging, and a
custom CSS file will be used (http://example.com/my.css). The names
of the log files will contain the full date, and there will be no
subdirectories. The log files will be stored in /var/www/muclogs, and the
time zone will be GMT/UTC. Finally, the top link will be
<code><a href="http://www.jabber.ru/">Jabber.ru</a></code>.
<pre class="verbatim">access:
muc:
all: allow
modules:
...
mod_muc_log:
access_log: muc
cssfile: "http://example.com/my.css"
dirtype: plain
dirname: room_jid
outdir: "/var/www/muclogs"
timezone: universal
spam_prevention: true
top_link:
"http://www.jabber.ru/": "Jabber.ru"
...
</pre></li><li class="li-itemize">In the second example only <span style="font-family:monospace">admin1@example.org</span> and
<span style="font-family:monospace">admin2@example.net</span> can enable logging, and the embedded CSS file will be
used. The names of the log files will only contain the day (number),
and there will be subdirectories for each year and month. The log files will
be stored in /var/www/muclogs, and the local time will be used. Finally, the
top link will be the default <code><a href="/">Home</a></code>.
<pre class="verbatim">acl:
admin:
user:
- "admin1": "example.org"
- "admin2": "example.net"
access:
muc_log:
admin: allow
all: deny
modules:
...
mod_muc_log:
access_log: muc_log
cssfile: false
dirtype: subdirs
file_permissions:
mode: 644
group: 33
outdir: "/var/www/muclogs"
timezone: local
...
</pre></li></ul><p> <a id="modoffline"></a> </p>
<!--TOC subsection id="sec72" <span style="font-family:monospace">mod_offline</span>-->
<h3 id="sec72" class="subsection">3.3.12  <a href="#modoffline"><span style="font-family:monospace">mod_offline</span></a></h3><!--SEC END --><p> <a id="modoffline"></a>
</p><p>This module implements offline message storage (<a href="http://xmpp.org/extensions/xep-0160.html">XEP-0160</a>).
This means that all messages
sent to an offline user will be stored on the server until that user comes
online again. Thus it is very similar to how email works. Note that
<span style="font-family:monospace">ejabberdctl</span> has a command to delete expired messages
(see section <a href="#ejabberdctl">4.1</a>).</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access_max_user_messages: AccessName</span></span></dt><dd class="dd-description">
This option defines which access rule will be enforced to limit
the maximum number of offline messages that a user can have (quota).
When a user has too many offline messages, any new messages that he receive are discarded,
and a resource-constraint error is returned to the sender.
The default value is <span style="font-family:monospace">max_user_offline_messages</span>.
Then you can define an access rule with a syntax similar to
<span style="font-family:monospace">max_user_sessions</span> (see <a href="#configmaxsessions">3.1.6</a>).
</dd></dl><p>This example allows power users to have as much as 5000 offline messages,
administrators up to 2000,
and all the other users up to 100.
</p><pre class="verbatim">acl:
admin:
user:
- "admin1": "localhost"
- "admin2": "example.org"
poweruser:
user:
- "bob": "example.org"
- "jane": "example.org"
access:
max_user_offline_messages:
poweruser: 5000
admin: 2000
all: 100
modules:
...
mod_offline:
access_max_user_messages: max_user_offline_messages
...
</pre><p> <a id="modping"></a> </p>
<!--TOC subsection id="sec73" <span style="font-family:monospace">mod_ping</span>-->
<h3 id="sec73" class="subsection">3.3.13  <a href="#modping"><span style="font-family:monospace">mod_ping</span></a></h3><!--SEC END --><p> <a id="modping"></a>
</p><p>This module implements support for XMPP Ping (<a href="http://xmpp.org/extensions/xep-0199.html">XEP-0199</a>) and periodic keepalives.
When this module is enabled ejabberd responds correctly to
ping requests, as defined in the protocol.</p><p>Configuration options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">send_pings: true|false</span></span></dt><dd class="dd-description">
If this option is set to <span style="font-family:monospace">true</span>, the server sends pings to connected clients
that are not active in a given interval <span style="font-family:monospace">ping_interval</span>.
This is useful to keep client connections alive or checking availability.
By default this option is disabled.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ping_interval: Seconds</span></span></dt><dd class="dd-description">
How often to send pings to connected clients, if the previous option is enabled.
If a client connection does not send or receive any stanza in this interval,
a ping request is sent to the client.
The default value is 60 seconds.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">timeout_action: none|kill</span></span></dt><dd class="dd-description">
What to do when a client does not answer to a server ping request in less than 32 seconds.
The default is to do nothing.
</dd></dl><p>This example enables Ping responses, configures the module to send pings
to client connections that are inactive for 4 minutes,
and if a client does not answer to the ping in less than 32 seconds, its connection is closed:
</p><pre class="verbatim">modules:
...
mod_ping:
send_pings: true
ping_interval: 240
timeout_action: kill
...
</pre><p> <a id="modprescounter"></a> </p>
<!--TOC subsection id="sec74" <span style="font-family:monospace">mod_pres_counter</span>-->
<h3 id="sec74" class="subsection">3.3.14  <a href="#modprescounter"><span style="font-family:monospace">mod_pres_counter</span></a></h3><!--SEC END --><p> <a id="modprescounter"></a>
</p><p>This module detects flood/spam in presence subscription stanza traffic.
If a user sends or receives more of those stanzas in a time interval,
the exceeding stanzas are silently dropped, and warning is logged.</p><p>Configuration options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">count: StanzaNumber</span></span></dt><dd class="dd-description">
The number of subscription presence stanzas
(subscribe, unsubscribe, subscribed, unsubscribed)
allowed for any direction (input or output)
per time interval.
Please note that two users subscribing to each other usually generate
4 stanzas, so the recommended value is 4 or more.
The default value is: 5.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">interval: Seconds</span></span></dt><dd class="dd-description">
The time interval defined in seconds.
The default value is 60.
</dd></dl><p>This example enables the module, and allows up to 5 presence subscription stanzas
to be sent or received by the users in 60 seconds:
</p><pre class="verbatim">modules:
...
mod_pres_counter:
count: 5
interval: 60
...
</pre><p> <a id="modprivacy"></a> </p>
<!--TOC subsection id="sec75" <span style="font-family:monospace">mod_privacy</span>-->
<h3 id="sec75" class="subsection">3.3.15  <a href="#modprivacy"><span style="font-family:monospace">mod_privacy</span></a></h3><!--SEC END --><p> <a id="modprivacy"></a>
</p><p>This module implements Blocking Communication (also known as Privacy Rules)
as defined in section 10 from XMPP IM. If end users have support for it in
their XMPP client, they will be able to:
</p><blockquote class="quote">
<ul class="itemize"><li class="li-itemize">
Retrieving one’s privacy lists.
</li><li class="li-itemize">Adding, removing, and editing one’s privacy lists.
</li><li class="li-itemize">Setting, changing, or declining active lists.
</li><li class="li-itemize">Setting, changing, or declining the default list (i.e., the list that
is active by default).
</li><li class="li-itemize">Allowing or blocking messages based on JID, group, or subscription type
(or globally).
</li><li class="li-itemize">Allowing or blocking inbound presence notifications based on JID, group,
or subscription type (or globally).
</li><li class="li-itemize">Allowing or blocking outbound presence notifications based on JID, group,
or subscription type (or globally).
</li><li class="li-itemize">Allowing or blocking IQ stanzas based on JID, group, or subscription type
(or globally).
</li><li class="li-itemize">Allowing or blocking all communications based on JID, group, or
subscription type (or globally).
</li></ul>
(from <a href="http://xmpp.org/rfcs/rfc3921.html#privacy"><span style="font-family:monospace">http://xmpp.org/rfcs/rfc3921.html#privacy</span></a>)
</blockquote><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Blocking Communication (<span style="font-family:monospace">jabber:iq:privacy</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modprivate"></a> </p>
<!--TOC subsection id="sec76" <span style="font-family:monospace">mod_private</span>-->
<h3 id="sec76" class="subsection">3.3.16  <a href="#modprivate"><span style="font-family:monospace">mod_private</span></a></h3><!--SEC END --><p> <a id="modprivate"></a>
</p><p>This module adds support for Private XML Storage (<a href="http://xmpp.org/extensions/xep-0049.html">XEP-0049</a>):
</p><blockquote class="quote">
Using this method, XMPP entities can store private data on the server and
retrieve it whenever necessary. The data stored might be anything, as long as
it is valid XML. One typical usage for this namespace is the server-side storage
of client-specific preferences; another is Bookmark Storage (<a href="http://xmpp.org/extensions/xep-0048.html">XEP-0048</a>).
</blockquote><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Private XML Storage (<span style="font-family:monospace">jabber:iq:private</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modproxy"></a> </p>
<!--TOC subsection id="sec77" <span style="font-family:monospace">mod_proxy65</span>-->
<h3 id="sec77" class="subsection">3.3.17  <a href="#modproxy"><span style="font-family:monospace">mod_proxy65</span></a></h3><!--SEC END --><p> <a id="modproxy"></a>
</p><p>This module implements SOCKS5 Bytestreams (<a href="http://xmpp.org/extensions/xep-0065.html">XEP-0065</a>).
It allows <span style="font-family:monospace">ejabberd</span> to act as a file transfer proxy between two
XMPP clients.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt><dd class="dd-description"> This option defines the Jabber ID of the
service. If the <span style="font-family:monospace">host</span> option is not specified, the Jabber ID will be the
hostname of the virtual host with the prefix ‘<span style="font-family:monospace">proxy.</span>’. The keyword "@HOST@"
is replaced at start time with the real virtual host name.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">name: Text</span></span></dt><dd class="dd-description">Defines Service Discovery name of the service.
Default is <span style="font-family:monospace">"SOCKS5 Bytestreams"</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ip: IP</span></span></dt><dd class="dd-description">This option specifies which network interface
to listen for. Default is an IP address of the service’s DNS name, or,
if fails, <code>"127.0.0.1"</code>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">port: Number</span></span></dt><dd class="dd-description">This option defines port to listen for
incoming connections. Default is 7777.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">hostname: HostName</span></span></dt><dd class="dd-description">Defines a hostname advertised
by the service when establishing a session with clients. This is useful when
you run the service behind a NAT. The default is the value of <span style="font-family:monospace">ip</span> option.
Examples: <span style="font-family:monospace">"proxy.mydomain.org"</span>, <span style="font-family:monospace">"200.150.100.50"</span>. Note that
not all clients understand domain names in stream negotiation,
so you should think twice before setting domain name in this option.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">auth_type: anonymous|plain</span></span></dt><dd class="dd-description">SOCKS5 authentication type.
Possible values are <span style="font-family:monospace">anonymous</span> and <span style="font-family:monospace">plain</span>. Default is
<span style="font-family:monospace">anonymous</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access: AccessName</span></span></dt><dd class="dd-description">Defines ACL for file transfer initiators.
Default is <span style="font-family:monospace">all</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_connections: Number</span></span></dt><dd class="dd-description">Maximum number of
active connections per file transfer initiator. No limit by default.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">shaper: none|ShaperName</span></span></dt><dd class="dd-description">This option defines shaper for
the file transfer peers. Shaper with the maximum bandwidth will be selected.
Default is <span style="font-family:monospace">none</span>.
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
The simpliest configuration of the module:
<pre class="verbatim">modules:
...
mod_proxy65: {}
...
</pre></li><li class="li-itemize">More complicated configuration.
<pre class="verbatim">acl:
admin:
user:
- "admin": "example.org"
proxy_users:
server:
- "example.org"
access:
proxy65_access:
proxy_users: allow
all: deny
proxy65_shaper:
admin: none
proxy_users: proxyrate
shaper:
proxyrate: 10240
modules:
...
mod_proxy65:
host: "proxy1.example.org"
name: "File Transfer Proxy"
ip: "200.150.100.1"
port: 7778
max_connections: 5
access: proxy65_access
shaper: proxy65_shaper
...
</pre></li></ul><p> <a id="modpubsub"></a> </p>
<!--TOC subsection id="sec78" <span style="font-family:monospace">mod_pubsub</span>-->
<h3 id="sec78" class="subsection">3.3.18  <a href="#modpubsub"><span style="font-family:monospace">mod_pubsub</span></a></h3><!--SEC END --><p> <a id="modpubsub"></a>
</p><p>This module offers a Publish-Subscribe Service (<a href="http://xmpp.org/extensions/xep-0060.html">XEP-0060</a>).
The functionality in <span style="font-family:monospace">mod_pubsub</span> can be extended using plugins.
The plugin that implements PEP (Personal Eventing via Pubsub) (<a href="http://xmpp.org/extensions/xep-0163.html">XEP-0163</a>)
is enabled in the default ejabberd configuration file,
and it requires <span style="font-family:monospace">mod_caps</span>.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt><dd class="dd-description"> This option defines the Jabber ID of the
service. If the <span style="font-family:monospace">host</span> option is not specified, the Jabber ID will be the
hostname of the virtual host with the prefix ‘<span style="font-family:monospace">pubsub.</span>’. The keyword "@HOST@"
is replaced at start time with the real virtual host name.
If you use <span style="font-family:monospace">mod_pubsub_odbc</span>, please ensure the prefix contains only one dot,
for example ‘<span style="font-family:monospace">pubsub.</span>’, or ‘<span style="font-family:monospace">publish.</span>’,.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access_createnode: AccessName</span></span></dt><dd class="dd-description">
This option restricts which users are allowed to create pubsub nodes using
ACL and ACCESS.
By default any account in the local ejabberd server is allowed to create pubsub nodes.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">max_items_node: MaxItems</span></span></dt><dd class="dd-description">
Define the maximum number of items that can be stored in a node.
Default value is 10.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">plugins: [ Plugin, ...]</span></span></dt><dd class="dd-description">
To specify which pubsub node plugins to use.
The first one in the list is used by default.
If this option is not defined, the default plugins list is: <span style="font-family:monospace">["flat"]</span>.
PubSub clients can define which plugin to use when creating a node:
add <span style="font-family:monospace">type=’plugin-name’</span> attribute to the <span style="font-family:monospace">create</span> stanza element.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">nodetree: Nodetree</span></span></dt><dd class="dd-description">
To specify which nodetree to use.
If not defined, the default pubsub nodetree is used: "tree".
Only one nodetree can be used per host, and is shared by all node plugins.<p>The "virtual" nodetree does not store nodes on database.
This saves resources on systems with tons of nodes.
If using the "virtual" nodetree,
you can only enable those node plugins:
["flat","pep"] or ["flat"];
any other plugins configuration will not work.
Also, all nodes will have the defaut configuration,
and this can not be changed.
Using "virtual" nodetree requires to start from a clean database,
it will not work if you used the default "tree" nodetree before.</p><p>The "dag" nodetree provides experimental support for PubSub Collection Nodes (<a href="http://xmpp.org/extensions/xep-0248.html">XEP-0248</a>).
In that case you should also add "dag" node plugin as default, for example:
<span style="font-family:monospace">plugins: ["dag","flat","hometree","pep"]</span>
</p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ignore_pep_from_offline: false|true</span></span></dt><dd class="dd-description">
To specify whether or not we should get last published PEP items
from users in our roster which are offline when we connect. Value is true or false.
If not defined, pubsub assumes true so we only get last items of online contacts.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">last_item_cache: false|true</span></span></dt><dd class="dd-description">
To specify whether or not pubsub should cache last items. Value is true
or false. If not defined, pubsub do not cache last items. On systems with not so many nodes,
caching last items speeds up pubsub and allows to raise user connection rate. The cost is memory
usage, as every item is stored in memory.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">pep_mapping: {Key, Value}</span></span></dt><dd class="dd-description">
This allow to define a Key-Value list to choose defined node plugins on given PEP namespace.
The following example will use node_tune instead of node_pep for every PEP node with tune namespace:
<pre class="verbatim">modules:
...
mod_pubsub:
pep_mapping:
"http://jabber.org/protocol/tune": "tune"
...
</pre></dd></dl><p>Example of configuration that uses flat nodes as default, and allows use of flat, nodetree and pep nodes:
</p><pre class="verbatim">modules:
...
mod_pubsub:
access_createnode: pubsub_createnode
plugins:
- "flat"
- "hometree"
- "pep"
...
</pre><p>Using ODBC database requires using mod_pubsub_odbc without option changes. Only flat, hometree and pep plugins supports ODBC.
The following example shows previous configuration with ODBC usage:
</p><pre class="verbatim">modules:
...
mod_pubsub_odbc:
access_createnode: pubsub_createnode
plugins:
- "flat"
- "hometree"
- "pep"
...
</pre><p> <a id="modregister"></a> </p>
<!--TOC subsection id="sec79" <span style="font-family:monospace">mod_register</span>-->
<h3 id="sec79" class="subsection">3.3.19  <a href="#modregister"><span style="font-family:monospace">mod_register</span></a></h3><!--SEC END --><p> <a id="modregister"></a>
</p><p>This module adds support for In-Band Registration (<a href="http://xmpp.org/extensions/xep-0077.html">XEP-0077</a>). This protocol
enables end users to use a XMPP client to:
</p><ul class="itemize"><li class="li-itemize">
Register a new account on the server.
</li><li class="li-itemize">Change the password from an existing account on the server.
</li><li class="li-itemize">Delete an existing account on the server.
</li></ul><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">access: AccessName</span></span></dt><dd class="dd-description">
Specify rules to restrict what usernames can be registered and unregistered.
If a rule returns ‘deny’ on the requested username,
registration and unregistration of that user name is denied.
There are no restrictions by default.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access_from: AccessName</span></span></dt><dd class="dd-description"> By default, <span style="font-family:monospace">ejabberd</span>
doesn’t allow to register new accounts from s2s or existing c2s sessions. You can
change it by defining access rule in this option. Use with care: allowing registration
from s2s leads to uncontrolled massive accounts creation by rogue users.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">captcha_protected: false|true</span></span></dt><dd class="dd-description">
Protect registrations with CAPTCHA (see section <a href="#captcha">3.1.9</a>). The default is <span style="font-family:monospace">false</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ip_access: AccessName</span></span></dt><dd class="dd-description">
Define rules to allow or deny account registration depending
on the IP address of the XMPP client. The <span style="font-family:monospace">AccessName</span> should be
of type <span style="font-family:monospace">ip</span>. The default value is <span style="font-family:monospace">all</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">password_strength: Entropy</span></span></dt><dd class="dd-description">
This option sets the minimum informational entropy for passwords. The value <span style="font-family:monospace">Entropy</span>
is a number of bits of entropy. The recommended minimum is 32 bits.
The default is 0, i.e. no checks are performed.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">welcome_message: {subject: Subject, body: Body}</span></span></dt><dd class="dd-description">
Set a welcome message that
is sent to each newly registered account. The first string is the subject, and
the second string is the message body.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">registration_watchers: [ JID, ...]</span></span></dt><dd class="dd-description"> This option defines a
list of JIDs which will be notified each time a new account is registered.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for In-Band Registration (<span style="font-family:monospace">jabber:iq:register</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p>This module reads also another option defined globally for the server:
<span style="font-family:monospace">registration_timeout: Timeout</span>.
This option limits the frequency of registration from a given IP or username.
So, a user that tries to register a new account from the same IP address or JID during
this number of seconds after his previous registration
will receive an error <span style="font-family:monospace">resource-constraint</span> with the explanation:
“Users are not allowed to register accounts so quickly”.
The timeout is expressed in seconds, and it must be an integer.
To disable this limitation,
instead of an integer put a word like: <span style="font-family:monospace">infinity</span>.
Default value: 600 seconds.</p><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
Next example prohibits the registration of too short account names,
and allows to create accounts only to clients of the local network:
<pre class="verbatim">acl:
loopback:
ip:
- "127.0.0.0/8"
- "::"
shortname:
user_glob:
- "?"
- "??"
## The same using regexp:
##user_regexp: "^..?$"
access:
mynetworks:
loopback: allow
all: deny
register:
shortname: deny
all: allow
modules:
mod_register:
ip_access: mynetworks
access: register
</pre></li><li class="li-itemize">This configuration prohibits usage of In-Band Registration
to create or delete accounts,
but allows existing accounts to change the password:
<pre class="verbatim">access:
register:
all: deny
modules:
...
mod_register:
access: register
...
</pre></li><li class="li-itemize">This configuration disables all In-Band Registration
functionality: create, delete accounts and change password:
<pre class="verbatim">modules:
...
## mod_register:
## access: register
...
</pre></li><li class="li-itemize">Define the welcome message and two registration watchers.
Also define a registration timeout of one hour:
<pre class="verbatim">registration_timeout: 3600
modules:
...
mod_register:
welcome_message:
subject: "Welcome!"
body: |-
Hi.
Welcome to this Jabber server.
Check http://www.jabber.org
Bye
registration_watchers:
- "admin1@example.org"
- "boss@example.net"
...
</pre></li></ul><p> <a id="modregisterweb"></a> </p>
<!--TOC subsection id="sec80" <span style="font-family:monospace">mod_register_web</span>-->
<h3 id="sec80" class="subsection">3.3.20  <a href="#modregisterweb"><span style="font-family:monospace">mod_register_web</span></a></h3><!--SEC END --><p> <a id="modregisterweb"></a>
</p><p>This module provides a web page where people can:
</p><ul class="itemize"><li class="li-itemize">
Register a new account on the server.
</li><li class="li-itemize">Change the password from an existing account on the server.
</li><li class="li-itemize">Delete an existing account on the server.
</li></ul><p>This module supports CAPTCHA image to register a new account.
To enable this feature, configure the options captcha_cmd and captcha_host.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">registration_watchers: [ JID, ...]</span></span></dt><dd class="dd-description"> This option defines a
list of JIDs which will be notified each time a new account is registered.
</dd></dl><p>This example configuration shows how to enable the module and the web handler:
</p><pre class="verbatim">hosts:
- "localhost"
- "example.org"
- "example.com"
listen:
...
-
port: 5281
module: ejabberd_http
register: true
certfile: "/etc/ejabberd/certificate.pem"
tls: true
...
modules:
...
mod_register_web: {}
...
</pre><p>For example, the users of the host <span style="font-family:monospace">example.org</span> can visit the page:
<span style="font-family:monospace">https://example.org:5281/register/</span>
It is important to include the last / character in the URL,
otherwise the subpages URL will be incorrect.</p><p> <a id="modroster"></a> </p>
<!--TOC subsection id="sec81" <span style="font-family:monospace">mod_roster</span>-->
<h3 id="sec81" class="subsection">3.3.21  <a href="#modroster"><span style="font-family:monospace">mod_roster</span></a></h3><!--SEC END --><p> <a id="modroster"></a>
</p><p>This module implements roster management as defined in
<a href="http://xmpp.org/rfcs/rfc3921.html#roster">RFC 3921: XMPP IM</a>.
It also supports Roster Versioning (<a href="http://xmpp.org/extensions/xep-0237.html">XEP-0237</a>).</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Roster Management (<span style="font-family:monospace">jabber:iq:roster</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">versioning: false|true</span></span></dt><dd class="dd-description"> Enables
Roster Versioning.
This option is disabled by default.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">store_current_id: false|true</span></span></dt><dd class="dd-description">
If this option is enabled, the current version number is stored on the database.
If disabled, the version number is calculated on the fly each time.
Enabling this option reduces the load for both ejabberd and the database.
This option does not affect the client in any way.
This option is only useful if Roster Versioning is enabled.
This option is disabled by default.
Important: if you use <span style="font-family:monospace">mod_shared_roster</span> or <span style="font-family:monospace">mod_shared_roster_ldap</span>,
you must disable this option.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">access</span></span></dt><dd class="dd-description">
This option can be configured to specify rules to restrict roster management.
If a rule returns ‘deny’ on the requested user name,
that user cannot modify his personal roster:
not add/remove/modify contacts,
or subscribe/unsubscribe presence.
By default there aren’t restrictions.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">managers</span></span></dt><dd class="dd-description">
List of remote entities that can manage users rosters using Remote Roster Management
(<a href="http://xmpp.org/extensions/xep-0321.html">XEP-0321</a>).
The protocol sections implemented are:
<span style="font-family:monospace">4.2. The remote entity requests current user’s roster</span>.
<span style="font-family:monospace">4.3. The user updates roster</span>.
<span style="font-family:monospace">4.4. The remote entity updates the user’s roster</span>.
A remote entity cab only get or modify roster items that have the same domain as the entity.
Default value is: <span style="font-family:monospace">[]</span>.
</dd></dl><p>This example configuration enables Roster Versioning with storage of current id.
The ICQ and MSN transports can get ICQ and MSN contacts, add them, or remove them for any local account:
</p><pre class="verbatim">modules:
...
mod_roster:
versioning: true
store_current_id: true
managers:
- "icq.example.org"
- "msn.example.org"
...
</pre><p>With this example configuration, only admins can manage their rosters;
everybody else cannot modify the roster:
</p><pre class="verbatim">acl:
admin:
user:
- "sarah": "example.org"
access:
roster:
admin: allow
modules:
...
mod_roster:
access: roster
...
</pre><p> <a id="modservicelog"></a> </p>
<!--TOC subsection id="sec82" <span style="font-family:monospace">mod_service_log</span>-->
<h3 id="sec82" class="subsection">3.3.22  <a href="#modservicelog"><span style="font-family:monospace">mod_service_log</span></a></h3><!--SEC END --><p> <a id="modservicelog"></a>
</p><p>This module adds support for logging end user packets via a XMPP message
auditing service such as
<a href="http://www.funkypenguin.info/project/bandersnatch/">Bandersnatch</a>. All user
packets are encapsulated in a <code><route/></code> element and sent to the specified
service(s).</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">loggers: [Names, ...]</span></span></dt><dd class="dd-description"> With this option a (list of) service(s)
that will receive the packets can be specified.
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
To log all end user packets to the Bandersnatch service running on
<span style="font-family:monospace">bandersnatch.example.com</span>:
<pre class="verbatim">modules:
...
mod_service_log:
loggers: ["bandersnatch.example.com"]
...
</pre></li><li class="li-itemize">To log all end user packets to the Bandersnatch service running on
<span style="font-family:monospace">bandersnatch.example.com</span> and the backup service on
<span style="font-family:monospace">bandersnatch.example.org</span>:
<pre class="verbatim">modules:
...
mod_service_log:
loggers:
- "bandersnatch.example.com"
- "bandersnatch.example.org"
...
</pre></li></ul><p> <a id="modsharedroster"></a> </p>
<!--TOC subsection id="sec83" <span style="font-family:monospace">mod_shared_roster</span>-->
<h3 id="sec83" class="subsection">3.3.23  <a href="#modsharedroster"><span style="font-family:monospace">mod_shared_roster</span></a></h3><!--SEC END --><p> <a id="modsharedroster"></a>
</p><p>This module enables you to create shared roster groups. This means that you can
create groups of people that can see members from (other) groups in their
rosters. The big advantages of this feature are that end users do not need to
manually add all users to their rosters, and that they cannot permanently delete
users from the shared roster groups.
A shared roster group can have members from any XMPP server,
but the presence will only be available from and to members
of the same virtual host where the group is created.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p>Shared roster groups can be edited <em>only</em> via the Web Admin. Each group
has a unique identification and the following parameters:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold">Name</span></dt><dd class="dd-description"> The name of the group, which will be displayed in the roster.
</dd><dt class="dt-description"><span style="font-weight:bold">Description</span></dt><dd class="dd-description"> The description of the group. This parameter does not affect
anything.
</dd><dt class="dt-description"><span style="font-weight:bold">Members</span></dt><dd class="dd-description"> A list of JIDs of group members, entered one per line in
the Web Admin.
The special member directive <span style="font-family:monospace">@all@</span>
represents all the registered users in the virtual host;
which is only recommended for a small server with just a few hundred users.
The special member directive <span style="font-family:monospace">@online@</span>
represents the online users in the virtual host.
</dd><dt class="dt-description"><span style="font-weight:bold">Displayed groups</span></dt><dd class="dd-description">
A list of groups that will be in the rosters of this group’s members.
A group of other vhost can be identified with <span style="font-family:monospace">groupid@vhost</span>
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
Take the case of a computer club that wants all its members seeing each
other in their rosters. To achieve this, they need to create a shared roster
group similar to next table:
<blockquote class="table"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<table border=1 style="border-spacing:0;" class="cellpadding1"><tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Identification</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Group ‘<span style="font-family:monospace">club_members</span>’</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Name</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Club Members</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Description</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Members from the computer club</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Members</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > <table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">member1@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">member2@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">member3@example.org</span>
</td></tr>
</table>
</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Displayed groups</td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-family:monospace">club_members</span></td></tr>
</table>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote>
</li><li class="li-itemize">In another case we have a company which has three divisions: Management,
Marketing and Sales. All group members should see all other members in their
rosters. Additionally, all managers should have all marketing and sales people
in their roster. Simultaneously, all marketeers and the whole sales team
should see all managers. This scenario can be achieved by creating shared
roster groups as shown in the following table:
<blockquote class="table"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<table border=1 style="border-spacing:0;" class="cellpadding1"><tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Identification</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > Group ‘<span style="font-family:monospace">management</span>’</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > Group ‘<span style="font-family:monospace">marketing</span>’</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > Group ‘<span style="font-family:monospace">sales</span>’</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Name</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Management</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Marketing</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Sales</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Description</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" > Members</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > <table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">manager1@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">manager2@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">manager3@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">manager4@example.org</span>
</td></tr>
</table>
</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > <table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">marketeer1@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">marketeer2@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">marketeer3@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">marketeer4@example.org</span>
</td></tr>
</table>
</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > <table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">saleswoman1@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">salesman1@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">saleswoman2@example.org</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">salesman2@example.org</span>
</td></tr>
</table>
</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >Displayed groups</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > <table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">management</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">marketing</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">sales</span>
</td></tr>
</table>
</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > <table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">management</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">marketing</span>
</td></tr>
</table>
</td><td style="text-align:left;border:solid 1px;white-space:nowrap" > <table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">management</span></td></tr>
<tr><td style="text-align:left;white-space:nowrap" > <span style="font-family:monospace">sales</span>
</td></tr>
</table>
</td></tr>
</table>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote>
</li></ul><p> <a id="modsharedrosterldap"></a> </p>
<!--TOC subsection id="sec84" <span style="font-family:monospace">mod_shared_roster_ldap</span>-->
<h3 id="sec84" class="subsection">3.3.24  <a href="#modsharedrosterldap"><span style="font-family:monospace">mod_shared_roster_ldap</span></a></h3><!--SEC END --><p> <a id="modsharedrosterldap"></a>
</p><p>This module lets the server administrator
automatically populate users’ rosters (contact lists) with entries based on
users and groups defined in an LDAP-based directory.</p><p> <a id="msrlconfigparams"></a> </p>
<!--TOC subsubsection id="sec85" Configuration parameters-->
<h4 id="sec85" class="subsubsection"><a href="#msrlconfigparams">Configuration parameters</a></h4><!--SEC END --><p> <a id="msrlconfigparams"></a> </p><p>The module accepts the following configuration parameters. Some of them, if
unspecified, default to the values specified for the top level of
configuration. This lets you avoid specifying, for example, the bind password,
in multiple places.</p><p> <a id="msrlfilters"></a> </p>
<!--TOC paragraph id="sec86" Filters-->
<h5 id="sec86" class="paragraph"><a href="#msrlfilters">Filters</a></h5><!--SEC END --><p> <a id="msrlfilters"></a> </p><p>These parameters specify LDAP filters used to query for shared roster information.
All of them are run against the <code>ldap_base</code>.</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_rfilter</span></span></dt><dd class="dd-description">
So called “Roster Filter”. Used to find names of all “shared roster” groups.
See also the <code>ldap_groupattr</code> parameter.
If unspecified, defaults to the top-level parameter of the same name.
You <em>must</em> specify it in some place in the configuration, there is no default.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_ufilter</span></span></dt><dd class="dd-description">
“User Filter” – used for retrieving the human-readable name of roster
entries (usually full names of people in the roster).
See also the parameters <code>ldap_userdesc</code> and <code>ldap_useruid</code>.
If unspecified, defaults to the top-level parameter of the same name.
If that one also is unspecified, then the filter is assembled from values of
other parameters as follows (<code>[ldap_SOMETHING]</code> is used to mean “the
value of the configuration parameter <span style="font-family:monospace">ldap_SOMETHING</span>”):<pre class="verbatim">(&(&([ldap_memberattr]=[ldap_memberattr_format])([ldap_groupattr]=%g))[ldap_filter])
</pre><p>Subsequently <span style="font-family:monospace">%u</span> and <span style="font-family:monospace">%g</span> are replaced with a <span style="font-family:monospace">*</span>. This means
that given the defaults, the filter sent to the LDAP server is would be
<code>(&(memberUid=*)(cn=*))</code>. If however the <span style="font-family:monospace">ldap_memberattr_format</span>
is something like <code>uid=%u,ou=People,o=org</code>, then the filter will be
<code>(&(memberUid=uid=*,ou=People,o=org)(cn=*))</code>.</p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_gfilter</span></span></dt><dd class="dd-description">
“Group Filter” – used when retrieving human-readable name (a.k.a.
“Display Name”) and the members of a group.
See also the parameters <code>ldap_groupattr</code>, <code>ldap_groupdesc</code> and <code>ldap_memberattr</code>.
If unspecified, defaults to the top-level parameter of the same name.
If that one also is unspecified, then the filter is constructed exactly in the
same way as <span style="font-family:monospace">User Filter</span>.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_filter</span></span></dt><dd class="dd-description">
Additional filter which is AND-ed together with <span style="font-family:monospace">User Filter</span> and <span style="font-family:monospace">Group Filter</span>.
If unspecified, defaults to the top-level parameter of the same name. If that
one is also unspecified, then no additional filter is merged with the other
filters.
</dd></dl><p>Note that you will probably need to manually define the <span style="font-family:monospace">User</span> and <span style="font-family:monospace">Group Filter</span>s (since the auto-assembled ones will not work) if:
</p><ul class="itemize"><li class="li-itemize">
your <span style="font-family:monospace">ldap_memberattr_format</span> is anything other than a simple <span style="font-family:monospace">%u</span>,
</li><li class="li-itemize"><span style="font-weight:bold">and</span> the attribute specified with <span style="font-family:monospace">ldap_memberattr</span> does not support substring matches.
</li></ul><p>
An example where it is the case is OpenLDAP and <span style="font-family:monospace">(unique)MemberName</span> attribute from the <span style="font-family:monospace">groupOf(Unique)Names</span> objectClass.
A symptom of this problem is that you will see messages such as the following in your <span style="font-family:monospace">slapd.log</span>:
</p><pre class="verbatim">get_filter: unknown filter type=130
filter="(&(?=undefined)(?=undefined)(something=else))"
</pre><p> <a id="msrlattrs"></a> </p>
<!--TOC subsubsection id="sec87" Attributes-->
<h4 id="sec87" class="subsubsection"><a href="#msrlattrs">Attributes</a></h4><!--SEC END --><p> <a id="msrlattrs"></a> </p><p>These parameters specify the names of the attributes which hold interesting data
in the entries returned by running filters specified in
section <a href="#msrlfilters">3.3.24</a>.</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ldap_groupattr</span></span></dt><dd class="dd-description">
The name of the attribute that holds the group name, and that is used to differentiate between them.
Retrieved from results of the “Roster Filter” and “Group Filter”.
Defaults to <span style="font-family:monospace">cn</span>.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_groupdesc</span></span></dt><dd class="dd-description">
The name of the attribute which holds the human-readable group name in the
objects you use to represent groups.
Retrieved from results of the “Group Filter”.
Defaults to whatever <span style="font-family:monospace">ldap_groupattr</span> is set.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_memberattr</span></span></dt><dd class="dd-description">
The name of the attribute which holds the IDs of the members of a group.
Retrieved from results of the “Group Filter”.
Defaults to <span style="font-family:monospace">memberUid</span>.<p>The name of the attribute differs depending on the <span style="font-family:monospace">objectClass</span> you use
for your group objects, for example:
</p><dl class="description"><dt class="dt-description">
</dt><dd class="dd-description"><span style="font-family:monospace">posixGroup</span> → <span style="font-family:monospace">memberUid</span>
</dd><dt class="dt-description"></dt><dd class="dd-description"><span style="font-family:monospace">groupOfNames</span> → <span style="font-family:monospace">member</span>
</dd><dt class="dt-description"></dt><dd class="dd-description"><span style="font-family:monospace">groupOfUniqueNames</span> → <span style="font-family:monospace">uniqueMember</span>
</dd></dl></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_userdesc</span></span></dt><dd class="dd-description">
The name of the attribute which holds the human-readable user name.
Retrieved from results of the “User Filter”.
Defaults to <span style="font-family:monospace">cn</span>.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_useruid</span></span></dt><dd class="dd-description">
The name of the attribute which holds the ID of a roster item. Value of this
attribute in the roster item objects needs to match the ID retrieved from the
<span style="font-family:monospace">ldap_memberattr</span> attribute of a group object.
Retrieved from results of the “User Filter”.
Defaults to <span style="font-family:monospace">cn</span>.
</dd></dl><p> <a id="msrlcontrolparams"></a> </p>
<!--TOC subsubsection id="sec88" Control parameters-->
<h4 id="sec88" class="subsubsection"><a href="#msrlcontrolparams">Control parameters</a></h4><!--SEC END --><p> <a id="msrlcontrolparams"></a> </p><p>These paramters control the behaviour of the module.</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_memberattr_format</span></span></dt><dd class="dd-description">
A globbing format for extracting user ID from the value of the attribute named by
<code>ldap_memberattr</code>.
Defaults to <span style="font-family:monospace">%u</span>, which means that the whole value is the member ID. If
you change it to something different, you may also need to specify the User
and Group Filters manually — see section <a href="#msrlfilters">3.3.24</a>.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_memberattr_format_re</span></span></dt><dd class="dd-description">
A regex for extracting user ID from the value of the attribute named by
<code>ldap_memberattr</code>.<p>An example value <span style="font-family:monospace">"CN=(</span>\\<span style="font-family:monospace">w*),(OU=.*,)*DC=company,DC=com"</span> works for user IDs such as the following:
</p><ul class="itemize"><li class="li-itemize">
<span style="font-family:monospace">CN=Romeo,OU=Montague,DC=company,DC=com</span>
</li><li class="li-itemize"><span style="font-family:monospace">CN=Abram,OU=Servants,OU=Montague,DC=company,DC=com</span>
</li><li class="li-itemize"><span style="font-family:monospace">CN=Juliet,OU=Capulet,DC=company,DC=com</span>
</li><li class="li-itemize"><span style="font-family:monospace">CN=Peter,OU=Servants,OU=Capulet,DC=company,DC=com</span>
</li></ul><p>In case:
</p><ul class="itemize"><li class="li-itemize">
the option is unset,
</li><li class="li-itemize">or the <span style="font-family:monospace">re</span> module in unavailable in the current Erlang environment,
</li><li class="li-itemize">or the regular expression does not compile,
</li></ul><p>
then instead of a regular expression, a simple format specified by <span style="font-family:monospace">ldap_memberattr_format</span> is used. Also, in the last two cases an error
message is logged during the module initialization.</p><p>Also, note that in all cases <span style="font-family:monospace">ldap_memberattr_format</span> (and <em>not</em> the
regex version) is used for constructing the default “User/Group Filter” —
see section <a href="#msrlfilters">3.3.24</a>.</p></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_auth_check</span></span></dt><dd class="dd-description">
Whether the module should check (via the ejabberd authentication subsystem)
for existence of each user in the shared LDAP roster. See
section <a href="#msrlconfigroster">3.3.24</a> form more information. Set to <span style="font-family:monospace">off</span> if you
want to disable the check.
Defaults to <span style="font-family:monospace">on</span>.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_user_cache_validity</span></span></dt><dd class="dd-description">
Number of seconds for which the cache for roster item full names is considered
fresh after retrieval. 300 by default. See section <a href="#msrlconfigroster">3.3.24</a> on
how it is used during roster retrieval.</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ldap_group_cache_validity</span></span></dt><dd class="dd-description">
Number of seconds for which the cache for group membership is considered
fresh after retrieval. 300 by default. See section <a href="#msrlconfigroster">3.3.24</a> on
how it is used during roster retrieval.
</dd></dl><p> <a id="msrlconnparams"></a> </p>
<!--TOC subsubsection id="sec89" Connection parameters-->
<h4 id="sec89" class="subsubsection"><a href="#msrlconnparams">Connection parameters</a></h4><!--SEC END --><p> <a id="msrlconnparams"></a> </p><p>The module also accepts the connection parameters, all of which default to the
top-level parameter of the same name, if unspecified. See <a href="#ldapconnection">3.2.2</a>
for more information about them.</p><p> <a id="msrlconfigroster"></a> </p>
<!--TOC subsubsection id="sec90" Retrieving the roster-->
<h4 id="sec90" class="subsubsection"><a href="#msrlconfigroster">Retrieving the roster</a></h4><!--SEC END --><p> <a id="msrlconfigroster"></a> </p><p>When the module is called to retrieve the shared roster for a user, the
following algorithm is used:</p><ol class="enumerate" type=1><li class="li-enumerate">
<a id="step:rfilter"></a> A list of names of groups to display is created: the <span style="font-family:monospace">Roster Filter</span>
is run against the base DN, retrieving the values of the attribute named by
<span style="font-family:monospace">ldap_groupattr</span>.</li><li class="li-enumerate">Unless the group cache is fresh (see the <span style="font-family:monospace">ldap_group_cache_validity</span> option), it is refreshed:<ol class="enumerate" type=a><li class="li-enumerate">
Information for all groups is retrieved using a single query: the <span style="font-family:monospace">Group Filter</span> is run against the Base DN, retrieving the values of attributes
named by <span style="font-family:monospace">ldap_groupattr</span> (group ID), <span style="font-family:monospace">ldap_groupdesc</span> (group
“Display Name”) and <span style="font-family:monospace">ldap_memberattr</span> (IDs of group members).</li><li class="li-enumerate">group “Display Name”, read from the attribute named by <span style="font-family:monospace">ldap_groupdesc</span>, is stored in the cache for the given group</li><li class="li-enumerate">the following processing takes place for each retrieved value of
attribute named by <span style="font-family:monospace">ldap_memberattr</span>:
<ol class="enumerate" type=i><li class="li-enumerate">
the user ID part of it is extracted using <span style="font-family:monospace">ldap_memberattr_format(_re)</span>,</li><li class="li-enumerate">then (unless <span style="font-family:monospace">ldap_auth_check</span> is set to <span style="font-family:monospace">off</span>) for each
found user ID, the module checks (using the <span style="font-family:monospace">ejabberd</span> authentication
subsystem) whether such user exists in the given virtual host. It is
skipped if the check is enabled and fails.<p>This step is here for historical reasons. If you have a tidy DIT and
properly defined “Roster Filter” and “Group Filter”, it is safe to
disable it by setting <span style="font-family:monospace">ldap_auth_check</span> to <span style="font-family:monospace">off</span> — it will
speed up the roster retrieval.</p></li><li class="li-enumerate">the user ID is stored in the list of members in the cache for the
given group
</li></ol>
</li></ol></li><li class="li-enumerate">For each item (group name) in the list of groups retrieved in step <a href="#step%3Arfilter">1</a>:<ol class="enumerate" type=a><li class="li-enumerate">
the display name of a shared roster group is retrieved from the group
cache</li><li class="li-enumerate">for each IDs of users which belong to the group, retrieved from the
group cache:<ol class="enumerate" type=i><li class="li-enumerate">
the ID is skipped if it’s the same as the one for which we are
retrieving the roster. This is so that the user does not have himself in
the roster.</li><li class="li-enumerate">the display name of a shared roster user is retrieved:
<ol class="enumerate" type=A><li class="li-enumerate">
first, unless the user name cache is fresh (see the <span style="font-family:monospace">ldap_user_cache_validity</span> option), it is refreshed by running the
<span style="font-family:monospace">User Filter</span>, against the Base DN, retrieving the values of
attributes named by <span style="font-family:monospace">ldap_useruid</span> and <span style="font-family:monospace">ldap_userdesc</span>.
</li><li class="li-enumerate">then, the display name for the given user ID is retrieved from the
user name cache.
</li></ol>
</li></ol></li></ol></li></ol><p> <a id="msrlconfigexample"></a> </p>
<!--TOC subsubsection id="sec91" Configuration examples-->
<h4 id="sec91" class="subsubsection"><a href="#msrlconfigexample">Configuration examples</a></h4><!--SEC END --><p> <a id="msrlconfigexample"></a> </p><p>Since there are many possible
<a href="http://en.wikipedia.org/wiki/Directory_Information_Tree">DIT</a>
layouts, it will probably be easiest to understand how to configure the module
by looking at an example for a given DIT (or one resembling it).</p><p> <a id="msrlconfigexampleflat"></a> </p>
<!--TOC paragraph id="sec92" Flat DIT-->
<h5 id="sec92" class="paragraph"><a href="#msrlconfigexampleflat">Flat DIT</a></h5><!--SEC END --><p> <a id="msrlconfigexampleflat"></a> </p><p>This seems to be the kind of DIT for which this module was initially designed.
Basically there are just user objects, and group membership is stored in an
attribute individually for each user. For example in a layout shown in
figure <a href="#fig%3Amsrl-dit-flat">3.1</a>, the group of each user is stored in its <span style="font-family:monospace">ou</span> attribute.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="msrl-dit-flat.png" alt="msrl-dit-flat.png">
<div class="caption"><table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="vertical-align:top;text-align:left;" >Figure 3.1: Flat DIT graph</td></tr>
</table></div>
<a id="fig:msrl-dit-flat"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p>Such layout has a few downsides, including:
</p><ul class="itemize"><li class="li-itemize">
information duplication – the group name is repeated in every member object
</li><li class="li-itemize">difficult group management – information about group members is not
centralized, but distributed between member objects
</li><li class="li-itemize">inefficiency – the list of unique group names has to be computed by iterating over all users
</li></ul><p>This however seems to be a common DIT layout, so the module keeps supporting it.
You can use the following configuration…</p><pre class="verbatim">modules:
...
mod_shared_roster_ldap:
ldap_base: "ou=flat,dc=nodomain"
ldap_rfilter: "(objectClass=inetOrgPerson)"
ldap_groupattr: "ou"
ldap_memberattr: "cn"
ldap_filter: "(objectClass=inetOrgPerson)"
ldap_userdesc: "displayName"
...
</pre><p>…to be provided with a roster as shown in figure <a href="#fig%3Amsrl-roster-flat">3.2</a> upon connecting as user <span style="font-family:monospace">czesio</span>.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="msrl-roster-flat.png" alt="msrl-roster-flat.png">
<div class="caption"><table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="vertical-align:top;text-align:left;" >Figure 3.2: Roster from flat DIT</td></tr>
</table></div>
<a id="fig:msrl-roster-flat"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p> <a id="msrlconfigexampledeep"></a> </p>
<!--TOC paragraph id="sec93" Deep DIT-->
<h5 id="sec93" class="paragraph"><a href="#msrlconfigexampledeep">Deep DIT</a></h5><!--SEC END --><p> <a id="msrlconfigexampledeep"></a> </p><p>This type of DIT contains distinctly typed objects for users and groups – see figure <a href="#fig%3Amsrl-dit-deep">3.3</a>.
They are shown separated into different subtrees, but it’s not a requirement.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="msrl-dit-deep.png" alt="msrl-dit-deep.png">
<div class="caption"><table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="vertical-align:top;text-align:left;" >Figure 3.3: Example “deep” DIT graph</td></tr>
</table></div>
<a id="fig:msrl-dit-deep"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p>If you use the following example module configuration with it:
</p><pre class="verbatim">modules:
...
mod_shared_roster_ldap:
ldap_base: "ou=deep,dc=nodomain"
ldap_rfilter: "(objectClass=groupOfUniqueNames)"
ldap_filter: ""
ldap_gfilter: "(&(objectClass=groupOfUniqueNames)(cn=%g))"
ldap_groupdesc: "description"
ldap_memberattr: "uniqueMember"
ldap_memberattr_format: "cn=%u,ou=people,ou=deep,dc=nodomain"
ldap_ufilter: "(&(objectClass=inetOrgPerson)(cn=%u))"
ldap_userdesc: "displayName"
...
</pre><p>…and connect as user <span style="font-family:monospace">czesio</span>, then <span style="font-family:monospace">ejabberd</span> will provide you with
the roster shown in figure <a href="#fig%3Amsrl-roster-deep">3.4</a>.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="msrl-roster-deep.png" alt="msrl-roster-deep.png">
<div class="caption"><table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="vertical-align:top;text-align:left;" >Figure 3.4: Example roster from “deep” DIT</td></tr>
</table></div>
<a id="fig:msrl-roster-deep"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p> <a id="modsic"></a> </p>
<!--TOC subsection id="sec94" <span style="font-family:monospace">mod_sic</span>-->
<h3 id="sec94" class="subsection">3.3.25  <a href="#modsic"><span style="font-family:monospace">mod_sic</span></a></h3><!--SEC END --><p> <a id="modsic"></a>
</p><p>This module adds support for Server IP Check (<a href="http://xmpp.org/extensions/xep-0279.html">XEP-0279</a>). This protocol
enables a client to discover its external IP address.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for <span style="font-family:monospace">urn:xmpp:sic:0</span> IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p> <a id="modsip"></a> </p>
<!--TOC subsection id="sec95" <span style="font-family:monospace">mod_sip</span>-->
<h3 id="sec95" class="subsection">3.3.26  <a href="#modsip"><span style="font-family:monospace">mod_sip</span></a></h3><!--SEC END --><p> <a id="modsip"></a>
This module adds SIP proxy/registrar support for the corresponding virtual host.
Note that it is not enough to just load this module only. You should also configure
listeners and DNS records properly. See section <a href="#sip">3.1.11</a> for the full explanation.</p><p>Example configuration:
</p><pre class="verbatim">modules:
...
mod_sip: {}
...
</pre><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">via: [{type: Type, host: Host, port: Port}]</span></span></dt><dd class="dd-description">With
this option for every <span style="font-family:monospace">Type</span> you can specify <span style="font-family:monospace">Host</span> and <span style="font-family:monospace">Port</span>
to set in <span style="font-family:monospace">Via</span> header of outgoing SIP messages, where <span style="font-family:monospace">Type</span> can be
<span style="font-family:monospace">udp</span>, <span style="font-family:monospace">tcp</span> or <span style="font-family:monospace">tls</span>. <span style="font-family:monospace">Host</span> is a string and <span style="font-family:monospace">Port</span> is
a non negative integer. This is useful if you’re running your server in a non-standard
network topology. Example configuration:
<pre class="verbatim">modules:
...
mod_sip:
via:
-
type: tls
host: "sip-tls.example.com"
port: 5061
-
type: tcp
host: "sip-tcp.example.com"
port: 5060
-
type: udp
host: "sip-udp.example.com"
port: 5060
...
</pre></dd></dl><p> <a id="modstats"></a> </p>
<!--TOC subsection id="sec96" <span style="font-family:monospace">mod_stats</span>-->
<h3 id="sec96" class="subsection">3.3.27  <a href="#modstats"><span style="font-family:monospace">mod_stats</span></a></h3><!--SEC END --><p> <a id="modstats"></a>
</p><p>This module adds support for Statistics Gathering (<a href="http://xmpp.org/extensions/xep-0039.html">XEP-0039</a>). This protocol
allows you to retrieve next statistics from your <span style="font-family:monospace">ejabberd</span> deployment:
</p><ul class="itemize"><li class="li-itemize">
Total number of registered users on the current virtual host (users/total).
</li><li class="li-itemize">Total number of registered users on all virtual hosts (users/all-hosts/total).
</li><li class="li-itemize">Total number of online users on the current virtual host (users/online).
</li><li class="li-itemize">Total number of online users on all virtual hosts (users/all-hosts/online).
</li></ul><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Statistics Gathering (<span style="font-family:monospace">http://jabber.org/protocol/stats</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p>As there are only a small amount of clients (for example
<a href="http://tkabber.jabber.ru/">Tkabber</a>) and software libraries with
support for this XEP, a few examples are given of the XML you need to send
in order to get the statistics. Here they are:
</p><ul class="itemize"><li class="li-itemize">
You can request the number of online users on the current virtual host
(<span style="font-family:monospace">example.org</span>) by sending:
<pre class="verbatim"><iq to='example.org' type='get'>
<query xmlns='http://jabber.org/protocol/stats'>
<stat name='users/online'/>
</query>
</iq>
</pre></li><li class="li-itemize">You can request the total number of registered users on all virtual hosts
by sending:
<pre class="verbatim"><iq to='example.org' type='get'>
<query xmlns='http://jabber.org/protocol/stats'>
<stat name='users/all-hosts/total'/>
</query>
</iq>
</pre></li></ul><p> <a id="modtime"></a> </p>
<!--TOC subsection id="sec97" <span style="font-family:monospace">mod_time</span>-->
<h3 id="sec97" class="subsection">3.3.28  <a href="#modtime"><span style="font-family:monospace">mod_time</span></a></h3><!--SEC END --><p> <a id="modtime"></a>
</p><p>This module features support for Entity Time (<a href="http://xmpp.org/extensions/xep-0202.html">XEP-0202</a>). By using this XEP,
you are able to discover the time at another entity’s location.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Entity Time (<span style="font-family:monospace">jabber:iq:time</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p> <a id="modvcard"></a> </p>
<!--TOC subsection id="sec98" <span style="font-family:monospace">mod_vcard</span>-->
<h3 id="sec98" class="subsection">3.3.29  <a href="#modvcard"><span style="font-family:monospace">mod_vcard</span></a></h3><!--SEC END --><p> <a id="modvcard"></a>
</p><p>This module allows end users to store and retrieve their vCard, and to retrieve
other users vCards, as defined in vcard-temp (<a href="http://xmpp.org/extensions/xep-0054.html">XEP-0054</a>). The module also
implements an uncomplicated Jabber User Directory based on the vCards of
these users. Moreover, it enables the server to send its vCard when queried.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt><dd class="dd-description"> This option defines the Jabber ID of the
service. If the <span style="font-family:monospace">host</span> option is not specified, the Jabber ID will be the
hostname of the virtual host with the prefix ‘<span style="font-family:monospace">vjud.</span>’. The keyword "@HOST@"
is replaced at start time with the real virtual host name.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for <span style="font-family:monospace">vcard-temp</span> IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">search: true|false</span></span></dt><dd class="dd-description">This option specifies whether the search
functionality is enabled or not
If disabled, the option <span style="font-family:monospace">host</span> will be ignored and the
Jabber User Directory service will not appear in the Service Discovery item
list. The default value is <span style="font-family:monospace">true</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">matches: infinity|Number</span></span></dt><dd class="dd-description">With this option, the number of reported
search results can be limited. If the option’s value is set to <span style="font-family:monospace">infinity</span>,
all search results are reported. The default value is <span style="font-family:monospace">30</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">allow_return_all: false|true</span></span></dt><dd class="dd-description">This option enables
you to specify if search operations with empty input fields should return all
users who added some information to their vCard. The default value is
<span style="font-family:monospace">false</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">search_all_hosts, true|false</span></span></dt><dd class="dd-description">If this option is set
to <span style="font-family:monospace">true</span>, search operations will apply to all virtual hosts. Otherwise
only the current host will be searched. The default value is <span style="font-family:monospace">true</span>.
This option is available in <span style="font-family:monospace">mod_vcard</span>when using Mnesia, but not when using ODBC storage.
</dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
In this first situation, search results are limited to twenty items,
every user who added information to their vCard will be listed when people
do an empty search, and only users from the current host will be returned:
<pre class="verbatim">modules:
...
mod_vcard:
search: true
matches: 20
allow_return_all: true
search_all_hosts: false
...
</pre></li><li class="li-itemize">The second situation differs in a way that search results are not limited,
and that all virtual hosts will be searched instead of only the current one:
<pre class="verbatim">modules:
...
mod_vcard:
search: true
matches: infinity
allow_return_all: true
...
</pre></li></ul><p> <a id="modvcardldap"></a> </p>
<!--TOC subsection id="sec99" <span style="font-family:monospace">mod_vcard_ldap</span>-->
<h3 id="sec99" class="subsection">3.3.30  <a href="#modvcardldap"><span style="font-family:monospace">mod_vcard_ldap</span></a></h3><!--SEC END --><p> <a id="modvcardldap"></a>
</p><p><span style="font-family:monospace">ejabberd</span> can map LDAP attributes to vCard fields. This behaviour is
implemented in the <span style="font-family:monospace">mod_vcard_ldap</span> module. This module does not depend on the
authentication method (see <a href="#ldapauth">3.2.2</a>).</p><p>Usually <span style="font-family:monospace">ejabberd</span> treats LDAP as a read-only storage:
it is possible to consult data, but not possible to
create accounts or edit vCard that is stored in LDAP.
However, it is possible to change passwords if <span style="font-family:monospace">mod_register</span> module is enabled
and LDAP server supports
<a href="http://tools.ietf.org/html/rfc3062">RFC 3062</a>.</p><p>The <span style="font-family:monospace">mod_vcard_ldap</span> module has
its own optional parameters. The first group of parameters has the same
meaning as the top-level LDAP parameters to set the authentication method:
<span style="font-family:monospace">ldap_servers</span>, <span style="font-family:monospace">ldap_port</span>, <span style="font-family:monospace">ldap_rootdn</span>,
<span style="font-family:monospace">ldap_password</span>, <span style="font-family:monospace">ldap_base</span>, <span style="font-family:monospace">ldap_uids</span>,
<span style="font-family:monospace">ldap_deref_aliases</span> and <span style="font-family:monospace">ldap_filter</span>.
See section <a href="#ldapauth">3.2.2</a> for detailed information
about these options. If one of these options is not set, <span style="font-family:monospace">ejabberd</span> will look
for the top-level option with the same name.</p><p>The second group of parameters
consists of the following <span style="font-family:monospace">mod_vcard_ldap</span>-specific options:</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">host: HostName</span></span></dt><dd class="dd-description"> This option defines the Jabber ID of the
service. If the <span style="font-family:monospace">host</span> option is not specified, the Jabber ID will be the
hostname of the virtual host with the prefix ‘<span style="font-family:monospace">vjud.</span>’. The keyword "@HOST@"
is replaced at start time with the real virtual host name.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for <span style="font-family:monospace">vcard-temp</span> IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{search, true|false}</span></span></dt><dd class="dd-description">This option specifies whether the search
functionality is enabled (value: <span style="font-family:monospace">true</span>) or disabled (value:
<span style="font-family:monospace">false</span>). If disabled, the option <span style="font-family:monospace">host</span> will be ignored and the
Jabber User Directory service will not appear in the Service Discovery item
list. The default value is <span style="font-family:monospace">true</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{matches, infinity|Number}</span></span></dt><dd class="dd-description">With this option, the number of reported
search results can be limited. If the option’s value is set to <span style="font-family:monospace">infinity</span>,
all search results are reported. The default value is <span style="font-family:monospace">30</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{ldap_vcard_map, [ {Name, Pattern, LDAPattributes}, ...]}</span></span></dt><dd class="dd-description">
With this option you can set the table that maps LDAP attributes to vCard fields.
<span style="font-family:monospace">Name</span> is the type name of the vCard as defined in
<a href="http://tools.ietf.org/html/rfc2426">RFC 2426</a>.
<span style="font-family:monospace">Pattern</span> is a string which contains pattern variables
<span style="font-family:monospace">"%u"</span>, <span style="font-family:monospace">"%d"</span> or <span style="font-family:monospace">"%s"</span>.
<span style="font-family:monospace">LDAPattributes</span> is the list containing LDAP attributes.
The pattern variables
<span style="font-family:monospace">"%s"</span> will be sequentially replaced
with the values of LDAP attributes from <span style="font-family:monospace">List_of_LDAP_attributes</span>,
<span style="font-family:monospace">"%u"</span> will be replaced with the user part of a JID,
and <span style="font-family:monospace">"%d"</span> will be replaced with the domain part of a JID.
The default is:
<pre class="verbatim">[{"NICKNAME", "%u", []},
{"FN", "%s", ["displayName"]},
{"LAST", "%s", ["sn"]},
{"FIRST", "%s", ["givenName"]},
{"MIDDLE", "%s", ["initials"]},
{"ORGNAME", "%s", ["o"]},
{"ORGUNIT", "%s", ["ou"]},
{"CTRY", "%s", ["c"]},
{"LOCALITY", "%s", ["l"]},
{"STREET", "%s", ["street"]},
{"REGION", "%s", ["st"]},
{"PCODE", "%s", ["postalCode"]},
{"TITLE", "%s", ["title"]},
{"URL", "%s", ["labeleduri"]},
{"DESC", "%s", ["description"]},
{"TEL", "%s", ["telephoneNumber"]},
{"EMAIL", "%s", ["mail"]},
{"BDAY", "%s", ["birthDay"]},
{"ROLE", "%s", ["employeeType"]},
{"PHOTO", "%s", ["jpegPhoto"]}]
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{ldap_search_fields, [ {Name, Attribute}, ...]}</span></span></dt><dd class="dd-description">This option
defines the search form and the LDAP attributes to search within.
<span style="font-family:monospace">Name</span> is the name of a search form
field which will be automatically translated by using the translation
files (see <span style="font-family:monospace">msgs/*.msg</span> for available words). <span style="font-family:monospace">Attribute</span> is the
LDAP attribute or the pattern <span style="font-family:monospace">"%u"</span>. The default is:
<pre class="verbatim">[{"User", "%u"},
{"Full Name", "displayName"},
{"Given Name", "givenName"},
{"Middle Name", "initials"},
{"Family Name", "sn"},
{"Nickname", "%u"},
{"Birthday", "birthDay"},
{"Country", "c"},
{"City", "l"},
{"Email", "mail"},
{"Organization Name", "o"},
{"Organization Unit", "ou"}]
</pre></dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">{ldap_search_reported, [ {SearchField, VcardField}, ...]}</span></span></dt><dd class="dd-description">This option
defines which search fields should be reported.
<span style="font-family:monospace">SearchField</span> is the name of a search form
field which will be automatically translated by using the translation
files (see <span style="font-family:monospace">msgs/*.msg</span> for available words). <span style="font-family:monospace">VcardField</span> is the
vCard field name defined in the <span style="font-family:monospace">ldap_vcard_map</span> option. The default
is:
<pre class="verbatim">[{"Full Name", "FN"},
{"Given Name", "FIRST"},
{"Middle Name", "MIDDLE"},
{"Family Name", "LAST"},
{"Nickname", "NICKNAME"},
{"Birthday", "BDAY"},
{"Country", "CTRY"},
{"City", "LOCALITY"},
{"Email", "EMAIL"},
{"Organization Name", "ORGNAME"},
{"Organization Unit", "ORGUNIT"}]
</pre></dd></dl><p>Examples:
</p><ul class="itemize"><li class="li-itemize">
<p>Let’s say <span style="font-family:monospace">ldap.example.org</span> is the name of our LDAP server. We have
users with their passwords in <span style="font-family:monospace">"ou=Users,dc=example,dc=org"</span> directory.
Also we have addressbook, which contains users emails and their additional
infos in <span style="font-family:monospace">"ou=AddressBook,dc=example,dc=org"</span> directory. Corresponding
authentication section should looks like this:</p><pre class="verbatim">%% authentication method
{auth_method, ldap}.
%% DNS name of our LDAP server
{ldap_servers, ["ldap.example.org"]}.
%% We want to authorize users from 'shadowAccount' object class only
{ldap_filter, "(objectClass=shadowAccount)"}.
</pre><p>Now we want to use users LDAP-info as their vCards. We have four attributes
defined in our LDAP schema: <span style="font-family:monospace">"mail"</span> — email address, <span style="font-family:monospace">"givenName"</span>
— first name, <span style="font-family:monospace">"sn"</span> — second name, <span style="font-family:monospace">"birthDay"</span> — birthday.
Also we want users to search each other. Let’s see how we can set it up:</p><pre class="verbatim">{modules,
...
{mod_vcard_ldap,
[
%% We use the same server and port, but want to bind anonymously because
%% our LDAP server accepts anonymous requests to
%% "ou=AddressBook,dc=example,dc=org" subtree.
{ldap_rootdn, ""},
{ldap_password, ""},
%% define the addressbook's base
{ldap_base, "ou=AddressBook,dc=example,dc=org"},
%% uidattr: user's part of JID is located in the "mail" attribute
%% uidattr_format: common format for our emails
{ldap_uids, [{"mail","%u@mail.example.org"}]},
%% We have to define empty filter here, because entries in addressbook does not
%% belong to shadowAccount object class
{ldap_filter, ""},
%% Now we want to define vCard pattern
{ldap_vcard_map,
[{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname
{"FIRST", "%s", ["givenName"]},
{"LAST", "%s", ["sn"]},
{"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John"
{"EMAIL", "%s", ["mail"]},
{"BDAY", "%s", ["birthDay"]}]},
%% Search form
{ldap_search_fields,
[{"User", "%u"},
{"Name", "givenName"},
{"Family Name", "sn"},
{"Email", "mail"},
{"Birthday", "birthDay"}]},
%% vCard fields to be reported
%% Note that JID is always returned with search results
{ldap_search_reported,
[{"Full Name", "FN"},
{"Nickname", "NICKNAME"},
{"Birthday", "BDAY"}]}
]}
...
}.
</pre><p>Note that <span style="font-family:monospace">mod_vcard_ldap</span> module checks an existence of the user before
searching his info in LDAP.</p></li><li class="li-itemize"><span style="font-family:monospace">ldap_vcard_map</span> example:
<pre class="verbatim">{ldap_vcard_map,
[{"NICKNAME", "%u", []},
{"FN", "%s", ["displayName"]},
{"CTRY", "Russia", []},
{"EMAIL", "%u@%d", []},
{"DESC", "%s\n%s", ["title", "description"]}
]},
</pre></li><li class="li-itemize"><span style="font-family:monospace">ldap_search_fields</span> example:
<pre class="verbatim">{ldap_search_fields,
[{"User", "uid"},
{"Full Name", "displayName"},
{"Email", "mail"}
]},
</pre></li><li class="li-itemize"><span style="font-family:monospace">ldap_search_reported</span> example:
<pre class="verbatim">{ldap_search_reported,
[{"Full Name", "FN"},
{"Email", "EMAIL"},
{"Birthday", "BDAY"},
{"Nickname", "NICKNAME"}
]},
</pre></li></ul><p> <a id="modvcardxupdate"></a> </p>
<!--TOC subsection id="sec100" <span style="font-family:monospace">mod_vcard_xupdate</span>-->
<h3 id="sec100" class="subsection">3.3.31  <a href="#modvcardxupdate"><span style="font-family:monospace">mod_vcard_xupdate</span></a></h3><!--SEC END --><p> <a id="modvcardxupdate"></a>
</p><p>The user’s client can store an avatar in the user vCard.
The vCard-Based Avatars protocol (<a href="http://xmpp.org/extensions/xep-0153.html">XEP-0153</a>)
provides a method for clients to inform the contacts what is the avatar hash value.
However, simple or small clients may not implement that protocol.</p><p>If this module is enabled, all the outgoing client presence stanzas get automatically
the avatar hash on behalf of the client.
So, the contacts receive the presence stanzas with the Update Data described
in <a href="http://xmpp.org/extensions/xep-0153.html">XEP-0153</a> as if the client would had inserted it itself.
If the client had already included such element in the presence stanza,
it is replaced with the element generated by ejabberd.</p><p>By enabling this module, each vCard modification produces a hash recalculation,
and each presence sent by a client produces hash retrieval and a
presence stanza rewrite.
For this reason, enabling this module will introduce a computational overhead
in servers with clients that change frequently their presence.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">db_type: internal|odbc</span></span></dt><dd class="dd-description">
Define the type of storage where the module will create the tables and store user information.
The default is to store in the internal Mnesia database.
If <span style="font-family:monospace">odbc</span> value is defined, make sure you have defined the database, see <a href="#database">3.2</a>.
</dd></dl><p> <a id="modversion"></a> </p>
<!--TOC subsection id="sec101" <span style="font-family:monospace">mod_version</span>-->
<h3 id="sec101" class="subsection">3.3.32  <a href="#modversion"><span style="font-family:monospace">mod_version</span></a></h3><!--SEC END --><p> <a id="modversion"></a>
</p><p>This module implements Software Version (<a href="http://xmpp.org/extensions/xep-0092.html">XEP-0092</a>). Consequently, it
answers <span style="font-family:monospace">ejabberd</span>’s version when queried.</p><p>Options:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">show_os: true|false</span></span></dt><dd class="dd-description">Should the operating system be revealed or not.
The default value is <span style="font-family:monospace">true</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">iqdisc: Discipline</span></span></dt><dd class="dd-description"> This specifies
the processing discipline for Software Version (<span style="font-family:monospace">jabber:iq:version</span>) IQ queries (see section <a href="#modiqdiscoption">3.3.2</a>).
</dd></dl><p> <a id="manage"></a> </p>
<!--TOC chapter id="sec102" Managing an <span style="font-family:monospace">ejabberd</span> Server-->
<h1 id="sec102" class="chapter">Chapter 4  <a href="#manage">Managing an <span style="font-family:monospace">ejabberd</span> Server</a></h1><!--SEC END --><p> <a id="manage"></a> </p><p> <a id="ejabberdctl"></a> </p>
<!--TOC section id="sec103" <span style="font-family:monospace">ejabberdctl</span>-->
<h2 id="sec103" class="section">4.1  <a href="#ejabberdctl"><span style="font-family:monospace">ejabberdctl</span></a></h2><!--SEC END --><p> <a id="ejabberdctl"></a> </p><p>With the <span style="font-family:monospace">ejabberdctl</span> command line administration script
you can execute <span style="font-family:monospace">ejabberdctl commands</span> (described in the next section, <a href="#ectl-commands">4.1.1</a>)
and also many general <span style="font-family:monospace">ejabberd commands</span> (described in section <a href="#eja-commands">4.2</a>).
This means you can start, stop and perform many other administrative tasks
in a local or remote <span style="font-family:monospace">ejabberd</span> server (by providing the argument <span style="font-family:monospace">--node NODENAME</span>).</p><p>The <span style="font-family:monospace">ejabberdctl</span> script can be configured in the file <span style="font-family:monospace">ejabberdctl.cfg</span>.
This file includes detailed information about each configurable option. See section <a href="#erlangconfiguration">4.1.2</a>.</p><p>The <span style="font-family:monospace">ejabberdctl</span> script returns a numerical status code.
Success is represented by <span style="font-family:monospace">0</span>,
error is represented by <span style="font-family:monospace">1</span>,
and other codes may be used for specific results.
This can be used by other scripts to determine automatically
if a command succeeded or failed,
for example using: <span style="font-family:monospace">echo $?</span></p><p>If you use Bash, you can get Bash completion by copying the file <span style="font-family:monospace">tools/ejabberdctl.bc</span>
to the directory <span style="font-family:monospace">/etc/bash_completion.d/</span> (in Debian, Ubuntu, Fedora and maybe others).</p><p> <a id="ectl-commands"></a> </p>
<!--TOC subsection id="sec104" ejabberdctl Commands-->
<h3 id="sec104" class="subsection">4.1.1  <a href="#ectl-commands">ejabberdctl Commands</a></h3><!--SEC END --><p> <a id="ectl-commands"></a> </p><p>When <span style="font-family:monospace">ejabberdctl</span> is executed without any parameter,
it displays the available options. If there isn’t an <span style="font-family:monospace">ejabberd</span> server running,
the available parameters are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">start</span></span></dt><dd class="dd-description"> Start <span style="font-family:monospace">ejabberd</span> in background mode. This is the default method.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">debug</span></span></dt><dd class="dd-description"> Attach an Erlang shell to an already existing <span style="font-family:monospace">ejabberd</span> server. This allows to execute commands interactively in the <span style="font-family:monospace">ejabberd</span> server.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">live</span></span></dt><dd class="dd-description"> Start <span style="font-family:monospace">ejabberd</span> in live mode: the shell keeps attached to the started server, showing log messages and allowing to execute interactive commands.
</dd></dl><p>If there is an <span style="font-family:monospace">ejabberd</span> server running in the system,
<span style="font-family:monospace">ejabberdctl</span> shows the <span style="font-family:monospace">ejabberdctl commands</span> described bellow
and all the <span style="font-family:monospace">ejabberd commands</span> available in that server (see <a href="#list-eja-commands">4.2.1</a>).</p><p>The <span style="font-family:monospace">ejabberdctl commands</span> are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">help</span></span></dt><dd class="dd-description"> Get help about ejabberdctl or any available command. Try <span style="font-family:monospace">ejabberdctl help help</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">status</span></span></dt><dd class="dd-description"> Check the status of the <span style="font-family:monospace">ejabberd</span> server.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">stop</span></span></dt><dd class="dd-description"> Stop the <span style="font-family:monospace">ejabberd</span> server.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">restart</span></span></dt><dd class="dd-description"> Restart the <span style="font-family:monospace">ejabberd</span> server.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">mnesia</span></span></dt><dd class="dd-description"> Get information about the Mnesia database.
</dd></dl><p>The <span style="font-family:monospace">ejabberdctl</span> script can be restricted to require authentication
and execute some <span style="font-family:monospace">ejabberd commands</span>; see <a href="#accesscommands">4.2.2</a>.
Add the option to the file <span style="font-family:monospace">ejabberd.yml</span>.
In this example there is no restriction:
</p><pre class="verbatim">ejabberdctl_access_commands: []
</pre><p>If account <span style="font-family:monospace">robot1@example.org</span> is registered in <span style="font-family:monospace">ejabberd</span> with password <span style="font-family:monospace">abcdef</span>
(which MD5 is E8B501798950FC58AAD83C8C14978E),
and <span style="font-family:monospace">ejabberd.yml</span> contains this setting:
</p><pre class="verbatim">{hosts, ["example.org"]}.
{acl, bots, {user, "robot1", "example.org"}}.
{access, ctlaccess, [{allow, bots}]}.
{ejabberdctl_access_commands, [ {ctlaccess, [registered_users, register], []} ]}.
</pre><p>then you can do this in the shell:
</p><pre class="verbatim">$ ejabberdctl registered_users example.org
Error: no_auth_provided
$ ejabberdctl --auth robot1 example.org abcdef registered_users example.org
robot1
testuser1
testuser2
</pre><p> <a id="erlangconfiguration"></a> </p>
<!--TOC subsection id="sec105" Erlang Runtime System-->
<h3 id="sec105" class="subsection">4.1.2  <a href="#erlangconfiguration">Erlang Runtime System</a></h3><!--SEC END --><p> <a id="erlangconfiguration"></a> </p><p><span style="font-family:monospace">ejabberd</span> is an Erlang/OTP application that runs inside an Erlang runtime system.
This system is configured using environment variables and command line parameters.
The <span style="font-family:monospace">ejabberdctl</span> administration script uses many of those possibilities.
You can configure some of them with the file <span style="font-family:monospace">ejabberdctl.cfg</span>,
which includes detailed description about them.
This section describes for reference purposes
all the environment variables and command line parameters.</p><p>The environment variables:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">EJABBERD_CONFIG_PATH</span></span></dt><dd class="dd-description">
Path to the ejabberd configuration file.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">EJABBERD_MSGS_PATH</span></span></dt><dd class="dd-description">
Path to the directory with translated strings.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">EJABBERD_LOG_PATH</span></span></dt><dd class="dd-description">
Path to the ejabberd service log file.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">EJABBERD_SO_PATH</span></span></dt><dd class="dd-description">
Path to the directory with binary system libraries.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">EJABBERD_DOC_PATH</span></span></dt><dd class="dd-description">
Path to the directory with ejabberd documentation.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">EJABBERD_PID_PATH</span></span></dt><dd class="dd-description">
Path to the PID file that ejabberd can create when started.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">HOME</span></span></dt><dd class="dd-description">
Path to the directory that is considered <span style="font-family:monospace">ejabberd</span>’s home.
This path is used to read the file <span style="font-family:monospace">.erlang.cookie</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ERL_CRASH_DUMP</span></span></dt><dd class="dd-description">
Path to the file where crash reports will be dumped.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ERL_EPMD_ADDRESS</span></span></dt><dd class="dd-description">
IP address where epmd listens for connections (see section <a href="#epmd">5.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ERL_INETRC</span></span></dt><dd class="dd-description">
Indicates which IP name resolution to use.
If using <span style="font-family:monospace">-sname</span>, specify either this option or <span style="font-family:monospace">-kernel inetrc filepath</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ERL_MAX_PORTS</span></span></dt><dd class="dd-description">
Maximum number of simultaneously open Erlang ports.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ERL_MAX_ETS_TABLES</span></span></dt><dd class="dd-description">
Maximum number of ETS and Mnesia tables.
</dd></dl><p>The command line parameters:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">-sname ejabberd</span></span></dt><dd class="dd-description">
The Erlang node will be identified using only the first part
of the host name, i. e. other Erlang nodes outside this domain cannot contact
this node. This is the preferable option in most cases.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-name ejabberd</span></span></dt><dd class="dd-description">
The Erlang node will be fully identified.
This is only useful if you plan to setup an <span style="font-family:monospace">ejabberd</span> cluster with nodes in different networks.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-kernel inetrc ’"/etc/ejabberd/inetrc"’</span></span></dt><dd class="dd-description">
Indicates which IP name resolution to use.
If using <span style="font-family:monospace">-sname</span>, specify either this option or <span style="font-family:monospace">ERL_INETRC</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-kernel inet_dist_listen_min 4200 inet_dist_listen_min 4210</span></span></dt><dd class="dd-description">
Define the first and last ports that <span style="font-family:monospace">epmd</span> (section <a href="#epmd">5.2</a>) can listen to.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-kernel inet_dist_use_interface "{ 127,0,0,1 }"</span></span></dt><dd class="dd-description">
Define the IP address where this Erlang node listens for other nodes
connections (see section <a href="#epmd">5.2</a>).
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-detached</span></span></dt><dd class="dd-description">
Starts the Erlang system detached from the system console.
Useful for running daemons and background processes.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-noinput</span></span></dt><dd class="dd-description">
Ensures that the Erlang system never tries to read any input.
Useful for running daemons and background processes.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-pa /var/lib/ejabberd/ebin</span></span></dt><dd class="dd-description">
Specify the directory where Erlang binary files (*.beam) are located.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-s ejabberd</span></span></dt><dd class="dd-description">
Tell Erlang runtime system to start the <span style="font-family:monospace">ejabberd</span> application.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-mnesia dir ’"/var/lib/ejabberd/"’</span></span></dt><dd class="dd-description">
Specify the Mnesia database directory.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-sasl sasl_error_logger {file, "/var/log/ejabberd/erlang.log"}</span></span></dt><dd class="dd-description">
Path to the Erlang/OTP system log file.
SASL here means “System Architecture Support Libraries”
not “Simple Authentication and Security Layer”.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">+K [true|false]</span></span></dt><dd class="dd-description">
Kernel polling.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-smp [auto|enable|disable]</span></span></dt><dd class="dd-description">
SMP support.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">+P 250000</span></span></dt><dd class="dd-description">
Maximum number of Erlang processes.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-remsh ejabberd@localhost</span></span></dt><dd class="dd-description">
Open an Erlang shell in a remote Erlang node.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">-hidden</span></span></dt><dd class="dd-description">
The connections to other nodes are hidden (not published).
The result is that this node is not considered part of the cluster.
This is important when starting a temporary <span style="font-family:monospace">ctl</span> or <span style="font-family:monospace">debug</span> node.
</dd></dl><p>
Note that some characters need to be escaped when used in shell scripts, for instance <code>"</code> and <code>{}</code>.
You can find other options in the Erlang manual page (<span style="font-family:monospace">erl -man erl</span>).</p><p> <a id="eja-commands"></a> </p>
<!--TOC section id="sec106" <span style="font-family:monospace">ejabberd</span> Commands-->
<h2 id="sec106" class="section">4.2  <a href="#eja-commands"><span style="font-family:monospace">ejabberd</span> Commands</a></h2><!--SEC END --><p> <a id="eja-commands"></a> </p><p>An <span style="font-family:monospace">ejabberd command</span> is an abstract function identified by a name,
with a defined number and type of calling arguments and type of result
that is registered in the <span style="font-family:monospace">ejabberd_commands</span> service.
Those commands can be defined in any Erlang module and executed using any valid frontend.</p><p><span style="font-family:monospace">ejabberd</span> includes two frontends to execute <span style="font-family:monospace">ejabberd commands</span>: the script <span style="font-family:monospace">ejabberdctl</span> (<a href="#ejabberdctl">4.1</a>)
and the <span style="font-family:monospace">ejabberd_xmlrpc</span> listener (<a href="#listened-module">3.1.4</a>).
Other known frontends that can be installed to execute ejabberd commands in different ways are:
<span style="font-family:monospace">mod_rest</span> (HTTP POST service),
<span style="font-family:monospace">mod_shcommands</span> (ejabberd WebAdmin page).</p><p> <a id="list-eja-commands"></a> </p>
<!--TOC subsection id="sec107" List of ejabberd Commands-->
<h3 id="sec107" class="subsection">4.2.1  <a href="#list-eja-commands">List of ejabberd Commands</a></h3><!--SEC END --><p> <a id="list-eja-commands"></a> </p><p><span style="font-family:monospace">ejabberd</span> includes a few ejabberd Commands by default.
When more modules are installed, new commands may be available in the frontends.</p><p>The easiest way to get a list of the available commands, and get help for them is to use
the ejabberdctl script:
</p><pre class="verbatim">$ ejabberdctl help
Usage: ejabberdctl [--node nodename] [--auth user host password] command [options]
Available commands in this ejabberd node:
backup file Store the database to backup file
connected_users List all established sessions
connected_users_number Get the number of established sessions
...
</pre><p>The most interesting ones are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">reopen_log</span></span></dt><dd class="dd-description"> Reopen the log files after they were renamed.
If the old files were not renamed before calling this command,
they are automatically renamed to <span style="font-family:monospace">"*-old.log"</span>. See section <a href="#logfiles">7.1</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">convert_to_yaml /etc/ejabberd/ejabberd.cfg /etc/ejabberd/ejabberd-converted.yml</span></span></dt><dd class="dd-description">
Convert an old ejabberd.cfg file to the YAML syntax in a new file.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">backup ejabberd.backup</span></span></dt><dd class="dd-description">
Store internal Mnesia database to a binary backup file.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">restore ejabberd.backup</span></span></dt><dd class="dd-description">
Restore immediately from a binary backup file the internal Mnesia database.
This will consume a lot of memory if you have a large database,
so better use <span style="font-family:monospace">install_fallback</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">install_fallback ejabberd.backup</span></span></dt><dd class="dd-description">
The binary backup file is installed as fallback:
it will be used to restore the database at the next ejabberd start.
This means that, after running this command, you have to restart ejabberd.
This command requires less memory than <span style="font-family:monospace">restore</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">dump ejabberd.dump</span></span></dt><dd class="dd-description">
Dump internal Mnesia database to a text file dump.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">load ejabberd.dump</span></span></dt><dd class="dd-description">
Restore immediately from a text file dump.
This is not recommended for big databases, as it will consume much time,
memory and processor. In that case it’s preferable to use <span style="font-family:monospace">backup</span> and <span style="font-family:monospace">install_fallback</span>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">import_piefxis, export_piefxis, export_piefxis_host</span></span></dt><dd class="dd-description">
These options can be used to migrate accounts
using <a href="http://xmpp.org/extensions/xep-0227.html">XEP-0227</a> formatted XML files
from/to other Jabber/XMPP servers
or move users of a vhost to another ejabberd installation.
See also <a href="https://support.process-one.net/doc/display/MESSENGER/ejabberd+migration+kit">ejabberd migration kit</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">import_file, import_dir</span></span></dt><dd class="dd-description">
These options can be used to migrate accounts
using jabberd1.4 formatted XML files.
from other Jabber/XMPP servers
There exist tutorials to
<a href="http://www.ejabberd.im/migrate-to-ejabberd">migrate from other software to ejabberd</a>.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">export2odbc virtualhost directory</span></span></dt><dd class="dd-description">
Export virtual host information from Mnesia tables to SQL files.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">delete_expired_messages</span></span></dt><dd class="dd-description"> This option can be used to delete old messages
in offline storage. This might be useful when the number of offline messages
is very high.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">delete_old_messages days</span></span></dt><dd class="dd-description"> Delete offline messages older than the given days.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">register user host password</span></span></dt><dd class="dd-description"> Register an account in that domain with the given password.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">unregister user host</span></span></dt><dd class="dd-description"> Unregister the given account.
</dd></dl><p> <a id="accesscommands"></a> </p>
<!--TOC subsection id="sec108" Restrict Execution with AccessCommands-->
<h3 id="sec108" class="subsection">4.2.2  <a href="#accesscommands">Restrict Execution with AccessCommands</a></h3><!--SEC END --><p> <a id="accesscommands"></a> </p><p>The frontends can be configured to restrict access to certain commands.
In that case, authentication information must be provided.
In each frontend the <span style="font-family:monospace">AccessCommands</span> option is defined
in a different place. But in all cases the option syntax is the same:
</p><pre class="verbatim">AccessCommands = [ {Access, CommandNames, Arguments}, ...]
Access = atom()
CommandNames = all | [CommandName]
CommandName = atom()
Arguments = [ {ArgumentName, ArgumentValue}, ...]
ArgumentName = atom()
ArgumentValue = any()
</pre><p>The default value is to not define any restriction: <span style="font-family:monospace">[]</span>.
The authentication information is provided when executing a command,
and is Username, Hostname and Password of a local XMPP account
that has permission to execute the corresponding command.
This means that the account must be registered in the local ejabberd,
because the information will be verified.</p><p>When one or several access restrictions are defined and the
authentication information is provided,
each restriction is verified until one matches completely:
the account matches the Access rule,
the command name is listed in CommandNames,
and the provided arguments do not contradict Arguments.</p><p>As an example to understand the syntax, let’s suppose those options:
</p><pre class="verbatim">{hosts, ["example.org"]}.
{acl, bots, {user, "robot1", "example.org"}}.
{access, commaccess, [{allow, bots}]}.
</pre><p>This list of access restrictions allows only <span style="font-family:monospace">robot1@example.org</span> to execute all commands:
</p><pre class="verbatim">[{commaccess, all, []}]
</pre><p>See another list of restrictions (the corresponding ACL and ACCESS are not shown):
</p><pre class="verbatim">[
%% This bot can execute all commands:
{bot, all, []},
%% This bot can only execute the command 'dump'. No argument restriction:
{bot_backups, [dump], []}
%% This bot can execute all commands,
%% but if a 'host' argument is provided, it must be "example.org":
{bot_all_example, all, [{host, "example.org"}]},
%% This bot can only execute the command 'register',
%% and if argument 'host' is provided, it must be "example.org":
{bot_reg_example, [register], [{host, "example.org"}]},
%% This bot can execute the commands 'register' and 'unregister',
%% if argument host is provided, it must be "test.org":
{_bot_reg_test, [register, unregister], [{host, "test.org"}]}
]
</pre><p> <a id="webadmin"></a> </p>
<!--TOC section id="sec109" Web Admin-->
<h2 id="sec109" class="section">4.3  <a href="#webadmin">Web Admin</a></h2><!--SEC END --><p> <a id="webadmin"></a>
</p><p>The <span style="font-family:monospace">ejabberd</span> Web Admin allows to administer most of <span style="font-family:monospace">ejabberd</span> using a web browser.</p><p>This feature is enabled by default:
a <span style="font-family:monospace">ejabberd_http</span> listener with the option <span style="font-family:monospace">web_admin</span> (see
section <a href="#listened">3.1.4</a>) is included in the listening ports. Then you can open
<code>http://server:port/admin/</code> in your favourite web browser. You
will be asked to enter the username (the <em>full</em> Jabber ID) and password
of an <span style="font-family:monospace">ejabberd</span> user with administrator rights. After authentication
you will see a page similar to figure <a href="#fig%3Awebadmmain">4.1</a>.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="webadmmain.png" alt="webadmmain.png">
<div class="caption"><table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="vertical-align:top;text-align:left;" >Figure 4.1: Top page from the Web Admin</td></tr>
</table></div>
<a id="fig:webadmmain"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p>
Here you can edit access restrictions, manage users, create backups,
manage the database, enable/disable ports listened for, view server
statistics,…</p><p>The access rule <span style="font-family:monospace">configure</span> determines what accounts can access the Web Admin and modify it.
The access rule <span style="font-family:monospace">webadmin_view</span> is to grant only view access: those accounts can browse the Web Admin with read-only access.</p><p>Example configurations:
</p><ul class="itemize"><li class="li-itemize">
You can serve the Web Admin on the same port as the
HTTP Polling interface. In this example
you should point your web browser to <code>http://example.org:5280/admin/</code> to
administer all virtual hosts or to
<code>http://example.org:5280/admin/server/example.com/</code> to administer only
the virtual host <span style="font-family:monospace">example.com</span>. Before you get access to the Web Admin
you need to enter as username, the JID and password from a registered user
that is allowed to configure <span style="font-family:monospace">ejabberd</span>. In this example you can enter as
username ‘<span style="font-family:monospace">admin@example.net</span>’ to administer all virtual hosts (first
URL). If you log in with ‘<span style="font-family:monospace">admin@example.com</span>’ on <br>
<code>http://example.org:5280/admin/server/example.com/</code> you can only
administer the virtual host <span style="font-family:monospace">example.com</span>.
The account ‘<span style="font-family:monospace">reviewer@example.com</span>’ can browse that vhost in read-only mode.
<pre class="verbatim">acl:
admin:
user:
- "admin": "example.net"
host_config:
"example.com":
acl:
admin:
user:
- "admin": "example.com"
viewers:
user:
- "reviewer": "example.com"
access:
configure:
admin: allow
webadmin_view:
viewers: allow
hosts:
- "example.org"
listen:
...
-
port: 5280
module: ejabberd_http
web_admin: true
http_poll: true
...
</pre></li><li class="li-itemize">For security reasons, you can serve the Web Admin on a secured
connection, on a port differing from the HTTP Polling interface, and bind it
to the internal LAN IP. The Web Admin will be accessible by pointing your
web browser to <code>https://192.168.1.1:5282/admin/</code>:
<pre class="verbatim">hosts:
- "example.org"
listen:
...
-
port: 5280
module: ejabberd_http
http_poll: true
-
ip: "192.168.1.1"
port: 5282
module: ejabberd_http
certfile: "/usr/local/etc/server.pem"
tls: true
web_admin: true
...
</pre></li></ul><p>Certain pages in the ejabberd Web Admin contain a link to a related
section in the ejabberd Installation and Operation Guide.
In order to view such links, a copy in HTML format of the Guide must
be installed in the system.
The file is searched by default in
<span style="font-family:monospace">"/share/doc/ejabberd/guide.html"</span>.
The directory of the documentation can be specified in
the environment variable <span style="font-family:monospace">EJABBERD_DOC_PATH</span>.
See section <a href="#erlangconfiguration">4.1.2</a>.</p><p> <a id="adhoccommands"></a> </p>
<!--TOC section id="sec110" Ad-hoc Commands-->
<h2 id="sec110" class="section">4.4  <a href="#adhoccommands">Ad-hoc Commands</a></h2><!--SEC END --><p> <a id="adhoccommands"></a> </p><p>If you enable <span style="font-family:monospace">mod_configure</span> and <span style="font-family:monospace">mod_adhoc</span>,
you can perform several administrative tasks in <span style="font-family:monospace">ejabberd</span>
with an XMPP client.
The client must support Ad-Hoc Commands (<a href="http://xmpp.org/extensions/xep-0050.html">XEP-0050</a>),
and you must login in the XMPP server with
an account with proper privileges.</p><p> <a id="changeerlangnodename"></a> </p>
<!--TOC section id="sec111" Change Computer Hostname-->
<h2 id="sec111" class="section">4.5  <a href="#changeerlangnodename">Change Computer Hostname</a></h2><!--SEC END --><p> <a id="changeerlangnodename"></a> </p><p><span style="font-family:monospace">ejabberd</span> uses the distributed Mnesia database.
Being distributed, Mnesia enforces consistency of its file,
so it stores the name of the Erlang node in it (see section <a href="#nodename">5.4</a>).
The name of an Erlang node includes the hostname of the computer.
So, the name of the Erlang node changes
if you change the name of the machine in which <span style="font-family:monospace">ejabberd</span> runs,
or when you move <span style="font-family:monospace">ejabberd</span> to a different machine.</p><p>You have two ways to use the old Mnesia database in an ejabberd with new node name:
put the old node name in <span style="font-family:monospace">ejabberdctl.cfg</span>,
or convert the database to the new node name.</p><p>Those example steps will backup, convert and load the Mnesia database.
You need to have either the old Mnesia spool dir or a backup of Mnesia.
If you already have a backup file of the old database, you can go directly to step 5.
You also need to know the old node name and the new node name.
If you don’t know them, look for them by executing <span style="font-family:monospace">ejabberdctl</span>
or in the ejabberd log files.</p><p>Before starting, setup some variables:
</p><pre class="verbatim">OLDNODE=ejabberd@oldmachine
NEWNODE=ejabberd@newmachine
OLDFILE=/tmp/old.backup
NEWFILE=/tmp/new.backup
</pre><ol class="enumerate" type=1><li class="li-enumerate">
Start ejabberd enforcing the old node name:
<pre class="verbatim">ejabberdctl --node $OLDNODE start
</pre></li><li class="li-enumerate">Generate a backup file:
<pre class="verbatim">ejabberdctl --node $OLDNODE backup $OLDFILE
</pre></li><li class="li-enumerate">Stop the old node:
<pre class="verbatim">ejabberdctl --node $OLDNODE stop
</pre></li><li class="li-enumerate">Make sure there aren’t files in the Mnesia spool dir. For example:
<pre class="verbatim">mkdir /var/lib/ejabberd/oldfiles
mv /var/lib/ejabberd/*.* /var/lib/ejabberd/oldfiles/
</pre></li><li class="li-enumerate">Start ejabberd. There isn’t any need to specify the node name anymore:
<pre class="verbatim">ejabberdctl start
</pre></li><li class="li-enumerate">Convert the backup to new node name:
<pre class="verbatim">ejabberdctl mnesia_change_nodename $OLDNODE $NEWNODE $OLDFILE $NEWFILE
</pre></li><li class="li-enumerate">Install the backup file as a fallback:
<pre class="verbatim">ejabberdctl install_fallback $NEWFILE
</pre></li><li class="li-enumerate">Stop ejabberd:
<pre class="verbatim">ejabberdctl stop
</pre>You may see an error message in the log files, it’s normal, so don’t worry:
<pre class="verbatim">Mnesia(ejabberd@newmachine):
** ERROR ** (ignoring core)
** FATAL ** A fallback is installed and Mnesia must be restarted.
Forcing shutdown after mnesia_down from ejabberd@newmachine...
</pre></li><li class="li-enumerate">Now you can finally start ejabberd:
<pre class="verbatim">ejabberdctl start
</pre></li><li class="li-enumerate">Check that the information of the old database is available: accounts, rosters...
After you finish, remember to delete the temporary backup files from public directories.
</li></ol><p> <a id="secure"></a> </p>
<!--TOC chapter id="sec112" Securing <span style="font-family:monospace">ejabberd</span>-->
<h1 id="sec112" class="chapter">Chapter 5  <a href="#secure">Securing <span style="font-family:monospace">ejabberd</span></a></h1><!--SEC END --><p> <a id="secure"></a> </p><p> <a id="firewall"></a> </p>
<!--TOC section id="sec113" Firewall Settings-->
<h2 id="sec113" class="section">5.1  <a href="#firewall">Firewall Settings</a></h2><!--SEC END --><p> <a id="firewall"></a>
</p><p>You need to take the following TCP ports in mind when configuring your firewall:
</p><blockquote class="table"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<table border=1 style="border-spacing:0;" class="cellpadding1"><tr><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Port</span></td><td style="text-align:left;border:solid 1px;white-space:nowrap" ><span style="font-weight:bold">Description</span> </td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >5222</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Standard port for Jabber/XMPP client connections, plain or STARTTLS.</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >5223</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Standard port for Jabber client connections using the old SSL method.</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >5269</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Standard port for Jabber/XMPP server connections.</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >4369</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >EPMD (section <a href="#epmd">5.2</a>) listens for Erlang node name requests.</td></tr>
<tr><td style="text-align:left;border:solid 1px;white-space:nowrap" >port range</td><td style="text-align:left;border:solid 1px;white-space:nowrap" >Used for connections between Erlang nodes. This range is configurable (see section <a href="#epmd">5.2</a>).</td></tr>
</table>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p> <a id="epmd"></a> </p>
<!--TOC section id="sec114" epmd-->
<h2 id="sec114" class="section">5.2  <a href="#epmd">epmd</a></h2><!--SEC END --><p> <a id="epmd"></a> </p><p><a href="http://www.erlang.org/doc/man/epmd.html">epmd (Erlang Port Mapper Daemon)</a>
is a small name server included in Erlang/OTP
and used by Erlang programs when establishing distributed Erlang communications.
<span style="font-family:monospace">ejabberd</span> needs <span style="font-family:monospace">epmd</span> to use <span style="font-family:monospace">ejabberdctl</span> and also when clustering <span style="font-family:monospace">ejabberd</span> nodes.
This small program is automatically started by Erlang, and is never stopped.
If <span style="font-family:monospace">ejabberd</span> is stopped, and there aren’t any other Erlang programs
running in the system, you can safely stop <span style="font-family:monospace">epmd</span> if you want.</p><p><span style="font-family:monospace">ejabberd</span> runs inside an Erlang node.
To communicate with <span style="font-family:monospace">ejabberd</span>, the script <span style="font-family:monospace">ejabberdctl</span> starts a new Erlang node
and connects to the Erlang node that holds <span style="font-family:monospace">ejabberd</span>.
In order for this communication to work,
<span style="font-family:monospace">epmd</span> must be running and listening for name requests in the port 4369.
You should block the port 4369 in the firewall in such a way that
only the programs in your machine can access it.
or configure the option <span style="font-family:monospace">ERL_EPMD_ADDRESS</span> in the file <span style="font-family:monospace">ejabberdctl.cfg</span>.</p><p>If you build a cluster of several <span style="font-family:monospace">ejabberd</span> instances,
each <span style="font-family:monospace">ejabberd</span> instance is called an <span style="font-family:monospace">ejabberd</span> node.
Those <span style="font-family:monospace">ejabberd</span> nodes use a special Erlang communication method to
build the cluster, and EPMD is again needed listening in the port 4369.
So, if you plan to build a cluster of <span style="font-family:monospace">ejabberd</span> nodes
you must open the port 4369 for the machines involved in the cluster.
Remember to block the port so Internet doesn’t have access to it.</p><p>Once an Erlang node solved the node name of another Erlang node using EPMD and port 4369,
the nodes communicate directly.
The ports used in this case by default are random,
but can be configured in the file <span style="font-family:monospace">ejabberdctl.cfg</span>.
The Erlang command-line parameter used internally is, for example:
</p><pre class="verbatim">erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
</pre><p>It is also possible to configure in <span style="font-family:monospace">ejabberdctl.cfg</span>
the network interface where the Erlang node will listen and accept connections.
The Erlang command-line parameter used internally is, for example:
</p><pre class="verbatim">erl ... -kernel inet_dist_use_interface "{127,0,0,1}"
</pre><p> <a id="cookie"></a> </p>
<!--TOC section id="sec115" Erlang Cookie-->
<h2 id="sec115" class="section">5.3  <a href="#cookie">Erlang Cookie</a></h2><!--SEC END --><p> <a id="cookie"></a> </p><p>The Erlang cookie is a string with numbers and letters.
An Erlang node reads the cookie at startup from the command-line parameter <span style="font-family:monospace">-setcookie</span>.
If not indicated, the cookie is read from the cookie file <span style="font-family:monospace">$HOME/.erlang.cookie</span>.
If this file does not exist, it is created immediately with a random cookie.
Two Erlang nodes communicate only if they have the same cookie.
Setting a cookie on the Erlang node allows you to structure your Erlang network
and define which nodes are allowed to connect to which.</p><p>Thanks to Erlang cookies, you can prevent access to the Erlang node by mistake,
for example when there are several Erlang nodes running different programs in the same machine.</p><p>Setting a secret cookie is a simple method
to difficult unauthorized access to your Erlang node.
However, the cookie system is not ultimately effective
to prevent unauthorized access or intrusion to an Erlang node.
The communication between Erlang nodes are not encrypted,
so the cookie could be read sniffing the traffic on the network.
The recommended way to secure the Erlang node is to block the port 4369.</p><p> <a id="nodename"></a> </p>
<!--TOC section id="sec116" Erlang Node Name-->
<h2 id="sec116" class="section">5.4  <a href="#nodename">Erlang Node Name</a></h2><!--SEC END --><p> <a id="nodename"></a> </p><p>An Erlang node may have a node name.
The name can be short (if indicated with the command-line parameter <span style="font-family:monospace">-sname</span>)
or long (if indicated with the parameter <span style="font-family:monospace">-name</span>).
Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.</p><p>Using the option <span style="font-family:monospace">-sname</span> instead of <span style="font-family:monospace">-name</span> is a simple method
to difficult unauthorized access to your Erlang node.
However, it is not ultimately effective to prevent access to the Erlang node,
because it may be possible to fake the fact that you are on another network
using a modified version of Erlang <span style="font-family:monospace">epmd</span>.
The recommended way to secure the Erlang node is to block the port 4369.</p><p> <a id="secure-files"></a> </p>
<!--TOC section id="sec117" Securing Sensitive Files-->
<h2 id="sec117" class="section">5.5  <a href="#secure-files">Securing Sensitive Files</a></h2><!--SEC END --><p> <a id="secure-files"></a> </p><p><span style="font-family:monospace">ejabberd</span> stores sensitive data in the file system either in plain text or binary files.
The file system permissions should be set to only allow the proper user to read,
write and execute those files and directories.</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ejabberd configuration file: /etc/ejabberd/ejabberd.yml</span></span></dt><dd class="dd-description">
Contains the JID of administrators
and passwords of external components.
The backup files probably contain also this information,
so it is preferable to secure the whole <span style="font-family:monospace">/etc/ejabberd/</span> directory.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">ejabberd service log: /var/log/ejabberd/ejabberd.log</span></span></dt><dd class="dd-description">
Contains IP addresses of clients.
If the loglevel is set to 5, it contains whole conversations and passwords.
If a logrotate system is used, there may be several log files with similar information,
so it is preferable to secure the whole <span style="font-family:monospace">/var/log/ejabberd/</span> directory.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">Mnesia database spool files in /var/lib/ejabberd/</span></span></dt><dd class="dd-description">
The files store binary data, but some parts are still readable.
The files are generated by Mnesia and their permissions cannot be set directly,
so it is preferable to secure the whole <span style="font-family:monospace">/var/lib/ejabberd/</span> directory.
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">Erlang cookie file: /var/lib/ejabberd/.erlang.cookie</span></span></dt><dd class="dd-description">
See section <a href="#cookie">5.3</a>.
</dd></dl><p> <a id="clustering"></a> </p>
<!--TOC chapter id="sec118" Clustering-->
<h1 id="sec118" class="chapter">Chapter 6  <a href="#clustering">Clustering</a></h1><!--SEC END --><p> <a id="clustering"></a>
</p><p> <a id="howitworks"></a> </p>
<!--TOC section id="sec119" How it Works-->
<h2 id="sec119" class="section">6.1  <a href="#howitworks">How it Works</a></h2><!--SEC END --><p> <a id="howitworks"></a>
</p><p>A XMPP domain is served by one or more <span style="font-family:monospace">ejabberd</span> nodes. These nodes can
be run on different machines that are connected via a network. They all
must have the ability to connect to port 4369 of all another nodes, and must
have the same magic cookie (see Erlang/OTP documentation, in other words the
file <span style="font-family:monospace">~ejabberd/.erlang.cookie</span> must be the same on all nodes). This is
needed because all nodes exchange information about connected users, s2s
connections, registered services, etc…</p><p>Each <span style="font-family:monospace">ejabberd</span> node has the following modules:
</p><ul class="itemize"><li class="li-itemize">
router,
</li><li class="li-itemize">local router,
</li><li class="li-itemize">session manager,
</li><li class="li-itemize">s2s manager.
</li></ul><p> <a id="router"></a> </p>
<!--TOC subsection id="sec120" Router-->
<h3 id="sec120" class="subsection">6.1.1  <a href="#router">Router</a></h3><!--SEC END --><p> <a id="router"></a>
</p><p>This module is the main router of XMPP packets on each node. It
routes them based on their destination’s domains. It uses a global
routing table. The domain of the packet’s destination is searched in the
routing table, and if it is found, the packet is routed to the
appropriate process. If not, it is sent to the s2s manager.</p><p> <a id="localrouter"></a> </p>
<!--TOC subsection id="sec121" Local Router-->
<h3 id="sec121" class="subsection">6.1.2  <a href="#localrouter">Local Router</a></h3><!--SEC END --><p> <a id="localrouter"></a>
</p><p>This module routes packets which have a destination domain equal to
one of this server’s host names. If the destination JID has a non-empty user
part, it is routed to the session manager, otherwise it is processed depending
on its content.</p><p> <a id="sessionmanager"></a> </p>
<!--TOC subsection id="sec122" Session Manager-->
<h3 id="sec122" class="subsection">6.1.3  <a href="#sessionmanager">Session Manager</a></h3><!--SEC END --><p> <a id="sessionmanager"></a>
</p><p>This module routes packets to local users. It looks up to which user
resource a packet must be sent via a presence table. Then the packet is
either routed to the appropriate c2s process, or stored in offline
storage, or bounced back.</p><p> <a id="s2smanager"></a> </p>
<!--TOC subsection id="sec123" s2s Manager-->
<h3 id="sec123" class="subsection">6.1.4  <a href="#s2smanager">s2s Manager</a></h3><!--SEC END --><p> <a id="s2smanager"></a>
</p><p>This module routes packets to other XMPP servers. First, it
checks if an opened s2s connection from the domain of the packet’s
source to the domain of the packet’s destination exists. If that is the case,
the s2s manager routes the packet to the process
serving this connection, otherwise a new connection is opened.</p><p> <a id="cluster"></a> </p>
<!--TOC section id="sec124" Clustering Setup-->
<h2 id="sec124" class="section">6.2  <a href="#cluster">Clustering Setup</a></h2><!--SEC END --><p> <a id="cluster"></a>
</p><p>Suppose you already configured <span style="font-family:monospace">ejabberd</span> on one machine named (<span style="font-family:monospace">first</span>),
and you need to setup another one to make an <span style="font-family:monospace">ejabberd</span> cluster. Then do
following steps:</p><ol class="enumerate" type=1><li class="li-enumerate">
Copy <code>~ejabberd/.erlang.cookie</code> file from <span style="font-family:monospace">first</span> to
<span style="font-family:monospace">second</span>.<p>(alt) You can also add ‘<code>-setcookie content_of_.erlang.cookie</code>’
option to all ‘<span style="font-family:monospace">erl</span>’ commands below.</p></li><li class="li-enumerate">On <span style="font-family:monospace">second</span> run the following command as the <span style="font-family:monospace">ejabberd</span> daemon user,
in the working directory of <span style="font-family:monospace">ejabberd</span>:<pre class="verbatim">erl -sname ejabberd \
-mnesia dir '"/var/lib/ejabberd/"' \
-mnesia extra_db_nodes "['ejabberd@first']" \
-s mnesia
</pre><p>This will start Mnesia serving the same database as <span style="font-family:monospace">ejabberd@first</span>.
You can check this by running the command ‘<code>mnesia:info().</code>’. You
should see a lot of remote tables and a line like the following:</p><p>Note: the Mnesia directory may be different in your system.
To know where does ejabberd expect Mnesia to be installed by default,
call <a href="#ejabberdctl">4.1</a> without options and it will show some help,
including the Mnesia database spool dir.</p><pre class="verbatim">running db nodes = [ejabberd@first, ejabberd@second]
</pre></li><li class="li-enumerate">Now run the following in the same ‘<span style="font-family:monospace">erl</span>’ session:<pre class="verbatim">mnesia:change_table_copy_type(schema, node(), disc_copies).
</pre><p>This will create local disc storage for the database.</p><p>(alt) Change storage type of the <span style="font-family:monospace">scheme</span> table to ‘RAM and disc
copy’ on the second node via the Web Admin.</p></li><li class="li-enumerate">Now you can add replicas of various tables to this node with
‘<code>mnesia:add_table_copy</code>’ or
‘<code>mnesia:change_table_copy_type</code>’ as above (just replace
‘<code>schema</code>’ with another table name and ‘<code>disc_copies</code>’
can be replaced with ‘<code>ram_copies</code>’ or
‘<code>disc_only_copies</code>’).<p>Which tables to replicate is very dependant on your needs, you can get
some hints from the command ‘<code>mnesia:info().</code>’, by looking at the
size of tables and the default storage type for each table on ’first’.</p><p>Replicating a table makes lookups in this table faster on this node.
Writing, on the other hand, will be slower. And of course if machine with one
of the replicas is down, other replicas will be used.</p><p>Also <a href="http://www.erlang.org/doc/apps/mnesia/Mnesia_chap5.html#5.3">section 5.3 (Table Fragmentation) of Mnesia User’s Guide</a> can be helpful.
</p><p>(alt) Same as in previous item, but for other tables.</p></li><li class="li-enumerate">Run ‘<code>init:stop().</code>’ or just ‘<code>q().</code>’ to exit from
the Erlang shell. This probably can take some time if Mnesia has not yet
transfered and processed all data it needed from <span style="font-family:monospace">first</span>.</li><li class="li-enumerate">Now run <span style="font-family:monospace">ejabberd</span> on <span style="font-family:monospace">second</span> with a configuration similar as
on <span style="font-family:monospace">first</span>: you probably do not need to duplicate ‘<code>acl</code>’
and ‘<code>access</code>’ options because they will be taken from
<span style="font-family:monospace">first</span>; and <code>mod_irc</code> should be
enabled only on one machine in the cluster.
</li></ol><p>You can repeat these steps for other machines supposed to serve this
domain.</p><p> <a id="servicelb"></a> </p>
<!--TOC section id="sec125" Service Load-Balancing-->
<h2 id="sec125" class="section">6.3  <a href="#servicelb">Service Load-Balancing</a></h2><!--SEC END --><p> <a id="servicelb"></a>
</p><p> <a id="domainlb"></a> </p>
<!--TOC subsection id="sec126" Domain Load-Balancing Algorithm-->
<h3 id="sec126" class="subsection">6.3.1  <a href="#domainlb">Domain Load-Balancing Algorithm</a></h3><!--SEC END --><p> <a id="domainlb"></a>
</p><p><span style="font-family:monospace">ejabberd</span> includes an algorithm to load balance the components that are plugged on an <span style="font-family:monospace">ejabberd</span> cluster. It means that you can plug one or several instances of the same component on each <span style="font-family:monospace">ejabberd</span> cluster and that the traffic will be automatically distributed.</p><p>The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.</p><p>If you need a different behaviour, you can change the load balancing behaviour with the option <span style="font-family:monospace">domain_balancing</span>. The syntax of the option is the following:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">domain_balancing: BalancingCriteria</span></span></dt></dl><p>Several balancing criteria are available:
</p><ul class="itemize"><li class="li-itemize">
<span style="font-family:monospace">destination</span>: the full JID of the packet <span style="font-family:monospace">to</span> attribute is used.
</li><li class="li-itemize"><span style="font-family:monospace">source</span>: the full JID of the packet <span style="font-family:monospace">from</span> attribute is used.
</li><li class="li-itemize"><span style="font-family:monospace">bare_destination</span>: the bare JID (without resource) of the packet <span style="font-family:monospace">to</span> attribute is used.
</li><li class="li-itemize"><span style="font-family:monospace">bare_source</span>: the bare JID (without resource) of the packet <span style="font-family:monospace">from</span> attribute is used.
</li></ul><p>If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.</p><p> <a id="lbbuckets"></a> </p>
<!--TOC subsection id="sec127" Load-Balancing Buckets-->
<h3 id="sec127" class="subsection">6.3.2  <a href="#lbbuckets">Load-Balancing Buckets</a></h3><!--SEC END --><p> <a id="lbbuckets"></a>
</p><p>When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failing the service will not work correctly unless the sessions are rebalanced.</p><p>In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the <span style="font-family:monospace">domain_balancing_component_number</span> option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">domain_balancing_component_number: Number</span></span></dt></dl><p> <a id="debugging"></a> </p>
<!--TOC chapter id="sec128" Debugging-->
<h1 id="sec128" class="chapter">Chapter 7  <a href="#debugging">Debugging</a></h1><!--SEC END --><p> <a id="debugging"></a>
</p><p> <a id="logfiles"></a> </p>
<!--TOC section id="sec129" Log Files-->
<h2 id="sec129" class="section">7.1  <a href="#logfiles">Log Files</a></h2><!--SEC END --><p> <a id="logfiles"></a> </p><p>An <span style="font-family:monospace">ejabberd</span> node writes two log files:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">ejabberd.log</span></span></dt><dd class="dd-description"> is the ejabberd service log, with the messages reported by <span style="font-family:monospace">ejabberd</span> code
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">erlang.log</span></span></dt><dd class="dd-description"> is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries)
</dd></dl><p>The option <span style="font-family:monospace">loglevel</span> modifies the verbosity of the file ejabberd.log. The syntax:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">loglevel: Level</span></span></dt><dd class="dd-description"> The standard form to set a global log level.
</dd></dl><p>The possible <span style="font-family:monospace">Level</span> are:
</p><dl class="description"><dt class="dt-description">
<span style="font-weight:bold"><span style="font-family:monospace">0</span></span></dt><dd class="dd-description"> No ejabberd log at all (not recommended)
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">1</span></span></dt><dd class="dd-description"> Critical
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">2</span></span></dt><dd class="dd-description"> Error
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">3</span></span></dt><dd class="dd-description"> Warning
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">4</span></span></dt><dd class="dd-description"> Info
</dd><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">5</span></span></dt><dd class="dd-description"> Debug
</dd></dl><p>
For example, the default configuration is:
</p><pre class="verbatim">loglevel: 4
</pre><p>The log files grow continually, so it is recommended to rotate them periodically.
To rotate the log files, rename the files and then reopen them.
The ejabberdctl command <span style="font-family:monospace">reopen-log</span>
(please refer to section <a href="#ectl-commands">4.1.1</a>)
reopens the log files,
and also renames the old ones if you didn’t rename them.</p><p> <a id="debugconsole"></a> </p>
<!--TOC section id="sec130" Debug Console-->
<h2 id="sec130" class="section">7.2  <a href="#debugconsole">Debug Console</a></h2><!--SEC END --><p> <a id="debugconsole"></a> </p><p>The Debug Console is an Erlang shell attached to an already running <span style="font-family:monospace">ejabberd</span> server.
With this Erlang shell, an experienced administrator can perform complex tasks.</p><p>This shell gives complete control over the <span style="font-family:monospace">ejabberd</span> server,
so it is important to use it with extremely care.
There are some simple and safe examples in the article
<a href="http://www.ejabberd.im/interconnect-erl-nodes">Interconnecting Erlang Nodes</a></p><p>To exit the shell, close the window or press the keys: control+c control+c.</p><p> <a id="watchdog"></a> </p>
<!--TOC section id="sec131" Watchdog Alerts-->
<h2 id="sec131" class="section">7.3  <a href="#watchdog">Watchdog Alerts</a></h2><!--SEC END --><p> <a id="watchdog"></a>
</p><p><span style="font-family:monospace">ejabberd</span> includes a watchdog mechanism that may be useful to developers
when troubleshooting a problem related to memory usage.
If a process in the <span style="font-family:monospace">ejabberd</span> server consumes more memory than the configured threshold,
a message is sent to the XMPP accounts defined with the option
<span style="font-family:monospace">watchdog_admins</span>
in the <span style="font-family:monospace">ejabberd</span> configuration file.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">watchdog_admins: [JID, ...]</span></span></dt></dl><p>The memory consumed is measured in <span style="font-family:monospace">words</span>:
a word on 32-bit architecture is 4 bytes,
and a word on 64-bit architecture is 8 bytes.
The threshold by default is 1000000 words.
This value can be configured with the option <span style="font-family:monospace">watchdog_large_heap</span>,
or in a conversation with the watchdog alert bot.</p><p>The syntax is:
</p><dl class="description"><dt class="dt-description"><span style="font-weight:bold"><span style="font-family:monospace">watchdog_large_heap: Number</span></span></dt></dl><p>Example configuration:
</p><pre class="verbatim">watchdog_admins:
- "admin2@localhost"
- "admin2@example.org"
watchdog_large_heap: 30000000
</pre><p>To remove watchdog admins, remove them in the option.
To remove all watchdog admins, set the option with an empty list:
</p><pre class="verbatim">watchdog_admins: []
</pre><p> <a id="i18ni10n"></a> </p>
<!--TOC chapter id="sec132" Internationalization and Localization-->
<h1 id="sec132" class="chapter">Appendix A  <a href="#i18ni10n">Internationalization and Localization</a></h1><!--SEC END --><p> <a id="i18ni10n"></a>
</p><p>The source code of <span style="font-family:monospace">ejabberd</span> supports localization.
The translators can edit the
<a href="http://www.gnu.org/software/gettext/">gettext</a> .po files
using any capable program (KBabel, Lokalize, Poedit...) or a simple text editor.</p><p>Then gettext
is used to extract, update and export those .po files to the .msg format read by <span style="font-family:monospace">ejabberd</span>.
To perform those management tasks, in the <span style="font-family:monospace">src/</span> directory execute <span style="font-family:monospace">make translations</span>.
The translatable strings are extracted from source code to generate the file <span style="font-family:monospace">ejabberd.pot</span>.
This file is merged with each .po file to produce updated .po files.
Finally those .po files are exported to .msg files, that have a format easily readable by <span style="font-family:monospace">ejabberd</span>.</p><p>All built-in modules support the <span style="font-family:monospace">xml:lang</span> attribute inside IQ queries.
Figure <a href="#fig%3Adiscorus">A.1</a>, for example, shows the reply to the following query:
</p><pre class="verbatim"><iq id='5'
to='example.org'
type='get'
xml:lang='ru'>
<query xmlns='http://jabber.org/protocol/disco#items'/>
</iq>
</pre><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="discorus.png" alt="discorus.png">
<div class="caption"><table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="vertical-align:top;text-align:left;" >Figure A.1: Service Discovery when <span style="font-family:monospace">xml:lang=’ru’</span></td></tr>
</table></div>
<a id="fig:discorus"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p>The Web Admin also supports the <code>Accept-Language</code> HTTP header.</p><blockquote class="figure"><div class="center"><div class="center"><hr style="width:80%;height:2"></div>
<img src="webadmmainru.png" alt="webadmmainru.png">
<div class="caption"><table style="border-spacing:6px;border-collapse:separate;" class="cellpading0"><tr><td style="vertical-align:top;text-align:left;" >Figure A.2: Web Admin showing a virtual host when the web browser provides the
HTTP header ‘Accept-Language: ru’</td></tr>
</table></div>
<a id="fig:webadmmainru"></a>
<div class="center"><hr style="width:80%;height:2"></div></div></blockquote><p> <a id="releasenotes"></a> </p>
<!--TOC chapter id="sec133" Release Notes-->
<h1 id="sec133" class="chapter">Appendix B  <a href="#releasenotes">Release Notes</a></h1><!--SEC END --><p> <a id="releasenotes"></a>
</p><p>Release notes are available from <a href="http://www.process-one.net/en/ejabberd/release_notes/">ejabberd Home Page</a></p><p> <a id="acknowledgements"></a> </p>
<!--TOC chapter id="sec134" Acknowledgements-->
<h1 id="sec134" class="chapter">Appendix C  <a href="#acknowledgements">Acknowledgements</a></h1><!--SEC END --><p> <a id="acknowledgements"></a> </p><p>Thanks to all people who contributed to this guide:
</p><ul class="itemize"><li class="li-itemize">
Alexey Shchepin (<a href="xmpp:aleksey@jabber.ru"><span style="font-family:monospace">xmpp:aleksey@jabber.ru</span></a>)
</li><li class="li-itemize">Badlop (<a href="xmpp:badlop@jabberes.org"><span style="font-family:monospace">xmpp:badlop@jabberes.org</span></a>)
</li><li class="li-itemize">Evgeniy Khramtsov (<a href="xmpp:xram@jabber.ru"><span style="font-family:monospace">xmpp:xram@jabber.ru</span></a>)
</li><li class="li-itemize">Florian Zumbiehl (<a href="xmpp:florz@florz.de"><span style="font-family:monospace">xmpp:florz@florz.de</span></a>)
</li><li class="li-itemize">Ludovic Bocquet (<a href="xmpp:lbocquet@jabber.org"><span style="font-family:monospace">xmpp:lbocquet@jabber.org</span></a>)
</li><li class="li-itemize">Marcin Owsiany (<a href="xmpp:marcin.owsiany@gmail.com"><span style="font-family:monospace">xmpp:marcin.owsiany@gmail.com</span></a>)
</li><li class="li-itemize">Michael Grigutsch (<a href="xmpp:migri@jabber.i-pobox.net"><span style="font-family:monospace">xmpp:migri@jabber.i-pobox.net</span></a>)
</li><li class="li-itemize">Mickael Remond (<a href="xmpp:mremond@process-one.net"><span style="font-family:monospace">xmpp:mremond@process-one.net</span></a>)
</li><li class="li-itemize">Sander Devrieze (<a href="xmpp:s.devrieze@gmail.com"><span style="font-family:monospace">xmpp:s.devrieze@gmail.com</span></a>)
</li><li class="li-itemize">Sergei Golovan (<a href="xmpp:sgolovan@nes.ru"><span style="font-family:monospace">xmpp:sgolovan@nes.ru</span></a>)
</li><li class="li-itemize">Vsevolod Pelipas (<a href="xmpp:vsevoload@jabber.ru"><span style="font-family:monospace">xmpp:vsevoload@jabber.ru</span></a>)
</li></ul><p> <a id="copyright"></a> </p>
<!--TOC chapter id="sec135" Copyright Information-->
<h1 id="sec135" class="chapter">Appendix D  <a href="#copyright">Copyright Information</a></h1><!--SEC END --><p> <a id="copyright"></a> </p><p>Ejabberd Installation and Operation Guide.<br>
Copyright © 2003 — 2014 ProcessOne</p><p>This document is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.</p><p>This document is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.</p><p>You should have received a copy of the GNU General Public License along with
this document; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.</p><!--CUT END -->
<!--HTMLFOOT-->
<!--ENDHTML-->
<!--FOOTER-->
<hr style="height:2"><blockquote class="quote"><em>This document was translated from L<sup>A</sup>T<sub>E</sub>X by
</em><a href="http://hevea.inria.fr/index.html"><em>H</em><em><span style="font-size:small"><sup>E</sup></span></em><em>V</em><em><span style="font-size:small"><sup>E</sup></span></em><em>A</em></a><em>.</em></blockquote></body>
</html>
|
