/usr/share/perl5/ZoneMinder/ConfigData.pm is in zoneminder 1.29.0+dfsg-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # ==========================================================================
#
# ZoneMinder Config Data Module, $Date: 2011-01-20 18:49:42 +0000 (Thu, 20 Jan 2011) $, $Revision: 3230 $
# Copyright (C) 2001-2008 Philip Coombes
#
# This program 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.
#
# This program 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.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# ==========================================================================
#
# This module contains the debug definitions and functions used by the rest
# of the ZoneMinder scripts
#
package ZoneMinder::ConfigData;
use 5.006;
use strict;
use warnings;
require Exporter;
require ZoneMinder::Base;
our @ISA = qw(Exporter ZoneMinder::Base);
# Items to export into callers namespace by default. Note: do not export
# names by default without a very good reason. Use EXPORT_OK instead.
# Do not simply export all your public functions/methods/constants.
# This allows declaration use ZoneMinder ':all';
# If you do not need this, moving things directly into @EXPORT or @EXPORT_OK
# will save memory.
our %EXPORT_TAGS = (
'data' => [ qw(
%types
@options
%options_hash
) ]
);
push( @{$EXPORT_TAGS{all}}, @{$EXPORT_TAGS{$_}} ) foreach keys %EXPORT_TAGS;
our @EXPORT_OK = ( @{ $EXPORT_TAGS{'data'} } );
our @EXPORT = qw();
our $VERSION = $ZoneMinder::Base::VERSION;
# ==========================================================================
#
# Configuration Data
#
# ==========================================================================
use Carp;
our $configInitialised = 0;
sub INIT
{
initialiseConfig();
}
# Types
our %types =
(
string => {
db_type =>"string",
hint =>"string",
pattern =>qr|^(.+)$|,
format =>q( $1 )
},
alphanum => {
db_type =>"string",
hint =>"alphanumeric",
pattern =>qr|^([a-zA-Z0-9-_]+)$|,
format =>q( $1 )
},
text => {
db_type =>"text",
hint =>"free text",
pattern =>qr|^(.+)$|,
format =>q( $1 )
},
boolean => {
db_type =>"boolean",
hint =>"yes|no",
pattern =>qr|^([yn])|i,
check =>q( $1 ),
format =>q( ($1 =~ /^y/)
? "yes"
: "no"
)
},
integer => {
db_type =>"integer",
hint =>"integer",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
decimal => {
db_type =>"decimal",
hint =>"decimal",
pattern =>qr|^(\d+(?:\.\d+)?)$|,
format =>q( $1 )
},
hexadecimal => {
db_type =>"hexadecimal",
hint =>"hexadecimal",
pattern =>qr|^(?:0x)?([0-9a-f]{1,8})$|,
format =>q( "0x".$1 )
},
tristate => {
db_type =>"string",
hint =>"auto|yes|no",
pattern =>qr|^([ayn])|i, check=>q( $1 ),
format =>q( ($1 =~ /^y/)
? "yes"
: ($1 =~ /^n/ ? "no" : "auto" )
)
},
abs_path => {
db_type =>"string",
hint =>"/absolute/path/to/somewhere",
pattern =>qr|^((?:/[^/]*)+?)/?$|,
format =>q( $1 )
},
rel_path => {
db_type =>"string",
hint =>"relative/path/to/somewhere",
pattern =>qr|^((?:[^/].*)?)/?$|,
format =>q( $1 )
},
directory => {
db_type =>"string",
hint =>"directory",
pattern =>qr|^([a-zA-Z0-9-_.]+)$|,
format =>q( $1 )
},
file => {
db_type =>"string",
hint =>"filename",
pattern =>qr|^([a-zA-Z0-9-_.]+)$|,
format =>q( $1 )
},
hostname => {
db_type =>"string",
hint =>"host.your.domain",
pattern =>qr|^([a-zA-Z0-9_.-]+)$|,
format =>q( $1 )
},
url => {
db_type =>"string",
hint =>"http://host.your.domain/",
pattern =>qr|^(?:http://)?(.+)$|,
format =>q( "http://".$1 )
},
email => {
db_type =>"string",
hint =>"your.name\@your.domain",
pattern =>qr|^([a-zA-Z0-9_.-]+)\@([a-zA-Z0-9_.-]+)$|,
format =>q( $1\@$2 )
},
);
sub qqq { ## Un-pad paragraph of text.
local $_ = shift;
s{\n?^\s*}{ }mg;
return $_;
}
our @options =
(
{
name => "ZM_SKIN_DEFAULT",
default => "classic",
description => "Default skin used by web interface",
help => qqq("
ZoneMinder allows the use of many different web interfaces.
This option allows you to set the default skin used by the
website. Users can change their skin later, this merely sets
the default.
"),
type => $types{string},
category => "system",
},
{
name => "ZM_CSS_DEFAULT",
default => "classic",
description => "Default set of css files used by web interface",
help => qqq("
ZoneMinder allows the use of many different web interfaces, and
some skins allow the use of different set of CSS files to
control the appearance. This option allows you to set the
default set of css files used by the website. Users can change
their css later, this merely sets the default.
"),
type => $types{string},
category => "system",
},
{
name => "ZM_LANG_DEFAULT",
default => "en_gb",
description => "Default language used by web interface",
help => qqq("
ZoneMinder allows the web interface to use languages other than
English if the appropriate language file has been created and
is present. This option allows you to change the default
language that is used from the shipped language, British
English, to another language
"),
type => $types{string},
category => "system",
},
{
name => "ZM_OPT_USE_AUTH",
default => "no",
description => "Authenticate user logins to ZoneMinder",
help => qqq("
ZoneMinder can run in two modes. The simplest is an entirely
unauthenticated mode where anyone can access ZoneMinder and
perform all tasks. This is most suitable for installations
where the web server access is limited in other ways. The other
mode enables user accounts with varying sets of permissions.
Users must login or authenticate to access ZoneMinder and are
limited by their defined permissions.
"),
type => $types{boolean},
category => "system",
},
{
name => "ZM_AUTH_TYPE",
default => "builtin",
description => "What is used to authenticate ZoneMinder users",
help => qqq("
ZoneMinder can use two methods to authenticate users when
running in authenticated mode. The first is a builtin method
where ZoneMinder provides facilities for users to log in and
maintains track of their identity. The second method allows
interworking with other methods such as http basic
authentication which passes an independently authentication
'remote' user via http. In this case ZoneMinder would use the
supplied user without additional authentication provided such a
user is configured ion ZoneMinder.
"),
requires => [ { name=>"ZM_OPT_USE_AUTH", value=>"yes" } ],
type => {
db_type =>"string",
hint =>"builtin|remote",
pattern =>qr|^([br])|i,
format =>q( $1 =~ /^b/ ? "builtin" : "remote" )
},
category => "system",
},
{
name => "ZM_AUTH_RELAY",
default => "hashed",
description => "Method used to relay authentication information",
help => qqq("
When ZoneMinder is running in authenticated mode it can pass
user details between the web pages and the back end processes.
There are two methods for doing this. This first is to use a
time limited hashed string which contains no direct username or
password details, the second method is to pass the username and
passwords around in plaintext. This method is not recommend
except where you do not have the md5 libraries available on
your system or you have a completely isolated system with no
external access. You can also switch off authentication
relaying if your system is isolated in other ways.
"),
requires => [ { name=>"ZM_OPT_USE_AUTH", value=>"yes" } ],
type => {
db_type =>"string",
hint =>"hashed|plain|none",
pattern =>qr|^([hpn])|i,
format =>q( ($1 =~ /^h/)
? "hashed"
: ($1 =~ /^p/ ? "plain" : "none" )
)
},
category => "system",
},
{
name => "ZM_AUTH_HASH_SECRET",
default => "...Change me to something unique...",
description => "Secret for encoding hashed authentication information",
help => qqq("
When ZoneMinder is running in hashed authenticated mode it is
necessary to generate hashed strings containing encrypted
sensitive information such as usernames and password. Although
these string are reasonably secure the addition of a random
secret increases security substantially.
"),
requires => [
{ name=>"ZM_OPT_USE_AUTH", value=>"yes" },
{ name=>"ZM_AUTH_RELAY", value=>"hashed" }
],
type => $types{string},
category => "system",
},
{
name => "ZM_AUTH_HASH_IPS",
default => "yes",
description => "Include IP addresses in the authentication hash",
help => qqq("
When ZoneMinder is running in hashed authenticated mode it can
optionally include the requesting IP address in the resultant
hash. This adds an extra level of security as only requests
from that address may use that authentication key. However in
some circumstances, such as access over mobile networks, the
requesting address can change for each request which will cause
most requests to fail. This option allows you to control
whether IP addresses are included in the authentication hash on
your system. If you experience intermitent problems with
authentication, switching this option off may help.
"),
requires => [
{ name=>"ZM_OPT_USE_AUTH", value=>"yes" },
{ name=>"ZM_AUTH_RELAY", value=>"hashed" }
],
type => $types{boolean},
category => "system",
},
{
name => "ZM_AUTH_HASH_LOGINS",
default => "no",
description => "Allow login by authentication hash",
help => qqq("
The normal process for logging into ZoneMinder is via the login
screen with username and password. In some circumstances it may
be desirable to allow access directly to one or more pages, for
instance from a third party application. If this option is
enabled then adding an 'auth' parameter to any request will
include a shortcut login bypassing the login screen, if not
already logged in. As authentication hashes are time and,
optionally, IP limited this can allow short-term access to
ZoneMinder screens from other web pages etc. In order to use
this the calling application will hae to generate the
authentication hash itself and ensure it is valid. If you use
this option you should ensure that you have modified the
ZM_AUTH_HASH_SECRET to somethign unique to your system.
"),
requires => [
{ name=>"ZM_OPT_USE_AUTH", value=>"yes" },
{ name=>"ZM_AUTH_RELAY", value=>"hashed" }
],
type => $types{boolean},
category => "system",
},
{
name => "ZM_OPT_USE_API",
default => "yes",
description => "Enable ZoneMinder APIs",
help => qqq("
ZoneMinder now features a new API using which 3rd party
applications can interact with ZoneMinder data. It is
STRONGLY recommended that you enable authentication along
with APIs. Note that the APIs return sensitive data like
Monitor access details which are configured as JSON objects.
Which is why we recommend you enabling authentication, especially
if you are exposing your ZM instance on the Internet.
"),
type => $types{boolean},
category => "system",
},
# PP - Google reCaptcha settings
{
name => "ZM_OPT_USE_GOOG_RECAPTCHA",
default => "no",
description => "Add Google reCaptcha to login page",
help => qqq("
This option allows you to include a google
reCaptcha validation at login. This means in addition to providing
a valid usernane and password, you will also have to
pass the reCaptcha test. Please note that enabling this
option results in the zoneminder login page reach out
to google servers for captcha validation. Also please note
that enabling this option will break 3rd party clients
like zmNinja and zmView as they also need to login to ZoneMinder
and they will fail the reCaptcha test.
"),
requires => [
{name=>"ZM_OPT_USE_AUTH", value=>"yes"}
],
type => $types {boolean},
category => "system",
},
{
name => "ZM_OPT_GOOG_RECAPTCHA_SITEKEY",
default => "...Insert your recaptcha site-key here...",
description => "Your recaptcha site-key",
help => qqq("You need to generate your keys from
the Google reCaptcha website.
Please refer to https://www.google.com/recaptcha/
for more details.
"),
requires => [
{name=>"ZM_OPT_USE_GOOG_RECAPTCHA", value=>"yes"}
],
type => $types {string},
category => "system",
},
{
name => "ZM_OPT_GOOG_RECAPTCHA_SECRETKEY",
default => "...Insert your recaptcha secret-key here...",
description => "Your recaptcha secret-key",
help => qqq("You need to generate your keys from
the Google reCaptcha website.
Please refer to https://www.google.com/recaptcha/
for more details.
"),
requires => [
{name=>"ZM_OPT_USE_GOOG_RECAPTCHA", value=>"yes"}
],
type => $types {string},
category => "system",
},
{
name => "ZM_DIR_EVENTS",
default => "events",
description => "Directory where events are stored",
help => qqq("
This is the path to the events directory where all the event
images and other miscellaneous files are stored. CAUTION: The
directory you specify here cannot be outside the web root. This
is a common mistake. Most users should never change this value.
If you intend to record events to a second disk or network
share, then you should mount the drive or share directly to the
ZoneMinder events folder or follow the instructions in the
ZoneMinder Wiki titled Using a dedicated Hard Drive.
"),
type => $types{directory},
category => "paths",
},
{
name => "ZM_USE_DEEP_STORAGE",
default => "yes",
description => "Use a deep filesystem hierarchy for events",
help => qqq("
This option is now the default for new ZoneMinder systems and
should not be changed. Previous versions of ZoneMinder stored
all events for a monitor under one folder. Enabling
USE_DEEP_STORAGE causes ZoneMinder to store events under a
folder structure that follows year/month/day/hour/min/second.
Storing events this way avoids the limitation of storing more
than 32k files in a single folder inherent in some filesystems.
It is important to note that you cannot simply change this
option. You must stop zoneminder, enable USE_DEEP_STORAGE, and
then run \"sudo zmupdate.pl --migrate-events\". FAILURE TO DO
SO WILL RESULT IN LOSS OF YOUR DATA! Consult the ZoneMinder
WiKi for further details.
"),
type => $types{boolean},
category => "hidden",
},
{
name => "ZM_DIR_IMAGES",
default => "images",
description => "Directory where the images that the ZoneMinder client generates are stored",
help => qqq("
ZoneMinder generates a myriad of images, mostly of which are
associated with events. For those that aren't this is where
they go. CAUTION: The directory you specify here cannot be
outside the web root. This is a common mistake. Most users
should never change this value. If you intend to save images to
a second disk or network share, then you should mount the drive
or share directly to the ZoneMinder images folder or follow the
instructions in the ZoneMinder Wiki titled Using a dedicated
Hard Drive.
"),
type => $types{directory},
category => "paths",
},
{
name => "ZM_DIR_SOUNDS",
default => "sounds",
description => "Directory to the sounds that the ZoneMinder client can use",
help => qqq("
ZoneMinder can optionally play a sound file when an alarm is
detected. This indicates where to look for this file. CAUTION:
The directory you specify here cannot be outside the web root.
Most users should never change this value.
"),
type => $types{directory},
category => "paths",
},
{
name => "ZM_PATH_ZMS",
default => "/zm/cgi-bin/nph-zms",
description => "Web path to zms streaming server",
help => qqq("
The ZoneMinder streaming server is required to send streamed
images to your browser. It will be installed into the cgi-bin
path given at configuration time. This option determines what
the web path to the server is rather than the local path on
your machine. Ordinarily the streaming server runs in
parser-header mode however if you experience problems with
streaming you can change this to non-parsed-header (nph) mode
by changing 'zms' to 'nph-zms'.
"),
type => $types{rel_path},
category => "paths",
},
{
name => "ZM_COLOUR_JPEG_FILES",
default => "no",
description => "Colourise greyscale JPEG files",
help => qqq("
Cameras that capture in greyscale can write their captured
images to jpeg files with a corresponding greyscale colour
space. This saves a small amount of disk space over colour
ones. However some tools such as ffmpeg either fail to work
with this colour space or have to convert it beforehand.
Setting this option to yes uses up a little more space but
makes creation of MPEG files much faster.
"),
type => $types{boolean},
category => "images",
},
{
name => "ZM_ADD_JPEG_COMMENTS",
default => "no",
description => "Add jpeg timestamp annotations as file header comments",
help => qqq("
JPEG files may have a number of extra fields added to the file
header. The comment field may have any kind of text added. This
options allows you to have the same text that is used to
annotate the image additionally included as a file header
comment. If you archive event images to other locations this
may help you locate images for particular events or times if
you use software that can read comment headers.
"),
type => $types{boolean},
category => "images",
},
{
name => "ZM_JPEG_FILE_QUALITY",
default => "70",
description => "Set the JPEG quality setting for the saved event files (1-100)",
help => qqq("
When ZoneMinder detects an event it will save the images
associated with that event to files. These files are in the
JPEG format and can be viewed or streamed later. This option
specifies what image quality should be used to save these
files. A higher number means better quality but less
compression so will take up more disk space and take longer to
view over a slow connection. By contrast a low number means
smaller, quicker to view, files but at the price of lower
quality images. This setting applies to all images written
except if the capture image has caused an alarm and the alarm
file quality option is set at a higher value when that is used
instead.
"),
type => $types{integer},
category => "images",
},
{
name => "ZM_JPEG_ALARM_FILE_QUALITY",
default => "0",
description => "Set the JPEG quality setting for the saved event files during an alarm (1-100)",
help => qqq("
This value is equivalent to the regular jpeg file quality
setting above except that it only applies to images saved while
in an alarm state and then only if this value is set to a
higher quality setting than the ordinary file setting. If set
to a lower value then it is ignored. Thus leaving it at the
default of 0 effectively means to use the regular file quality
setting for all saved images. This is to prevent acccidentally
saving important images at a worse quality setting.
"),
type => $types{integer},
category => "images",
},
# Deprecated, now stream quality
{
name => "ZM_JPEG_IMAGE_QUALITY",
default => "70",
description => "Set the JPEG quality setting for the streamed 'live' images (1-100)",
help => qqq("
When viewing a 'live' stream for a monitor ZoneMinder will grab
an image from the buffer and encode it into JPEG format before
sending it. This option specifies what image quality should be
used to encode these images. A higher number means better
quality but less compression so will take longer to view over a
slow connection. By contrast a low number means quicker to view
images but at the price of lower quality images. This option
does not apply when viewing events or still images as these are
usually just read from disk and so will be encoded at the
quality specified by the previous options.
"),
type => $types{integer},
category => "hidden",
},
{
name => "ZM_JPEG_STREAM_QUALITY",
default => "70",
description => "Set the JPEG quality setting for the streamed 'live' images (1-100)",
help => qqq("
When viewing a 'live' stream for a monitor ZoneMinder will grab
an image from the buffer and encode it into JPEG format before
sending it. This option specifies what image quality should be
used to encode these images. A higher number means better
quality but less compression so will take longer to view over a
slow connection. By contrast a low number means quicker to view
images but at the price of lower quality images. This option
does not apply when viewing events or still images as these are
usually just read from disk and so will be encoded at the
quality specified by the previous options.
"),
type => $types{integer},
category => "images",
},
{
name => "ZM_MPEG_TIMED_FRAMES",
default => "yes",
description => "Tag video frames with a timestamp for more realistic streaming",
help => qqq("
When using streamed MPEG based video, either for live monitor
streams or events, ZoneMinder can send the streams in two ways.
If this option is selected then the timestamp for each frame,
taken from it's capture time, is included in the stream. This
means that where the frame rate varies, for instance around an
alarm, the stream will still maintain it's 'real' timing. If
this option is not selected then an approximate frame rate is
calculated and that is used to schedule frames instead. This
option should be selected unless you encounter problems with
your preferred streaming method.
"),
type => $types{boolean},
category => "images",
},
{
name => "ZM_MPEG_LIVE_FORMAT",
default => "swf",
description => "What format 'live' video streams are played in",
help => qqq("
When using MPEG mode ZoneMinder can output live video. However
what formats are handled by the browser varies greatly between
machines. This option allows you to specify a video format
using a file extension format, so you would just enter the
extension of the file type you would like and the rest is
determined from that. The default of 'asf' works well under
Windows with Windows Media Player but I'm currently not sure
what, if anything, works on a Linux platform. If you find out
please let me know! If this option is left blank then live
streams will revert to being in motion jpeg format
"),
type => $types{string},
category => "images",
},
{
name => "ZM_MPEG_REPLAY_FORMAT",
default => "swf",
description => "What format 'replay' video streams are played in",
help => qqq("
When using MPEG mode ZoneMinder can replay events in encoded
video format. However what formats are handled by the browser
varies greatly between machines. This option allows you to
specify a video format using a file extension format, so you
would just enter the extension of the file type you would like
and the rest is determined from that. The default of 'asf'
works well under Windows with Windows Media Player and 'mpg',
or 'avi' etc should work under Linux. If you know any more then
please let me know! If this option is left blank then live
streams will revert to being in motion jpeg format
"),
type => $types{string},
category => "images",
},
{
name => "ZM_RAND_STREAM",
default => "yes",
description => "Add a random string to prevent caching of streams",
help => qqq("
Some browsers can cache the streams used by ZoneMinder. In
order to prevent his a harmless random string can be appended
to the url to make each invocation of the stream appear unique.
"),
type => $types{boolean},
category => "images",
},
{
name => "ZM_OPT_CAMBOZOLA",
default => "no",
description => "Is the (optional) cambozola java streaming client installed",
help => qqq("
Cambozola is a handy low fat cheese flavoured Java applet that
ZoneMinder uses to view image streams on browsers such as
Internet Explorer that don't natively support this format. If
you use this browser it is highly recommended to install this
from http://www.charliemouse.com/code/cambozola/ however if it
is not installed still images at a lower refresh rate can still
be viewed.
"),
type => $types{boolean},
category => "images",
},
{
name => "ZM_PATH_CAMBOZOLA",
default => "cambozola.jar",
description => "Web path to (optional) cambozola java streaming client",
help => qqq("
Cambozola is a handy low fat cheese flavoured Java applet that
ZoneMinder uses to view image streams on browsers such as
Internet Explorer that don't natively support this format. If
you use this browser it is highly recommended to install this
from http://www.charliemouse.com/code/cambozola/ however if it
is not installed still images at a lower refresh rate can still
be viewed. Leave this as 'cambozola.jar' if cambozola is
installed in the same directory as the ZoneMinder web client
files.
"),
requires => [ { name=>"ZM_OPT_CAMBOZOLA", value=>"yes" } ],
type => $types{rel_path},
category => "images",
},
{
name => "ZM_RELOAD_CAMBOZOLA",
default => "0",
description => "After how many seconds should Cambozola be reloaded in live view",
help => qqq("
Cambozola allows for the viewing of streaming MJPEG however it
caches the entire stream into cache space on the computer,
setting this to a number > 0 will cause it to automatically
reload after that many seconds to avoid filling up a hard
drive.
"),
type => $types{integer},
category => "images",
},
{
name => "ZM_TIMESTAMP_ON_CAPTURE",
default => "yes",
description => "Timestamp images as soon as they are captured",
help => qqq("
ZoneMinder can add a timestamp to images in two ways. The
default method, when this option is set, is that each image is
timestamped immediately when captured and so the image held in
memory is marked right away. The second method does not
timestamp the images until they are either saved as part of an
event or accessed over the web. The timestamp used in both
methods will contain the same time as this is preserved along
with the image. The first method ensures that an image is
timestamped regardless of any other circumstances but will
result in all images being timestamped even those never saved
or viewed. The second method necessitates that saved images are
copied before being saved otherwise two timestamps perhaps at
different scales may be applied. This has the (perhaps)
desirable side effect that the timestamp is always applied at
the same resolution so an image that has scaling applied will
still have a legible and correctly scaled timestamp.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_CPU_EXTENSIONS",
default => "yes",
description => "Use advanced CPU extensions to increase performance",
help => qqq("
When advanced processor extensions such as SSE2 or SSSE3 are
available, ZoneMinder can use them, which should increase
performance and reduce system load. Enabling this option on
processors that do not support the advanced processors
extensions used by ZoneMinder is harmless and will have no
effect.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_FAST_IMAGE_BLENDS",
default => "yes",
description => "Use a fast algorithm to blend the reference image",
help => qqq("
To detect alarms ZoneMinder needs to blend the captured image
with the stored reference image to update it for comparison
with the next image. The reference blend percentage specified
for the monitor controls how much the new image affects the
reference image. There are two methods that are available for
this. If this option is set then fast calculation which does
not use any multiplication or division is used. This
calculation is extremely fast, however it limits the possible
blend percentages to 50%, 25%, 12.5%, 6.25%, 3.25% and 1.5%.
Any other blend percentage will be rounded to the nearest
possible one. The alternative is to switch this option off
and use standard blending instead, which is slower.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_OPT_ADAPTIVE_SKIP",
default => "yes",
description => "Should frame analysis try and be efficient in skipping frames",
help => qqq("
In previous versions of ZoneMinder the analysis daemon would
attempt to keep up with the capture daemon by processing the
last captured frame on each pass. This would sometimes have the
undesirable side-effect of missing a chunk of the initial
activity that caused the alarm because the pre-alarm frames
would all have to be written to disk and the database before
processing the next frame, leading to some delay between the
first and second event frames. Setting this option enables a
newer adaptive algorithm where the analysis daemon attempts to
process as many captured frames as possible, only skipping
frames when in danger of the capture daemon overwriting yet to
be processed frames. This skip is variable depending on the
size of the ring buffer and the amount of space left in it.
Enabling this option will give you much better coverage of the
beginning of alarms whilst biasing out any skipped frames
towards the middle or end of the event. However you should be
aware that this will have the effect of making the analysis
daemon run somewhat behind the capture daemon during events and
for particularly fast rates of capture it is possible for the
adaptive algorithm to be overwhelmed and not have time to react
to a rapid build up of pending frames and thus for a buffer
overrun condition to occur.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_MAX_SUSPEND_TIME",
default => "30",
description => "Maximum time that a monitor may have motion detection suspended",
help => qqq("
ZoneMinder allows monitors to have motion detection to be
suspended, for instance while panning a camera. Ordinarily this
relies on the operator resuming motion detection afterwards as
failure to do so can leave a monitor in a permanently suspended
state. This setting allows you to set a maximum time which a
camera may be suspended for before it automatically resumes
motion detection. This time can be extended by subsequent
suspend indications after the first so continuous camera
movement will also occur while the monitor is suspended.
"),
type => $types{integer},
category => "config",
},
# Deprecated, really no longer necessary
{
name => "ZM_OPT_REMOTE_CAMERAS",
default => "no",
description => "Are you going to use remote/networked cameras",
help => qqq("
ZoneMinder can work with both local cameras, ie. those attached
physically to your computer and remote or network cameras. If
you will be using networked cameras select this option.
"),
type => $types{boolean},
category => "hidden",
},
# Deprecated, now set on a per monitor basis using the Method field
{
name => "ZM_NETCAM_REGEXPS",
default => "yes",
description => "Use regular expression matching with network cameras",
help => qqq("
Traditionally ZoneMinder has used complex regular regular
expressions to handle the multitude of formats that network
cameras produce. In versions from 1.21.1 the default is to use
a simpler and faster built in pattern matching methodology.
This works well with most networks cameras but if you have
problems you can try the older, but more flexible, regular
expression based method by selecting this option. Note, to use
this method you must have libpcre installed on your system.
"),
requires => [ { name => "ZM_OPT_REMOTE_CAMERAS", value => "yes" } ],
type => $types{boolean},
category => "hidden",
},
{
name => "ZM_HTTP_VERSION",
default => "1.0",
description => "The version of HTTP that ZoneMinder will use to connect",
help => qqq("
ZoneMinder can communicate with network cameras using either of
the HTTP/1.1 or HTTP/1.0 standard. A server will normally fall
back to the version it supports with no problem so this should
usually by left at the default. However it can be changed to
HTTP/1.0 if necessary to resolve particular issues.
"),
type => {
db_type =>"string",
hint =>"1.1|1.0",
pattern =>qr|^(1\.[01])$|,
format =>q( $1?$1:"" )
},
category => "network",
},
{
name => "ZM_HTTP_UA",
default => "ZoneMinder",
description => "The user agent that ZoneMinder uses to identify itself",
help => qqq("
When ZoneMinder communicates with remote cameras it will
identify itself using this string and it's version number. This
is normally sufficient, however if a particular cameras expects
only to communicate with certain browsers then this can be
changed to a different string identifying ZoneMinder as
Internet Explorer or Netscape etc.
"),
type => $types{string},
category => "network",
},
{
name => "ZM_HTTP_TIMEOUT",
default => "2500",
description => "How long ZoneMinder waits before giving up on images (milliseconds)",
help => qqq("
When retrieving remote images ZoneMinder will wait for this
length of time before deciding that an image is not going to
arrive and taking steps to retry. This timeout is in
milliseconds (1000 per second) and will apply to each part of
an image if it is not sent in one whole chunk.
"),
type => $types{integer},
category => "network",
},
{
name => "ZM_MIN_RTP_PORT",
default => "40200",
description => "Minimum port that ZoneMinder will listen for RTP traffic on",
help => qqq("
When ZoneMinder communicates with MPEG4 capable cameras using
RTP with the unicast method it must open ports for the camera
to connect back to for control and streaming purposes. This
setting specifies the minimum port number that ZoneMinder will
use. Ordinarily two adjacent ports are used for each camera,
one for control packets and one for data packets. This port
should be set to an even number, you may also need to open up a
hole in your firewall to allow cameras to connect back if you
wish to use unicasting.
"),
type => $types{integer},
category => "network",
},
{
name => "ZM_MAX_RTP_PORT",
default => "40499",
description => "Maximum port that ZoneMinder will listen for RTP traffic on",
help => qqq("
When ZoneMinder communicates with MPEG4 capable cameras using
RTP with the unicast method it must open ports for the camera
to connect back to for control and streaming purposes. This
setting specifies the maximum port number that ZoneMinder will
use. Ordinarily two adjacent ports are used for each camera,
one for control packets and one for data packets. This port
should be set to an even number, you may also need to open up a
hole in your firewall to allow cameras to connect back if you
wish to use unicasting. You should also ensure that you have
opened up at least two ports for each monitor that will be
connecting to unicasting network cameras.
"),
type => $types{integer},
category => "network",
},
{
name => "ZM_OPT_FFMPEG",
default => "no",
description => "Is the ffmpeg video encoder/decoder installed",
help => qqq("
ZoneMinder can optionally encode a series of video images into
an MPEG encoded movie file for viewing, downloading or storage.
This option allows you to specify whether you have the ffmpeg
tools installed. Note that creating MPEG files can be fairly
CPU and disk intensive and is not a required option as events
can still be reviewed as video streams without it.
"),
type => $types{boolean},
category => "images",
},
{
name => "ZM_PATH_FFMPEG",
default => "/usr/bin/ffmpeg",
description => "Path to (optional) ffmpeg mpeg encoder",
help => "This path should point to where ffmpeg has been installed.",
requires => [ { name=>"ZM_OPT_FFMPEG", value=>"yes" } ],
type => $types{abs_path},
category => "images",
},
{
name => "ZM_FFMPEG_INPUT_OPTIONS",
default => "",
description => "Additional input options to ffmpeg",
help => qqq("
Ffmpeg can take many options on the command line to control the
quality of video produced. This option allows you to specify
your own set that apply to the input to ffmpeg (options that
are given before the -i option). Check the ffmpeg documentation
for a full list of options which may be used here.
"),
requires => [ { name=>"ZM_OPT_FFMPEG", value=>"yes" } ],
type => $types{string},
category => "images",
},
{
name => "ZM_FFMPEG_OUTPUT_OPTIONS",
default => "-r 25",
description => "Additional output options to ffmpeg",
help => qqq("
Ffmpeg can take many options on the command line to control the
quality of video produced. This option allows you to specify
your own set that apply to the output from ffmpeg (options that
are given after the -i option). Check the ffmpeg documentation
for a full list of options which may be used here. The most
common one will often be to force an output frame rate
supported by the video encoder.
"),
requires => [ { name=>"ZM_OPT_FFMPEG", value=>"yes" } ],
type => $types{string},
category => "images",
},
{
name => "ZM_FFMPEG_FORMATS",
default => "mpg mpeg wmv asf avi* mov swf 3gp**",
description => "Formats to allow for ffmpeg video generation",
help => qqq("
Ffmpeg can generate video in many different formats. This
option allows you to list the ones you want to be able to
select. As new formats are supported by ffmpeg you can add them
here and be able to use them immediately. Adding a '*' after a
format indicates that this will be the default format used for
web video, adding '**' defines the default format for phone
video.
"),
requires => [ { name=>"ZM_OPT_FFMPEG", value=>"yes" } ],
type => $types{string},
category => "images",
},
{
name => "ZM_FFMPEG_OPEN_TIMEOUT",
default => "10",
description => "Timeout in seconds when opening a stream.",
help => qqq("
When Ffmpeg is opening a stream, it can take a long time before
failing; certain circumstances even seem to be able to lock
indefinitely. This option allows you to set a maximum time in
seconds to pass before closing the stream and trying to reopen
it again.
"),
requires => [ { name=>"ZM_OPT_FFMPEG", value=>"yes" } ],
type => $types{integer},
category => "images",
},
{
name => "ZM_LOG_LEVEL_SYSLOG",
default => "0",
description => "Save logging output to the system log",
help => qqq("
ZoneMinder logging is now more more integrated between
components and allows you to specify the destination for
logging output and the individual levels for each. This option
lets you control the level of logging output that goes to the
system log. ZoneMinder binaries have always logged to the
system log but now scripts and web logging is also included. To
preserve the previous behaviour you should ensure this value is
set to Info or Warning. This option controls the maximum level
of logging that will be written, so Info includes Warnings and
Errors etc. To disable entirely, set this option to None. You
should use caution when setting this option to Debug as it can
affect severely affect system performance. If you want debug
you will also need to set a level and component below
"),
type => {
db_type =>"integer",
hint =>"None=-5|Panic=-4|Fatal=-3|Error=-2|Warning=-1|Info=0|Debug=1",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "logging",
},
{
name => "ZM_LOG_LEVEL_FILE",
default => "-5",
description => "Save logging output to component files",
help => qqq("
ZoneMinder logging is now more more integrated between
components and allows you to specify the destination for
logging output and the individual levels for each. This option
lets you control the level of logging output that goes to
individual log files written by specific components. This is
how logging worked previously and although useful for tracking
down issues in specific components it also resulted in many
disparate log files. To preserve this behaviour you should
ensure this value is set to Info or Warning. This option
controls the maximum level of logging that will be written, so
Info includes Warnings and Errors etc. To disable entirely, set
this option to None. You should use caution when setting this
option to Debug as it can affect severely affect system
performance though file output has less impact than the other
options. If you want debug you will also need to set a level
and component below
"),
type => {
db_type =>"integer",
hint =>"None=-5|Panic=-4|Fatal=-3|Error=-2|Warning=-1|Info=0|Debug=1",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "logging",
},
{
name => "ZM_LOG_LEVEL_WEBLOG",
default => "-5",
description => "Save logging output to the weblog",
help => qqq("
ZoneMinder logging is now more more integrated between
components and allows you to specify the destination for
logging output and the individual levels for each. This option
lets you control the level of logging output from the web
interface that goes to the httpd error log. Note that only web
logging from PHP and JavaScript files is included and so this
option is really only useful for investigating specific issues
with those components. This option controls the maximum level
of logging that will be written, so Info includes Warnings and
Errors etc. To disable entirely, set this option to None. You
should use caution when setting this option to Debug as it can
affect severely affect system performance. If you want debug
you will also need to set a level and component below
"),
type => {
db_type =>"integer",
hint =>"None=-5|Panic=-4|Fatal=-3|Error=-2|Warning=-1|Info=0|Debug=1",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "logging",
},
{
name => "ZM_LOG_LEVEL_DATABASE",
default => "0",
description => "Save logging output to the database",
help => qqq("
ZoneMinder logging is now more more integrated between
components and allows you to specify the destination for
logging output and the individual levels for each. This option
lets you control the level of logging output that is written to
the database. This is a new option which can make viewing
logging output easier and more intuitive and also makes it
easier to get an overall impression of how the system is
performing. If you have a large or very busy system then it is
possible that use of this option may slow your system down if
the table becomes very large. Ensure you use the
LOG_DATABASE_LIMIT option to keep the table to a manageable
size. This option controls the maximum level of logging that
will be written, so Info includes Warnings and Errors etc. To
disable entirely, set this option to None. You should use
caution when setting this option to Debug as it can affect
severely affect system performance. If you want debug you will
also need to set a level and component below
"),
type => {
db_type =>"integer",
hint =>"None=-5|Panic=-4|Fatal=-3|Error=-2|Warning=-1|Info=0|Debug=1",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "logging",
},
{
name => "ZM_LOG_DATABASE_LIMIT",
default => "7 day",
description => "Maximum number of log entries to retain",
help => qqq("
If you are using database logging then it is possible to
quickly build up a large number of entries in the Logs table.
This option allows you to specify how many of these entries are
kept. If you set this option to a number greater than zero then
that number is used to determine the maximum number of rows,
less than or equal to zero indicates no limit and is not
recommended. You can also set this value to time values such as
'<n> day' which will limit the log entries to those newer than
that time. You can specify 'hour', 'day', 'week', 'month' and
'year', note that the values should be singular (no 's' at the
end). The Logs table is pruned periodically so it is possible
for more than the expected number of rows to be present briefly
in the meantime.
"),
type => $types{string},
category => "logging",
},
{
name => "ZM_LOG_DEBUG",
default => "no",
description => "Switch debugging on",
help => qqq("
ZoneMinder components usually support debug logging available
to help with diagnosing problems. Binary components have
several levels of debug whereas more other components have only
one. Normally this is disabled to minimise performance
penalties and avoid filling logs too quickly. This option lets
you switch on other options that allow you to configure
additional debug information to be output. Components will pick
up this instruction when they are restarted.
"),
type => $types{boolean},
category => "logging",
},
{
name => "ZM_LOG_DEBUG_TARGET",
default => "",
description => "What components should have extra debug enabled",
help => qqq("
There are three scopes of debug available. Leaving this option
blank means that all components will use extra debug (not
recommended). Setting this option to '_<component>', e.g. _zmc,
will limit extra debug to that component only. Setting this
option to '_<component>_<identity>', e.g. '_zmc_m1' will limit
extra debug to that instance of the component only. This is
ordinarily what you probably want to do. To debug scripts use
their names without the .pl extension, e.g. '_zmvideo' and to
debug issues with the web interface use '_web'. You can specify
multiple targets by separating them with '|' characters.
"),
requires => [ { name => "ZM_LOG_DEBUG", value => "yes" } ],
type => $types{string},
category => "logging",
},
{
name => "ZM_LOG_DEBUG_LEVEL",
default => 1,
description => "What level of extra debug should be enabled",
help => qqq("
There are 9 levels of debug available, with higher numbers
being more debug and level 0 being no debug. However not all
levels are used by all components. Also if there is debug at a
high level it is usually likely to be output at such a volume
that it may obstruct normal operation. For this reason you
should set the level carefully and cautiously until the degree
of debug you wish to see is present. Scripts and the web
interface only have one level so this is an on/off type option
for them.
"),
requires => [ { name => "ZM_LOG_DEBUG", value => "yes" } ],
type => {
db_type =>"integer",
hint =>"1|2|3|4|5|6|7|8|9",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "logging",
},
{
name => "ZM_LOG_DEBUG_FILE",
default => "/var/log/zm/zm_debug.log+",
description => "Where extra debug is output to",
help => qqq("
This option allows you to specify a different target for debug
output. All components have a default log file which will
norally be in /tmp or /var/log and this is where debug will be
written to if this value is empty. Adding a path here will
temporarily redirect debug, and other logging output, to this
file. This option is a simple filename and you are debugging
several components then they will all try and write to the same
file with undesirable consequences. Appending a '+' to the
filename will cause the file to be created with a '.<pid>'
suffix containing your process id. In this way debug from each
run of a component is kept separate. This is the recommended
setting as it will also prevent subsequent runs from
overwriting the same log. You should ensure that permissions
are set up to allow writing to the file and directory specified
here.
"),
requires => [ { name => "ZM_LOG_DEBUG", value => "yes" } ],
type => $types{string},
category => "logging",
},
{
name => "ZM_LOG_CHECK_PERIOD",
default => "900",
description => "Time period used when calculating overall system health",
help => qqq("
When ZoneMinder is logging events to the database it can
retrospectively examine the number of warnings and errors that
have occurred to calculate an overall state of system health.
This option allows you to indicate what period of historical
events are used in this calculation. This value is expressed in
seconds and is ignored if LOG_LEVEL_DATABASE is set to None.
"),
type => $types{integer},
category => "logging",
},
{
name => "ZM_LOG_ALERT_WAR_COUNT",
default => "1",
description => "Number of warnings indicating system alert state",
help => qqq("
When ZoneMinder is logging events to the database it can
retrospectively examine the number of warnings and errors that
have occurred to calculate an overall state of system health.
This option allows you to specify how many warnings must have
occurred within the defined time period to generate an overall
system alert state. A value of zero means warnings are not
considered. This value is ignored if LOG_LEVEL_DATABASE is set
to None.
"),
type => $types{integer},
category => "logging",
},
{
name => "ZM_LOG_ALERT_ERR_COUNT",
default => "1",
description => "Number of errors indicating system alert state",
help => qqq("
When ZoneMinder is logging events to the database it can
retrospectively examine the number of warnings and errors that
have occurred to calculate an overall state of system health.
This option allows you to specify how many errors must have
occurred within the defined time period to generate an overall
system alert state. A value of zero means errors are not
considered. This value is ignored if LOG_LEVEL_DATABASE is set
to None.
"),
type => $types{integer},
category => "logging",
},
{
name => "ZM_LOG_ALERT_FAT_COUNT",
default => "0",
description => "Number of fatal error indicating system alert state",
help => qqq("
When ZoneMinder is logging events to the database it can
retrospectively examine the number of warnings and errors that
have occurred to calculate an overall state of system health.
This option allows you to specify how many fatal errors
(including panics) must have occurred within the defined time
period to generate an overall system alert state. A value of
zero means fatal errors are not considered. This value is
ignored if LOG_LEVEL_DATABASE is set to None.
"),
type => $types{integer},
category => "logging",
},
{
name => "ZM_LOG_ALARM_WAR_COUNT",
default => "100",
description => "Number of warnings indicating system alarm state",
help => qqq("
When ZoneMinder is logging events to the database it can
retrospectively examine the number of warnings and errors that
have occurred to calculate an overall state of system health.
This option allows you to specify how many warnings must have
occurred within the defined time period to generate an overall
system alarm state. A value of zero means warnings are not
considered. This value is ignored if LOG_LEVEL_DATABASE is set
to None.
"),
type => $types{integer},
category => "logging",
},
{
name => "ZM_LOG_ALARM_ERR_COUNT",
default => "10",
description => "Number of errors indicating system alarm state",
help => qqq("
When ZoneMinder is logging events to the database it can
retrospectively examine the number of warnings and errors that
have occurred to calculate an overall state of system health.
This option allows you to specify how many errors must have
occurred within the defined time period to generate an overall
system alarm state. A value of zero means errors are not
considered. This value is ignored if LOG_LEVEL_DATABASE is set
to None.
"),
type => $types{integer},
category => "logging",
},
{
name => "ZM_LOG_ALARM_FAT_COUNT",
default => "1",
description => "Number of fatal error indicating system alarm state",
help => qqq("
When ZoneMinder is logging events to the database it can
retrospectively examine the number of warnings and errors that
have occurred to calculate an overall state of system health.
This option allows you to specify how many fatal errors
(including panics) must have occurred within the defined time
period to generate an overall system alarm state. A value of
zero means fatal errors are not considered. This value is
ignored if LOG_LEVEL_DATABASE is set to None.
"),
type => $types{integer},
category => "logging",
},
{
name => "ZM_RECORD_EVENT_STATS",
default => "yes",
description => "Record event statistical information, switch off if too slow",
help => qqq("
This version of ZoneMinder records detailed information about
events in the Stats table. This can help in profiling what the
optimum settings are for Zones though this is tricky at
present. However in future releases this will be done more
easily and intuitively, especially with a large sample of
events. The default option of 'yes' allows this information to
be collected now in readiness for this but if you are concerned
about performance you can switch this off in which case no
Stats information will be saved.
"),
type => $types{boolean},
category => "logging",
},
{
name => "ZM_RECORD_DIAG_IMAGES",
default => "no",
description => "Record intermediate alarm diagnostic images, can be very slow",
help => qqq("
In addition to recording event statistics you can also record
the intermediate diagnostic images that display the results of
the various checks and processing that occur when trying to
determine if an alarm event has taken place. There are several
of these images generated for each frame and zone for each
alarm or alert frame so this can have a massive impact on
performance. Only switch this setting on for debug or analysis
purposes and remember to switch it off again once no longer
required.
"),
type => $types{boolean},
category => "logging",
},
{
name => "ZM_DUMP_CORES",
default => "no",
description => "Create core files on unexpected process failure.",
help => qqq("
When an unrecoverable error occurs in a ZoneMinder binary
process is has traditionally been trapped and the details
written to logs to aid in remote analysis. However in some
cases it is easier to diagnose the error if a core file, which
is a memory dump of the process at the time of the error, is
created. This can be interactively analysed in the debugger and
may reveal more or better information than that available from
the logs. This option is recommended for advanced users only
otherwise leave at the default. Note using this option to
trigger core files will mean that there will be no indication
in the binary logs that a process has died, they will just
stop, however the zmdc log will still contain an entry. Also
note that you may have to explicitly enable core file creation
on your system via the 'ulimit -c' command or other means
otherwise no file will be created regardless of the value of
this option.
"),
type => $types{boolean},
category => "logging",
},
{
name => "ZM_PATH_MAP",
default => "/dev/shm",
description => "Path to the mapped memory files that that ZoneMinder can use",
help => qqq("
ZoneMinder has historically used IPC shared memory for shared
data between processes. This has it's advantages and
limitations. This version of ZoneMinder can use an alternate
method, mapped memory, instead with can be enabled with the
--enable--mmap directive to configure. This requires less
system configuration and is generally more flexible. However it
requires each shared data segment to map onto a filesystem
file. This option indicates where those mapped files go. You
should ensure that this location has sufficient space for these
files and for the best performance it should be a tmpfs file
system or ramdisk otherwise disk access may render this method
slower than the regular shared memory one.
"),
type => $types{abs_path},
category => "paths",
},
{
name => "ZM_PATH_SOCKS",
default => "/var/run/zm",
description => "Path to the various Unix domain socket files that ZoneMinder uses",
help => qqq("
ZoneMinder generally uses Unix domain sockets where possible.
This reduces the need for port assignments and prevents
external applications from possibly compromising the daemons.
However each Unix socket requires a .sock file to be created.
This option indicates where those socket files go.
"),
type => $types{abs_path},
category => "paths",
},
{
name => "ZM_PATH_LOGS",
default => "/var/log/zm",
description => "Path to the various logs that the ZoneMinder daemons generate",
help => qqq("
There are various daemons that are used by ZoneMinder to
perform various tasks. Most generate helpful log files and this
is where they go. They can be deleted if not required for
debugging.
"),
type => $types{abs_path},
category => "paths",
},
{
name => "ZM_PATH_SWAP",
default => "/tmp/zm",
description => "Path to location for temporary swap images used in streaming",
help => qqq("
Buffered playback requires temporary swap images to be stored
for each instance of the streaming daemons. This option
determines where these images will be stored. The images will
actually be stored in sub directories beneath this location and
will be automatically cleaned up after a period of time.
"),
type => $types{abs_path},
category => "paths",
},
{
name => "ZM_PATH_ARP",
default => "",
description => "Path to a supported ARP tool",
help => qqq("
The camera probe function uses Address Resolution Protocol in
order to find known devices on the network. Optionally supply
the full path to \"ip neigh\", \"arp -a\", or any other tool on
your system that returns ip/mac address pairs. If this field is
left empty, ZoneMinder will search for the command \"arp\" and
attempt to use that.
"),
type => $types{abs_path},
category => "paths",
},
{
name => "ZM_WEB_TITLE_PREFIX",
default => "ZM",
description => "The title prefix displayed on each window",
help => qqq("
If you have more than one installation of ZoneMinder it can be
helpful to display different titles for each one. Changing this
option allows you to customise the window titles to include
further information to aid identification.
"),
type => $types{string},
category => "web",
},
{
name => "ZM_WEB_RESIZE_CONSOLE",
default => "yes",
description => "Should the console window resize itself to fit",
help => qqq("
Traditionally the main ZoneMinder web console window has
resized itself to shrink to a size small enough to list only
the monitors that are actually present. This is intended to
make the window more unobtrusize but may not be to everyones
tastes, especially if opened in a tab in browsers which support
this kind if layout. Switch this option off to have the console
window size left to the users preference
"),
type => $types{boolean},
category => "web",
},
{
name => "ZM_WEB_POPUP_ON_ALARM",
default => "yes",
description => "Should the monitor window jump to the top if an alarm occurs",
help => qqq("
When viewing a live monitor stream you can specify whether you
want the window to pop to the front if an alarm occurs when the
window is minimised or behind another window. This is most
useful if your monitors are over doors for example when they
can pop up if someone comes to the doorway.
"),
type => $types{boolean},
category => "web",
},
{
name => "ZM_OPT_X10",
default => "no",
description => "Support interfacing with X10 devices",
help => qqq("
If you have an X10 Home Automation setup in your home you can
use ZoneMinder to initiate or react to X10 signals if your
computer has the appropriate interface controller. This option
indicates whether X10 options will be available in the browser
client.
"),
type => $types{boolean},
category => "x10",
},
{
name => "ZM_X10_DEVICE",
default => "/dev/ttyS0",
description => "What device is your X10 controller connected on",
requires => [ { name => "ZM_OPT_X10", value => "yes" } ],
help => qqq("
If you have an X10 controller device (e.g. XM10U) connected to
your computer this option details which port it is connected on,
the default of /dev/ttyS0 maps to serial or com port 1.
"),
type => $types{abs_path},
category => "x10",
},
{
name => "ZM_X10_HOUSE_CODE",
default => "A",
description => "What X10 house code should be used",
requires => [ { name => "ZM_OPT_X10", value => "yes" } ],
help => qqq("
X10 devices are grouped together by identifying them as all
belonging to one House Code. This option details what that is.
It should be a single letter between A and P.
"),
type => { db_type=>"string", hint=>"A-P", pattern=>qr|^([A-P])|i, format=>q( uc($1) ) },
category => "x10",
},
{
name => "ZM_X10_DB_RELOAD_INTERVAL",
default => "60",
description => "How often (in seconds) the X10 daemon reloads the monitors from the database",
requires => [ { name => "ZM_OPT_X10", value => "yes" } ],
help => qqq("
The zmx10 daemon periodically checks the database to find out
what X10 events trigger, or result from, alarms. This option
determines how frequently this check occurs, unless you change
this area frequently this can be a fairly large value.
"),
type => $types{integer},
category => "x10",
},
{
name => "ZM_WEB_SOUND_ON_ALARM",
default => "no",
description => "Should the monitor window play a sound if an alarm occurs",
help => qqq("
When viewing a live monitor stream you can specify whether you
want the window to play a sound to alert you if an alarm
occurs.
"),
type => $types{boolean},
category => "web",
},
{
name => "ZM_WEB_ALARM_SOUND",
default => "",
description => "The sound to play on alarm, put this in the sounds directory",
help => qqq("
You can specify a sound file to play if an alarm occurs whilst
you are watching a live monitor stream. So long as your browser
understands the format it does not need to be any particular
type. This file should be placed in the sounds directory
defined earlier.
"),
type => $types{file},
requires => [ { name => "ZM_WEB_SOUND_ON_ALARM", value => "yes" } ],
category => "web",
},
{
name => "ZM_WEB_COMPACT_MONTAGE",
default => "no",
description => "Compact the montage view by removing extra detail",
help => qqq("
The montage view shows the output of all of your active
monitors in one window. This include a small menu and status
information for each one. This can increase the web traffic and
make the window larger than may be desired. Setting this option
on removes all this extraneous information and just displays
the images.
"),
type => $types{boolean},
category => "web",
},
{
name => "ZM_OPT_FAST_DELETE",
default => "yes",
description => "Delete only event database records for speed",
help => qqq("
Normally an event created as the result of an alarm consists of
entries in one or more database tables plus the various files
associated with it. When deleting events in the browser it can
take a long time to remove all of this if your are trying to do
a lot of events at once. It is recommended that you set this
option which means that the browser client only deletes the key
entries in the events table, which means the events will no
longer appear in the listing, and leaves the zmaudit daemon to
clear up the rest later.
"),
type => $types{boolean},
category => "system",
},
{
name => "ZM_STRICT_VIDEO_CONFIG",
default => "yes",
description => "Allow errors in setting video config to be fatal",
help => qqq("
With some video devices errors can be reported in setting the
various video attributes when in fact the operation was
successful. Switching this option off will still allow these
errors to be reported but will not cause them to kill the video
capture daemon. Note however that doing this will cause all
errors to be ignored including those which are genuine and
which may cause the video capture to not function correctly.
Use this option with caution.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_SIGNAL_CHECK_POINTS",
default => "10",
description => "How many points in a captured image to check for signal loss",
help => qqq("
For locally attached video cameras ZoneMinder can check for
signal loss by looking at a number of random points on each
captured image. If all of these points are set to the same
fixed colour then the camera is assumed to have lost signal.
When this happens any open events are closed and a short one
frame signal loss event is generated, as is another when the
signal returns. This option defines how many points on each
image to check. Note that this is a maximum, any points found
to not have the check colour will abort any further checks so
in most cases on a couple of points will actually be checked.
Network and file based cameras are never checked.
"),
type => $types{integer},
category => "config",
},
{
name => "ZM_V4L_MULTI_BUFFER",
default => "yes",
description => "Use more than one buffer for Video 4 Linux devices",
help => qqq("
Performance when using Video 4 Linux devices is usually best if
multiple buffers are used allowing the next image to be
captured while the previous one is being processed. If you have
multiple devices on a card sharing one input that requires
switching then this approach can sometimes cause frames from
one source to be mixed up with frames from another. Switching
this option off prevents multi buffering resulting in slower
but more stable image capture. This option is ignored for
non-local cameras or if only one input is present on a capture
chip. This option addresses a similar problem to the
ZM_CAPTURES_PER_FRAME option and you should normally change the
value of only one of the options at a time. If you have
different capture cards that need different values you can
ovveride them in each individual monitor on the source page.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_CAPTURES_PER_FRAME",
default => "1",
description => "How many images are captured per returned frame, for shared local cameras",
help => qqq("
If you are using cameras attached to a video capture card which
forces multiple inputs to share one capture chip, it can
sometimes produce images with interlaced frames reversed
resulting in poor image quality and a distinctive comb edge
appearance. Increasing this setting allows you to force
additional image captures before one is selected as the
captured frame. This allows the capture hardware to 'settle
down' and produce better quality images at the price of lesser
capture rates. This option has no effect on (a) network
cameras, or (b) where multiple inputs do not share a capture
chip. This option addresses a similar problem to the
ZM_V4L_MULTI_BUFFER option and you should normally change the
value of only one of the options at a time. If you have
different capture cards that need different values you can
ovveride them in each individual monitor on the source page.
"),
type => $types{integer},
category => "config",
},
{
name => "ZM_FILTER_RELOAD_DELAY",
default => "300",
description => "How often (in seconds) filters are reloaded in zmfilter",
help => qqq("
ZoneMinder allows you to save filters to the database which
allow events that match certain criteria to be emailed, deleted
or uploaded to a remote machine etc. The zmfilter daemon loads
these and does the actual operation. This option determines how
often the filters are reloaded from the database to get the
latest versions or new filters. If you don't change filters
very often this value can be set to a large value.
"),
type => $types{integer},
category => "system",
},
{
name => "ZM_FILTER_EXECUTE_INTERVAL",
default => "60",
description => "How often (in seconds) to run automatic saved filters",
help => qqq("
ZoneMinder allows you to save filters to the database which
allow events that match certain criteria to be emailed, deleted
or uploaded to a remote machine etc. The zmfilter daemon loads
these and does the actual operation. This option determines how
often the filters are executed on the saved event in the
database. If you want a rapid response to new events this
should be a smaller value, however this may increase the
overall load on the system and affect performance of other
elements.
"),
type => $types{integer},
category => "system",
},
{
name => "ZM_OPT_UPLOAD",
default => "no",
description => "Should ZoneMinder support uploading events from filters",
help => qqq("
In ZoneMinder you can create event filters that specify whether
events that match certain criteria should be uploaded to a
remote server for archiving. This option specifies whether this
functionality should be available
"),
type => $types{boolean},
category => "upload",
},
{
name => "ZM_UPLOAD_ARCH_FORMAT",
default => "tar",
description => "What format the uploaded events should be created in.",
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
help => qqq("
Uploaded events may be stored in either .tar or .zip format,
this option specifies which. Note that to use this you will
need to have the Archive::Tar and/or Archive::Zip perl modules
installed.
"),
type => {
db_type =>"string",
hint =>"tar|zip",
pattern =>qr|^([tz])|i,
format =>q( $1 =~ /^t/ ? "tar" : "zip" )
},
category => "upload",
},
{
name => "ZM_UPLOAD_ARCH_COMPRESS",
default => "no",
description => "Should archive files be compressed",
help => qqq("
When the archive files are created they can be compressed.
However in general since the images are compressed already this
saves only a minimal amount of space versus utilising more CPU
in their creation. Only enable if you have CPU to waste and are
limited in disk space on your remote server or bandwidth.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{boolean},
category => "upload",
},
{
name => "ZM_UPLOAD_ARCH_ANALYSE",
default => "no",
description => "Include the analysis files in the archive",
help => qqq("
When the archive files are created they can contain either just
the captured frames or both the captured frames and, for frames
that caused an alarm, the analysed image with the changed area
highlighted. This option controls files are included. Only
include analysed frames if you have a high bandwidth connection
to the remote server or if you need help in figuring out what
caused an alarm in the first place as archives with these files
in can be considerably larger.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{boolean},
category => "upload",
},
{
name => "ZM_UPLOAD_PROTOCOL",
default => "ftp",
description => "What protocol to use to upload events",
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
help => qqq("
ZoneMinder can upload events to a remote server using either
FTP or SFTP. Regular FTP is widely supported but not
necessarily very secure whereas SFTP (Secure FTP) runs over an
ssh connection and so is encrypted and uses regular ssh ports.
Note that to use this you will need to have the appropriate
perl module, either Net::FTP or Net::SFTP installed depending
on your choice.
"),
type => {
db_type =>"string",
hint =>"ftp|sftp",
pattern =>qr|^([tz])|i,
format =>q( $1 =~ /^f/ ? "ftp" : "sftp" )
},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_HOST",
default => "",
description => "The remote server to upload to",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. This option indicates the name, or ip
address, of the server to use.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{hostname},
category => "hidden",
},
{
name => "ZM_UPLOAD_HOST",
default => "",
description => "The remote server to upload events to",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. This option indicates the name, or ip address,
of the server to use.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{hostname},
category => "upload",
},
{
name => "ZM_UPLOAD_PORT",
default => "",
description => "The port on the remote upload server, if not the default (SFTP only)",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. If you are using the SFTP protocol then this
option allows you to specify a particular port to use for
connection. If this option is left blank then the default, port
22, is used. This option is ignored for FTP uploads.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{integer},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_USER",
default => "",
description => "Your ftp username",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. This option indicates the username that
ZoneMinder should use to log in for ftp transfer.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{alphanum},
category => "hidden",
},
{
name => "ZM_UPLOAD_USER",
default => "",
description => "Remote server username",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. This option indicates the username that
ZoneMinder should use to log in for transfer.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{alphanum},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_PASS",
default => "",
description => "Your ftp password",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. This option indicates the password that
ZoneMinder should use to log in for ftp transfer.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{string},
category => "hidden",
},
{
name => "ZM_UPLOAD_PASS",
default => "",
description => "Remote server password",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. This option indicates the password that
ZoneMinder should use to log in for transfer. If you are using
certificate based logins for SFTP servers you can leave this
option blank.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{string},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_LOC_DIR",
default => "/tmp/zm",
description => "The local directory in which to create upload files",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. This option indicates the local directory
that ZoneMinder should use for temporary upload files. These
are files that are created from events, uploaded and then
deleted.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{abs_path},
category => "hidden",
},
{
name => "ZM_UPLOAD_LOC_DIR",
default => "/tmp/zm",
description => "The local directory in which to create upload files",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. This option indicates the local directory that
ZoneMinder should use for temporary upload files. These are
files that are created from events, uploaded and then deleted.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{abs_path},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_REM_DIR",
default => "",
description => "The remote directory to upload to",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. This option indicates the remote directory
that ZoneMinder should use to upload event files to.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{rel_path},
category => "hidden",
},
{
name => "ZM_UPLOAD_REM_DIR",
default => "",
description => "The remote directory to upload to",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. This option indicates the remote directory
that ZoneMinder should use to upload event files to.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{rel_path},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_TIMEOUT",
default => "120",
description => "How long to allow the transfer to take for each file",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. This option indicates the maximum ftp
inactivity timeout (in seconds) that should be tolerated before
ZoneMinder determines that the transfer has failed and closes
down the connection.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{integer},
category => "hidden",
},
{
name => "ZM_UPLOAD_TIMEOUT",
default => "120",
description => "How long to allow the transfer to take for each file",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. This option indicates the maximum inactivity
timeout (in seconds) that should be tolerated before ZoneMinder
determines that the transfer has failed and closes down the
connection.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{integer},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_PASSIVE",
default => "yes",
description => "Use passive ftp when uploading",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. This option indicates that ftp transfers
should be done in passive mode. This uses a single connection
for all ftp activity and, whilst slower than active transfers,
is more robust and likely to work from behind filewalls. This
option is ignored for SFTP transfers.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
help => qqq("
If your computer is behind a firewall or proxy you may need to
set FTP to passive mode. In fact for simple transfers it makes
little sense to do otherwise anyway but you can set this to
'No' if you wish.
"),
type => $types{boolean},
category => "upload",
},
{
name => "ZM_UPLOAD_FTP_DEBUG",
default => "no",
description => "Switch ftp debugging on",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote ftp server. If you are having (or expecting) troubles
with uploading events then setting this to 'yes' permits
additional information to be included in the zmfilter log file.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{boolean},
category => "hidden",
},
{
name => "ZM_UPLOAD_DEBUG",
default => "no",
description => "Switch upload debugging on",
help => qqq("
You can use filters to instruct ZoneMinder to upload events to
a remote server. If you are having (or expecting) troubles with
uploading events then setting this to 'yes' permits additional
information to be generated by the underlying transfer modules
and included in the logs.
"),
requires => [ { name => "ZM_OPT_UPLOAD", value => "yes" } ],
type => $types{boolean},
category => "upload",
},
{
name => "ZM_OPT_EMAIL",
default => "no",
description => "Should ZoneMinder email you details of events that match corresponding filters",
help => qqq("
In ZoneMinder you can create event filters that specify whether
events that match certain criteria should have their details
emailed to you at a designated email address. This will allow
you to be notified of events as soon as they occur and also to
quickly view the events directly. This option specifies whether
this functionality should be available. The email created with
this option can be any size and is intended to be sent to a
regular email reader rather than a mobile device.
"),
type => $types{boolean},
category => "mail",
},
{
name => "ZM_EMAIL_ADDRESS",
default => "",
description => "The email address to send matching event details to",
requires => [ { name => "ZM_OPT_EMAIL", value => "yes" } ],
help => qqq("
This option is used to define the email address that any events
that match the appropriate filters will be sent to.
"),
type => $types{email},
category => "mail",
},
{
name => "ZM_EMAIL_TEXT",
default => 'subject = "ZoneMinder: Alarm - %MN%-%EI% (%ESM% - %ESA% %EFA%)"
body = "
Hello,
An alarm has been detected on your installation of the ZoneMinder.
The details are as follows :-
Monitor : %MN%
Event Id : %EI%
Length : %EL%
Frames : %EF% (%EFA%)
Scores : t%EST% m%ESM% a%ESA%
This alarm was matched by the %FN% filter and can be viewed at %EPS%
ZoneMinder"',
description => "The text of the email used to send matching event details",
requires => [ { name => "ZM_OPT_EMAIL", value => "yes" } ],
help => qqq("
This option is used to define the content of the email that is
sent for any events that match the appropriate filters.
"),
type => $types{text},
category => "hidden",
},
{
name => "ZM_EMAIL_SUBJECT",
default => "ZoneMinder: Alarm - %MN%-%EI% (%ESM% - %ESA% %EFA%)",
description => "The subject of the email used to send matching event details",
requires => [ { name => "ZM_OPT_EMAIL", value => "yes" } ],
help => qqq("
This option is used to define the subject of the email that is
sent for any events that match the appropriate filters.
"),
type => $types{string},
category => "mail",
},
{
name => "ZM_EMAIL_BODY",
default => "
Hello,
An alarm has been detected on your installation of the ZoneMinder.
The details are as follows :-
Monitor : %MN%
Event Id : %EI%
Length : %EL%
Frames : %EF% (%EFA%)
Scores : t%EST% m%ESM% a%ESA%
This alarm was matched by the %FN% filter and can be viewed at %EPS%
ZoneMinder",
description => "The body of the email used to send matching event details",
requires => [ { name => "ZM_OPT_EMAIL", value => "yes" } ],
help => qqq("
This option is used to define the content of the email that is
sent for any events that match the appropriate filters.
"),
type => $types{text},
category => "mail",
},
{
name => "ZM_OPT_MESSAGE",
default => "no",
description => "Should ZoneMinder message you with details of events that match corresponding filters",
help => qqq("
In ZoneMinder you can create event filters that specify whether
events that match certain criteria should have their details
sent to you at a designated short message email address. This
will allow you to be notified of events as soon as they occur.
This option specifies whether this functionality should be
available. The email created by this option will be brief and
is intended to be sent to an SMS gateway or a minimal mail
reader such as a mobile device or phone rather than a regular
email reader.
"),
type => $types{boolean},
category => "mail",
},
{
name => "ZM_MESSAGE_ADDRESS",
default => "",
description => "The email address to send matching event details to",
requires => [ { name => "ZM_OPT_MESSAGE", value => "yes" } ],
help => qqq("
This option is used to define the short message email address
that any events that match the appropriate filters will be sent
to.
"),
type => $types{email},
category => "mail",
},
{
name => "ZM_MESSAGE_TEXT",
default => 'subject = "ZoneMinder: Alarm - %MN%-%EI%"
body = "ZM alarm detected - %EL% secs, %EF%/%EFA% frames, t%EST%/m%ESM%/a%ESA% score."',
description => "The text of the message used to send matching event details",
requires => [ { name => "ZM_OPT_MESSAGE", value => "yes" } ],
help => qqq("
This option is used to define the content of the message that
is sent for any events that match the appropriate filters.
"),
type => $types{text},
category => "hidden",
},
{
name => "ZM_MESSAGE_SUBJECT",
default => "ZoneMinder: Alarm - %MN%-%EI%",
description => "The subject of the message used to send matching event details",
requires => [ { name => "ZM_OPT_MESSAGE", value => "yes" } ],
help => qqq("
This option is used to define the subject of the message that
is sent for any events that match the appropriate filters.
"),
type => $types{string},
category => "mail",
},
{
name => "ZM_MESSAGE_BODY",
default => "ZM alarm detected - %EL% secs, %EF%/%EFA% frames, t%EST%/m%ESM%/a%ESA% score.",
description => "The body of the message used to send matching event details",
requires => [ { name => "ZM_OPT_MESSAGE", value => "yes" } ],
help => qqq("
This option is used to define the content of the message that
is sent for any events that match the appropriate filters.
"),
type => $types{text},
category => "mail",
},
{
name => "ZM_NEW_MAIL_MODULES",
default => "no",
description => "Use a newer perl method to send emails",
requires => [
{ name => "ZM_OPT_EMAIL", value => "yes" },
{ name => "ZM_OPT_MESSAGE", value => "yes" }
],
help => qqq("
Traditionally ZoneMinder has used the MIME::Entity perl module
to construct and send notification emails and messages. Some
people have reported problems with this module not being
present at all or flexible enough for their needs. If you are
one of those people this option allows you to select a new
mailing method using MIME::Lite and Net::SMTP instead. This
method was contributed by Ross Melin and should work for
everyone but has not been extensively tested so currently is
not selected by default.
"),
type => $types{boolean},
category => "mail",
},
{
name => "ZM_EMAIL_HOST",
default => "localhost",
description => "The host address of your SMTP mail server",
requires => [
{ name => "ZM_OPT_EMAIL", value => "yes" },
{ name => "ZM_OPT_MESSAGE", value => "yes" }
],
help => qqq("
If you have chosen SMTP as the method by which to send
notification emails or messages then this option allows you to
choose which SMTP server to use to send them. The default of
localhost may work if you have the sendmail, exim or a similar
daemon running however you may wish to enter your ISP's SMTP
mail server here.
"),
type => $types{hostname},
category => "mail",
},
{
name => "ZM_FROM_EMAIL",
default => "",
description => "The email address you wish your event notifications to originate from",
requires => [
{ name => "ZM_OPT_EMAIL", value => "yes" },
{ name => "ZM_OPT_MESSAGE", value => "yes" }
],
help => qqq("
The emails or messages that will be sent to you informing you
of events can appear to come from a designated email address to
help you with mail filtering etc. An address of something like
ZoneMinder\@your.domain is recommended.
"),
type => $types{email},
category => "mail",
},
{
name => "ZM_URL",
default => "",
description => "The URL of your ZoneMinder installation",
requires => [
{ name => "ZM_OPT_EMAIL", value => "yes" },
{ name => "ZM_OPT_MESSAGE", value => "yes" }
],
help => qqq("
The emails or messages that will be sent to you informing you
of events can include a link to the events themselves for easy
viewing. If you intend to use this feature then set this option
to the url of your installation as it would appear from where
you read your email, e.g. http://host.your.domain/zm.php.
"),
type => $types{url},
category => "mail",
},
{
name => "ZM_MAX_RESTART_DELAY",
default => "600",
description => "Maximum delay (in seconds) for daemon restart attempts.",
help => qqq("
The zmdc (zm daemon control) process controls when processeses
are started or stopped and will attempt to restart any that
fail. If a daemon fails frequently then a delay is introduced
between each restart attempt. If the daemon stills fails then
this delay is increased to prevent extra load being placed on
the system by continual restarts. This option controls what
this maximum delay is.
"),
type => $types{integer},
category => "system",
},
{
name => "ZM_WATCH_CHECK_INTERVAL",
default => "10",
description => "How often to check the capture daemons have not locked up",
help => qqq("
The zmwatch daemon checks the image capture performance of the
capture daemons to ensure that they have not locked up (rarely
a sync error may occur which blocks indefinitely). This option
determines how often the daemons are checked.
"),
type => $types{integer},
category => "system",
},
{
name => "ZM_WATCH_MAX_DELAY",
default => "5",
description => "The maximum delay allowed since the last captured image",
help => qqq("
The zmwatch daemon checks the image capture performance of the
capture daemons to ensure that they have not locked up (rarely
a sync error may occur which blocks indefinitely). This option
determines the maximum delay to allow since the last captured
frame. The daemon will be restarted if it has not captured any
images after this period though the actual restart may take
slightly longer in conjunction with the check interval value
above.
"),
type => $types{decimal},
category => "system",
},
{
name => "ZM_RUN_AUDIT",
default => "yes",
description => "Run zmaudit to check data consistency",
help => qqq("
The zmaudit daemon exists to check that the saved information
in the database and on the filesystem match and are consistent
with each other. If an error occurs or if you are using 'fast
deletes' it may be that database records are deleted but files
remain. In this case, and similar, zmaudit will remove
redundant information to synchronise the two data stores. This
option controls whether zmaudit is run in the background and
performs these checks and fixes continuously. This is
recommended for most systems however if you have a very large
number of events the process of scanning the database and
filesystem may take a long time and impact performance. In this
case you may prefer to not have zmaudit running unconditionally
and schedule occasional checks at other, more convenient,
times.
"),
type => $types{boolean},
category => "system",
},
{
name => "ZM_AUDIT_CHECK_INTERVAL",
default => "900",
description => "How often to check database and filesystem consistency",
help => qqq("
The zmaudit daemon exists to check that the saved information
in the database and on the filesystem match and are consistent
with each other. If an error occurs or if you are using 'fast
deletes' it may be that database records are deleted but files
remain. In this case, and similar, zmaudit will remove
redundant information to synchronise the two data stores. The
default check interval of 900 seconds (15 minutes) is fine for
most systems however if you have a very large number of events
the process of scanning the database and filesystem may take a
long time and impact performance. In this case you may prefer
to make this interval much larger to reduce the impact on your
system. This option determines how often these checks are
performed.
"),
type => $types{integer},
category => "system",
},
{
name => "ZM_AUDIT_MIN_AGE",
default => "86400",
description => "The minimum age in seconds event data must be in order to be deleted.",
help => qqq("
The zmaudit daemon exists to check that the saved information
in the database and on the filesystem match and are consistent
with each other. Event files or db records that are younger than
this setting will not be deleted and a warning will be given.
"),
type => $types{integer},
category => "system",
},
{
name => "ZM_FORCED_ALARM_SCORE",
default => "255",
description => "Score to give forced alarms",
help => qqq("
The 'zmu' utility can be used to force an alarm on a monitor
rather than rely on the motion detection algorithms. This
option determines what score to give these alarms to
distinguish them from regular ones. It must be 255 or less.
"),
type => $types{integer},
category => "config",
},
{
name => "ZM_BULK_FRAME_INTERVAL",
default => "100",
description => "How often a bulk frame should be written to the database",
help => qqq("
Traditionally ZoneMinder writes an entry into the Frames
database table for each frame that is captured and saved. This
works well in motion detection scenarios but when in a DVR
situation ('Record' or 'Mocord' mode) this results in a huge
number of frame writes and a lot of database and disk bandwidth
for very little additional information. Setting this to a
non-zero value will enabled ZoneMinder to group these non-alarm
frames into one 'bulk' frame entry which saves a lot of
bandwidth and space. The only disadvantage of this is that
timing information for individual frames is lost but in
constant frame rate situations this is usually not significant.
This setting is ignored in Modect mode and individual frames
are still written if an alarm occurs in Mocord mode also.
"),
type => $types{integer},
category => "config",
},
{
name => "ZM_EVENT_CLOSE_MODE",
default => "idle",
description => "When continuous events are closed.",
help => qqq("
When a monitor is running in a continuous recording mode
(Record or Mocord) events are usually closed after a fixed
period of time (the section length). However in Mocord mode it
is possible that motion detection may occur near the end of a
section. This option controls what happens when an alarm occurs
in Mocord mode. The 'time' setting means that the event will be
closed at the end of the section regardless of alarm activity.
The 'idle' setting means that the event will be closed at the
end of the section if there is no alarm activity occurring at
the time otherwise it will be closed once the alarm is over
meaning the event may end up being longer than the normal
section length. The 'alarm' setting means that if an alarm
occurs during the event, the event will be closed once the
alarm is over regardless of when this occurs. This has the
effect of limiting the number of alarms to one per event and
the events will be shorter than the section length if an alarm
has occurred.
"),
type => $types{boolean},
type => {
db_type =>"string",
hint =>"time|idle|alarm",
pattern =>qr|^([tia])|i,
format =>q( ($1 =~ /^t/)
? "time"
: ($1 =~ /^i/ ? "idle" : "time" )
)
},
category => "config",
},
# Deprecated, superseded by event close mode
{
name => "ZM_FORCE_CLOSE_EVENTS",
default => "no",
description => "Close events at section ends.",
help => qqq("
When a monitor is running in a continuous recording mode
(Record or Mocord) events are usually closed after a fixed
period of time (the section length). However in Mocord mode it
is possible that motion detection may occur near the end of a
section and ordinarily this will prevent the event being closed
until the motion has ceased. Switching this option on will
force the event closed at the specified time regardless of any
motion activity.
"),
type => $types{boolean},
category => "hidden",
},
{
name => "ZM_CREATE_ANALYSIS_IMAGES",
default => "yes",
description => "Create analysed alarm images with motion outlined",
help => qqq("
By default during an alarm ZoneMinder records both the raw
captured image and one that has been analysed and had areas
where motion was detected outlined. This can be very useful
during zone configuration or in analysing why events occurred.
However it also incurs some overhead and in a stable system may
no longer be necessary. This parameter allows you to switch the
generation of these images off.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_WEIGHTED_ALARM_CENTRES",
default => "no",
description => "Use a weighted algorithm to calculate the centre of an alarm",
help => qqq("
ZoneMinder will always calculate the centre point of an alarm
in a zone to give some indication of where on the screen it is.
This can be used by the experimental motion tracking feature or
your own custom extensions. In the alarmed or filtered pixels
mode this is a simple midpoint between the extents of the
detected pxiesl. However in the blob method this can instead be
calculated using weighted pixel locations to give more accurate
positioning for irregularly shaped blobs. This method, while
more precise is also slower and so is turned off by default.
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_EVENT_IMAGE_DIGITS",
default => "5",
description => "How many significant digits are used in event image numbering",
help => qqq("
As event images are captured they are stored to the filesystem
with a numerical index. By default this index has three digits
so the numbers start 001, 002 etc. This works works for most
scenarios as events with more than 999 frames are rarely
captured. However if you have extremely long events and use
external applications then you may wish to increase this to
ensure correct sorting of images in listings etc. Warning,
increasing this value on a live system may render existing
events unviewable as the event will have been saved with the
previous scheme. Decreasing this value should have no ill
effects.
"),
type => $types{integer},
category => "config",
},
{
name => "ZM_DEFAULT_ASPECT_RATIO",
default => "4:3",
description => "The default width:height aspect ratio used in monitors",
help => qqq("
When specifying the dimensions of monitors you can click a
checkbox to ensure that the width stays in the correct ratio to
the height, or vice versa. This setting allows you to indicate
what the ratio of these settings should be. This should be
specified in the format <width value>:<height value> and the
default of 4:3 normally be acceptable but 11:9 is another
common setting. If the checkbox is not clicked when specifying
monitor dimensions this setting has no effect.
"),
type => $types{string},
category => "config",
},
{
name => "ZM_USER_SELF_EDIT",
default => "no",
description => "Allow unprivileged users to change their details",
help => qqq("
Ordinarily only users with system edit privilege are able to
change users details. Switching this option on allows ordinary
users to change their passwords and their language settings
"),
type => $types{boolean},
category => "config",
},
{
name => "ZM_OPT_FRAME_SERVER",
default => "no",
description => "Should analysis farm out the writing of images to disk",
#requires => [ { name => "ZM_OPT_ADAPTIVE_SKIP", value => "yes" } ],
help => qqq("
In some circumstances it is possible for a slow disk to take so
long writing images to disk that it causes the analysis daemon
to fall behind especially during high frame rate events.
Setting this option to yes enables a frame server daemon (zmf)
which will be sent the images from the analysis daemon and will
do the actual writing of images itself freeing up the analysis
daemon to get on with other things. Should this transmission
fail or other permanent or transient error occur, this function
will fall back to the analysis daemon.
"),
type => $types{boolean},
category => "system",
},
{
name => "ZM_FRAME_SOCKET_SIZE",
default => "0",
description => "Specify the frame server socket buffer size if non-standard",
requires => [ { name => "ZM_OPT_FRAME_SERVER", value => "yes" } ],
help => qqq("
For large captured images it is possible for the writes from
the analysis daemon to the frame server to fail as the amount
to be written exceeds the default buffer size. While the images
are then written by the analysis daemon so no data is lost, it
defeats the object of the frame server daemon in the first
place. You can use this option to indicate that a larger buffer
size should be used. Note that you may have to change the
existing maximum socket buffer size on your system via sysctl
(or in /proc/sys/net/core/wmem_max) to allow this new size to
be set. Alternatively you can change the default buffer size on
your system in the same way in which case that will be used
with no change necessary in this option
"),
type => $types{integer},
category => "system",
},
{
name => "ZM_OPT_CONTROL",
default => "no",
description => "Support controllable (e.g. PTZ) cameras",
help => qqq("
ZoneMinder includes limited support for controllable cameras. A
number of sample protocols are included and others can easily
be added. If you wish to control your cameras via ZoneMinder
then select this option otherwise if you only have static
cameras or use other control methods then leave this option
off.
"),
type => $types{boolean},
category => "system",
},
{
name => "ZM_OPT_TRIGGERS",
default => "no",
description => "Interface external event triggers via socket or device files",
help => qqq("
ZoneMinder can interact with external systems which prompt or
cancel alarms. This is done via the zmtrigger.pl script. This
option indicates whether you want to use these external
triggers. Most people will say no here.
"),
type => $types{boolean},
category => "system",
},
{
name => "ZM_CHECK_FOR_UPDATES",
default => "no",
description => "Check with zoneminder.com for updated versions",
help => qqq("
From ZoneMinder version 1.17.0 onwards new versions are
expected to be more frequent. To save checking manually for
each new version ZoneMinder can check with the zoneminder.com
website to determine the most recent release. These checks are
infrequent, about once per week, and no personal or system
information is transmitted other than your current version
number. If you do not wish these checks to take place or your
ZoneMinder system has no internet access you can switch these
check off with this configuration variable
"),
type => $types{boolean},
category => "system",
},
{
name => "ZM_UPDATE_CHECK_PROXY",
default => "",
description => "Proxy url if required to access zoneminder.com",
help => qqq("
If you use a proxy to access the internet then ZoneMinder needs
to know so it can access zoneminder.com to check for updates.
If you do use a proxy enter the full proxy url here in the form
of http://<proxy host>:<proxy port>/
"),
type => $types{string},
category => "system",
},
{
name => "ZM_SHM_KEY",
default => "0x7a6d0000",
description => "Shared memory root key to use",
help => qqq("
ZoneMinder uses shared memory to speed up communication between
modules. To identify the right area to use shared memory keys
are used. This option controls what the base key is, each
monitor will have it's Id or'ed with this to get the actual key
used. You will not normally need to change this value unless it
clashes with another instance of ZoneMinder on the same
machine. Only the first four hex digits are used, the lower
four will be masked out and ignored.
"),
type => $types{hexadecimal},
category => "system",
},
# Deprecated, really no longer necessary
{
name => "ZM_WEB_REFRESH_METHOD",
default => "javascript",
description => "What method windows should use to refresh themselves",
help => qqq("
Many windows in Javascript need to refresh themselves to keep
their information current. This option determines what method
they should use to do this. Choosing 'javascript' means that
each window will have a short JavaScript statement in with a
timer to prompt the refresh. This is the most compatible
method. Choosing 'http' means the refresh instruction is put in
the HTTP header. This is a cleaner method but refreshes are
interrupted or cancelled when a link in the window is clicked
meaning that the window will no longer refresh and this would
have to be done manually.
"),
type => {
db_type =>"string",
hint =>"javascript|http",
pattern =>qr|^([jh])|i,
format =>q( $1 =~ /^j/
? "javascript"
: "http"
)
},
category => "hidden",
},
{
name => "ZM_WEB_EVENT_SORT_FIELD",
default => "DateTime",
description => "Default field the event lists are sorted by",
help => qqq("
Events in lists can be initially ordered in any way you want.
This option controls what field is used to sort them. You can
modify this ordering from filters or by clicking on headings in
the lists themselves. Bear in mind however that the 'Prev' and
'Next' links, when scrolling through events, relate to the
ordering in the lists and so not always to time based ordering.
"),
type => {
db_type =>"string",
hint =>"Id|Name|Cause|MonitorName|DateTime|Length|Frames|AlarmFrames|TotScore|AvgScore|MaxScore",
pattern =>qr|.|,
format =>q( $1 )
},
category => "web",
},
{
name => "ZM_WEB_EVENT_SORT_ORDER",
default => "asc",
description => "Default order the event lists are sorted by",
help => qqq("
Events in lists can be initially ordered in any way you want.
This option controls what order (ascending or descending) is
used to sort them. You can modify this ordering from filters or
by clicking on headings in the lists themselves. Bear in mind
however that the 'Prev' and 'Next' links, when scrolling
through events, relate to the ordering in the lists and so not
always to time based ordering.
"),
type => {
db_type =>"string",
hint =>"asc|desc",
pattern =>qr|^([ad])|i,
format =>q( $1 =~ /^a/i ? "asc" : "desc" )
},
category => "web",
},
{
name => "ZM_WEB_EVENTS_PER_PAGE",
default => "25",
description => "How many events to list per page in paged mode",
help => qqq("
In the event list view you can either list all events or just a
page at a time. This option controls how many events are listed
per page in paged mode and how often to repeat the column
headers in non-paged mode.
"),
type => $types{integer},
category => "web",
},
{
name => "ZM_WEB_LIST_THUMBS",
default => "no",
description => "Display mini-thumbnails of event images in event lists",
help => qqq("
Ordinarily the event lists just display text details of the
events to save space and time. By switching this option on you
can also display small thumbnails to help you identify events
of interest. The size of these thumbnails is controlled by the
following two options.
"),
type => $types{boolean},
category => "web",
},
{
name => "ZM_WEB_LIST_THUMB_WIDTH",
default => "48",
description => "The width of the thumbnails that appear in the event lists",
help => qqq("
This options controls the width of the thumbnail images that
appear in the event lists. It should be fairly small to fit in
with the rest of the table. If you prefer you can specify a
height instead in the next option but you should only use one
of the width or height and the other option should be set to
zero. If both width and height are specified then width will be
used and height ignored.
"),
type => $types{integer},
requires => [ { name => "ZM_WEB_LIST_THUMBS", value => "yes" } ],
category => "web",
},
{
name => "ZM_WEB_LIST_THUMB_HEIGHT",
default => "0",
description => "The height of the thumbnails that appear in the event lists",
help => qqq("
This options controls the height of the thumbnail images that
appear in the event lists. It should be fairly small to fit in
with the rest of the table. If you prefer you can specify a
width instead in the previous option but you should only use
one of the width or height and the other option should be set
to zero. If both width and height are specified then width will
be used and height ignored.
"),
type => $types{integer},
requires => [ { name => "ZM_WEB_LIST_THUMBS", value => "yes" } ],
category => "web",
},
{
name => "ZM_WEB_USE_OBJECT_TAGS",
default => "yes",
description => "Wrap embed in object tags for media content",
help => qqq("
There are two methods of including media content in web pages.
The most common way is use the EMBED tag which is able to give
some indication of the type of content. However this is not a
standard part of HTML. The official method is to use OBJECT
tags which are able to give more information allowing the
correct media viewers etc to be loaded. However these are less
widely supported and content may be specifically tailored to a
particular platform or player. This option controls whether
media content is enclosed in EMBED tags only or whether, where
appropriate, it is additionally wrapped in OBJECT tags.
Currently OBJECT tags are only used in a limited number of
circumstances but they may become more widespread in the
future. It is suggested that you leave this option on unless
you encounter problems playing some content.
"),
type => $types{boolean},
category => "web",
},
{
name => "ZM_WEB_H_REFRESH_MAIN",
default => "60",
introduction => qqq("
There are now a number of options that are grouped into
bandwidth categories, this allows you to configure the
ZoneMinder client to work optimally over the various access
methods you might to access the client.\n\nThe next few options
control what happens when the client is running in 'high'
bandwidth mode. You should set these options for when accessing
the ZoneMinder client over a local network or high speed link.
In most cases the default values will be suitable as a starting
point.
"),
description => "How often (in seconds) the main console window should refresh itself",
help => qqq("
The main console window lists a general status and the event
totals for all monitors. This is not a trivial task and should
not be repeated too frequently or it may affect the performance
of the rest of the system.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_H_REFRESH_CYCLE",
default => "10",
description => "How often (in seconds) the cycle watch window swaps to the next monitor",
help => qqq("
The cycle watch window is a method of continuously cycling
between images from all of your monitors. This option
determines how often to refresh with a new image.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_H_REFRESH_IMAGE",
default => "3",
description => "How often (in seconds) the watched image is refreshed (if not streaming)",
help => qqq("
The live images from a monitor can be viewed in either streamed
or stills mode. This option determines how often a stills image
is refreshed, it has no effect if streaming is selected.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_H_REFRESH_STATUS",
default => "1",
description => "How often (in seconds) the status refreshes itself in the watch window",
help => qqq("
The monitor window is actually made from several frames. The
one in the middle merely contains a monitor status which needs
to refresh fairly frequently to give a true indication. This
option determines that frequency.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_H_REFRESH_EVENTS",
default => "5",
description => "How often (in seconds) the event listing is refreshed in the watch window",
help => qqq("
The monitor window is actually made from several frames. The
lower framme contains a listing of the last few events for easy
access. This option determines how often this is refreshed.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_H_CAN_STREAM",
default => "auto",
description => "Override the automatic detection of browser streaming capability",
help => qqq("
If you know that your browser can handle image streams of the
type 'multipart/x-mixed-replace' but ZoneMinder does not detect
this correctly you can set this option to ensure that the
stream is delivered with or without the use of the Cambozola
plugin. Selecting 'yes' will tell ZoneMinder that your browser
can handle the streams natively, 'no' means that it can't and
so the plugin will be used while 'auto' lets ZoneMinder decide.
"),
type => $types{tristate},
category => "highband",
},
{
name => "ZM_WEB_H_STREAM_METHOD",
default => "jpeg",
description => "Which method should be used to send video streams to your browser.",
help => qqq("
ZoneMinder can be configured to use either mpeg encoded video
or a series or still jpeg images when sending video streams.
This option defines which is used. If you choose mpeg you
should ensure that you have the appropriate plugins available
on your browser whereas choosing jpeg will work natively on
Mozilla and related browsers and with a Java applet on Internet
Explorer
"),
type => {
db_type =>"string",
hint =>"mpeg|jpeg",
pattern =>qr|^([mj])|i,
format =>q( $1 =~ /^m/ ? "mpeg" : "jpeg" )
},
category => "highband",
},
{
name => "ZM_WEB_H_DEFAULT_SCALE",
default => "100",
description => "What the default scaling factor applied to 'live' or 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'live' or 'event' streams in
their native size. However if you have monitors with large
dimensions or a slow link you may prefer to reduce this size,
alternatively for small monitors you can enlarge it. This
options lets you specify what the default scaling factor will
be. It is expressed as a percentage so 100 is normal size, 200
is double size etc.
"),
type => {
db_type =>"integer",
hint =>"25|33|50|75|100|150|200|300|400",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "highband",
},
{
name => "ZM_WEB_H_DEFAULT_RATE",
default => "100",
description => "What the default replay rate factor applied to 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'event' streams at their
native rate, i.e. as close to real-time as possible. However if
you have long events it is often convenient to replay them at a
faster rate for review. This option lets you specify what the
default replay rate will be. It is expressed as a percentage so
100 is normal rate, 200 is double speed etc.
"),
type => {
db_type =>"integer",
hint =>"25|50|100|150|200|400|1000|2500|5000|10000",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "highband",
},
{
name => "ZM_WEB_H_VIDEO_BITRATE",
default => "150000",
description => "What the bitrate of the video encoded stream should be set to",
help => qqq("
When encoding real video via the ffmpeg library a bit rate can
be specified which roughly corresponds to the available
bandwidth used for the stream. This setting effectively
corresponds to a 'quality' setting for the video. A low value
will result in a blocky image whereas a high value will produce
a clearer view. Note that this setting does not control the
frame rate of the video however the quality of the video
produced is affected both by this setting and the frame rate
that the video is produced at. A higher frame rate at a
particular bit rate result in individual frames being at a
lower quality.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_H_VIDEO_MAXFPS",
default => "30",
description => "What the maximum frame rate for streamed video should be",
help => qqq("
When using streamed video the main control is the bitrate which
determines how much data can be transmitted. However a lower
bitrate at high frame rates results in a lower quality image.
This option allows you to limit the maximum frame rate to
ensure that video quality is maintained. An additional
advantage is that encoding video at high frame rates is a
processor intensive task when for the most part a very high
frame rate offers little perceptible improvement over one that
has a more manageable resource requirement. Note, this option
is implemented as a cap beyond which binary reduction takes
place. So if you have a device capturing at 15fps and set this
option to 10fps then the video is not produced at 10fps, but
rather at 7.5fps (15 divided by 2) as the final frame rate must
be the original divided by a power of 2.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_H_SCALE_THUMBS",
default => "no",
description => "Scale thumbnails in events, bandwidth versus cpu in rescaling",
help => qqq("
If unset, this option sends the whole image to the browser
which resizes it in the window. If set the image is scaled down
on the server before sending a reduced size image to the
browser to conserve bandwidth at the cost of cpu on the server.
Note that ZM can only perform the resizing if the appropriate
PHP graphics functionality is installed. This is usually
available in the php-gd package.
"),
type => $types{boolean},
category => "highband",
},
{
name => "ZM_WEB_H_EVENTS_VIEW",
default => "events",
description => "What the default view of multiple events should be.",
help => qqq("
Stored events can be viewed in either an events list format or
in a timeline based one. This option sets the default view that
will be used. Choosing one view here does not prevent the other
view being used as it will always be selectable from whichever
view is currently being used.
"),
type => {
db_type =>"string",
hint =>"events|timeline",
pattern =>qr|^([lt])|i,
format =>q( $1 =~ /^e/ ? "events" : "timeline" )
},
category => "highband",
},
{
name => "ZM_WEB_H_SHOW_PROGRESS",
default => "yes",
description => "Show the progress of replay in event view.",
help => qqq("
When viewing events an event navigation panel and progress bar
is shown below the event itself. This allows you to jump to
specific points in the event, but can can also dynamically
update to display the current progress of the event replay
itself. This progress is calculated from the actual event
duration and is not directly linked to the replay itself, so on
limited bandwidth connections may be out of step with the
replay. This option allows you to turn off the progress
display, whilst still keeping the navigation aspect, where
bandwidth prevents it functioning effectively.
"),
type => $types{boolean},
category => "highband",
},
{
name => "ZM_WEB_H_AJAX_TIMEOUT",
default => "3000",
description => "How long to wait for Ajax request responses (ms)",
help => qqq("
The newer versions of the live feed and event views use Ajax to
request information from the server and populate the views
dynamically. This option allows you to specify a timeout if
required after which requests are abandoned. A timeout may be
necessary if requests would overwise hang such as on a slow
connection. This would tend to consume a lot of browser memory
and make the interface unresponsive. Ordinarily no requests
should timeout so this setting should be set to a value greater
than the slowest expected response. This value is in
milliseconds but if set to zero then no timeout will be used.
"),
type => $types{integer},
category => "highband",
},
{
name => "ZM_WEB_M_REFRESH_MAIN",
default => "300",
description => "How often (in seconds) the main console window should refresh itself",
help => qqq("
The main console window lists a general status and the event
totals for all monitors. This is not a trivial task and should
not be repeated too frequently or it may affect the performance
of the rest of the system.
"),
type => $types{integer},
introduction => qqq("
The next few options control what happens when the client is
running in 'medium' bandwidth mode. You should set these
options for when accessing the ZoneMinder client over a slower
cable or DSL link. In most cases the default values will be
suitable as a starting point.
"),
category => "medband",
},
{
name => "ZM_WEB_M_REFRESH_CYCLE",
default => "20",
description => "How often (in seconds) the cycle watch window swaps to the next monitor",
help => qqq("
The cycle watch window is a method of continuously cycling
between images from all of your monitors. This option
determines how often to refresh with a new image.
"),
type => $types{integer},
category => "medband",
},
{
name => "ZM_WEB_M_REFRESH_IMAGE",
default => "10",
description => "How often (in seconds) the watched image is refreshed (if not streaming)",
help => qqq("
The live images from a monitor can be viewed in either streamed
or stills mode. This option determines how often a stills image
is refreshed, it has no effect if streaming is selected.
"),
type => $types{integer},
category => "medband",
},
{
name => "ZM_WEB_M_REFRESH_STATUS",
default => "5",
description => "How often (in seconds) the status refreshes itself in the watch window",
help => qqq("
The monitor window is actually made from several frames. The
one in the middle merely contains a monitor status which needs
to refresh fairly frequently to give a true indication. This
option determines that frequency.
"),
type => $types{integer},
category => "medband",
},
{
name => "ZM_WEB_M_REFRESH_EVENTS",
default => "60",
description => "How often (in seconds) the event listing is refreshed in the watch window",
help => qqq("
The monitor window is actually made from several frames. The
lower framme contains a listing of the last few events for easy
access. This option determines how often this is refreshed.
"),
type => $types{integer},
category => "medband",
},
{
name => "ZM_WEB_M_CAN_STREAM",
default => "auto",
description => "Override the automatic detection of browser streaming capability",
help => qqq("
If you know that your browser can handle image streams of the
type 'multipart/x-mixed-replace' but ZoneMinder does not detect
this correctly you can set this option to ensure that the
stream is delivered with or without the use of the Cambozola
plugin. Selecting 'yes' will tell ZoneMinder that your browser
can handle the streams natively, 'no' means that it can't and
so the plugin will be used while 'auto' lets ZoneMinder decide.
"),
type => $types{tristate},
category => "medband",
},
{
name => "ZM_WEB_M_STREAM_METHOD",
default => "jpeg",
description => "Which method should be used to send video streams to your browser.",
help => qqq("
ZoneMinder can be configured to use either mpeg encoded video
or a series or still jpeg images when sending video streams.
This option defines which is used. If you choose mpeg you
should ensure that you have the appropriate plugins available
on your browser whereas choosing jpeg will work natively on
Mozilla and related browsers and with a Java applet on Internet
Explorer
"),
type => {
db_type =>"string",
hint =>"mpeg|jpeg",
pattern =>qr|^([mj])|i,
format =>q( $1 =~ /^m/ ? "mpeg" : "jpeg" )
},
category => "medband",
},
{
name => "ZM_WEB_M_DEFAULT_SCALE",
default => "100",
description => "What the default scaling factor applied to 'live' or 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'live' or 'event' streams in
their native size. However if you have monitors with large
dimensions or a slow link you may prefer to reduce this size,
alternatively for small monitors you can enlarge it. This
options lets you specify what the default scaling factor will
be. It is expressed as a percentage so 100 is normal size, 200
is double size etc.
"),
type => {
db_type =>"integer",
hint =>"25|33|50|75|100|150|200|300|400",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "medband",
},
{
name => "ZM_WEB_M_DEFAULT_RATE",
default => "100",
description => "What the default replay rate factor applied to 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'event' streams at their
native rate, i.e. as close to real-time as possible. However if
you have long events it is often convenient to replay them at a
faster rate for review. This option lets you specify what the
default replay rate will be. It is expressed as a percentage so
100 is normal rate, 200 is double speed etc.
"),
type => {
db_type =>"integer",
hint =>"25|50|100|150|200|400|1000|2500|5000|10000",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "medband",
},
{
name => "ZM_WEB_M_VIDEO_BITRATE",
default => "75000",
description => "What the bitrate of the video encoded stream should be set to",
help => qqq("
When encoding real video via the ffmpeg library a bit rate can
be specified which roughly corresponds to the available
bandwidth used for the stream. This setting effectively
corresponds to a 'quality' setting for the video. A low value
will result in a blocky image whereas a high value will produce
a clearer view. Note that this setting does not control the
frame rate of the video however the quality of the video
produced is affected both by this setting and the frame rate
that the video is produced at. A higher frame rate at a
particular bit rate result in individual frames being at a
lower quality.
"),
type => $types{integer},
category => "medband",
},
{
name => "ZM_WEB_M_VIDEO_MAXFPS",
default => "10",
description => "What the maximum frame rate for streamed video should be",
help => qqq("
When using streamed video the main control is the bitrate which
determines how much data can be transmitted. However a lower
bitrate at high frame rates results in a lower quality image.
This option allows you to limit the maximum frame rate to
ensure that video quality is maintained. An additional
advantage is that encoding video at high frame rates is a
processor intensive task when for the most part a very high
frame rate offers little perceptible improvement over one that
has a more manageable resource requirement. Note, this option
is implemented as a cap beyond which binary reduction takes
place. So if you have a device capturing at 15fps and set this
option to 10fps then the video is not produced at 10fps, but
rather at 7.5fps (15 divided by 2) as the final frame rate must
be the original divided by a power of 2.
"),
type => $types{integer},
category => "medband",
},
{
name => "ZM_WEB_M_SCALE_THUMBS",
default => "yes",
description => "Scale thumbnails in events, bandwidth versus cpu in rescaling",
help => qqq("
If unset, this option sends the whole image to the browser
which resizes it in the window. If set the image is scaled down
on the server before sending a reduced size image to the
browser to conserve bandwidth at the cost of cpu on the server.
Note that ZM can only perform the resizing if the appropriate
PHP graphics functionality is installed. This is usually
available in the php-gd package.
"),
type => $types{boolean},
category => "medband",
},
{
name => "ZM_WEB_M_EVENTS_VIEW",
default => "events",
description => "What the default view of multiple events should be.",
help => qqq("
Stored events can be viewed in either an events list format or
in a timeline based one. This option sets the default view that
will be used. Choosing one view here does not prevent the other
view being used as it will always be selectable from whichever
view is currently being used.
"),
type => {
db_type =>"string",
hint =>"events|timeline",
pattern =>qr|^([lt])|i,
format =>q( $1 =~ /^e/ ? "events" : "timeline" )
},
category => "medband",
},
{
name => "ZM_WEB_M_SHOW_PROGRESS",
default => "yes",
description => "Show the progress of replay in event view.",
help => qqq("
When viewing events an event navigation panel and progress bar
is shown below the event itself. This allows you to jump to
specific points in the event, but can can also dynamically
update to display the current progress of the event replay
itself. This progress is calculated from the actual event
duration and is not directly linked to the replay itself, so on
limited bandwidth connections may be out of step with the
replay. This option allows you to turn off the progress
display, whilst still keeping the navigation aspect, where
bandwidth prevents it functioning effectively.
"),
type => $types{boolean},
category => "medband",
},
{
name => "ZM_WEB_M_AJAX_TIMEOUT",
default => "5000",
description => "How long to wait for Ajax request responses (ms)",
help => qqq("
The newer versions of the live feed and event views use Ajax to
request information from the server and populate the views
dynamically. This option allows you to specify a timeout if
required after which requests are abandoned. A timeout may be
necessary if requests would overwise hang such as on a slow
connection. This would tend to consume a lot of browser memory
and make the interface unresponsive. Ordinarily no requests
should timeout so this setting should be set to a value greater
than the slowest expected response. This value is in
milliseconds but if set to zero then no timeout will be used.
"),
type => $types{integer},
category => "medband",
},
{
name => "ZM_WEB_L_REFRESH_MAIN",
default => "300",
description => "How often (in seconds) the main console window should refresh itself",
introduction => qqq("
The next few options control what happens when the client is
running in 'low' bandwidth mode. You should set these options
for when accessing the ZoneMinder client over a modem or slow
link. In most cases the default values will be suitable as a
starting point.
"),
help => qqq("
The main console window lists a general status and the event
totals for all monitors. This is not a trivial task and should
not be repeated too frequently or it may affect the performance
of the rest of the system.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_L_REFRESH_CYCLE",
default => "30",
description => "How often (in seconds) the cycle watch window swaps to the next monitor",
help => qqq("
The cycle watch window is a method of continuously cycling
between images from all of your monitors. This option
determines how often to refresh with a new image.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_L_REFRESH_IMAGE",
default => "15",
description => "How often (in seconds) the watched image is refreshed (if not streaming)",
help => qqq("
The live images from a monitor can be viewed in either streamed
or stills mode. This option determines how often a stills image
is refreshed, it has no effect if streaming is selected.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_L_REFRESH_STATUS",
default => "10",
description => "How often (in seconds) the status refreshes itself in the watch window",
help => qqq("
The monitor window is actually made from several frames. The
one in the middle merely contains a monitor status which needs
to refresh fairly frequently to give a true indication. This
option determines that frequency.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_L_REFRESH_EVENTS",
default => "180",
description => "How often (in seconds) the event listing is refreshed in the watch window",
help => qqq("
The monitor window is actually made from several frames. The
lower framme contains a listing of the last few events for easy
access. This option determines how often this is refreshed.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_L_CAN_STREAM",
default => "auto",
description => "Override the automatic detection of browser streaming capability",
help => qqq("
If you know that your browser can handle image streams of the
type 'multipart/x-mixed-replace' but ZoneMinder does not detect
this correctly you can set this option to ensure that the
stream is delivered with or without the use of the Cambozola
plugin. Selecting 'yes' will tell ZoneMinder that your browser
can handle the streams natively, 'no' means that it can't and
so the plugin will be used while 'auto' lets ZoneMinder decide.
"),
type => $types{tristate},
category => "lowband",
},
{
name => "ZM_WEB_L_STREAM_METHOD",
default => "jpeg",
description => "Which method should be used to send video streams to your browser.",
help => qqq("
ZoneMinder can be configured to use either mpeg encoded video
or a series or still jpeg images when sending video streams.
This option defines which is used. If you choose mpeg you
should ensure that you have the appropriate plugins available
on your browser whereas choosing jpeg will work natively on
Mozilla and related browsers and with a Java applet on Internet
Explorer
"),
type => {
db_type =>"string",
hint =>"mpeg|jpeg",
pattern =>qr|^([mj])|i,
format =>q( $1 =~ /^m/ ? "mpeg" : "jpeg" )
},
category => "lowband",
},
{
name => "ZM_WEB_L_DEFAULT_SCALE",
default => "100",
description => "What the default scaling factor applied to 'live' or 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'live' or 'event' streams in
their native size. However if you have monitors with large
dimensions or a slow link you may prefer to reduce this size,
alternatively for small monitors you can enlarge it. This
options lets you specify what the default scaling factor will
be. It is expressed as a percentage so 100 is normal size, 200
is double size etc.
"),
type => {
db_type =>"integer",
hint =>"25|33|50|75|100|150|200|300|400",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "lowband",
},
{
name => "ZM_WEB_L_DEFAULT_RATE",
default => "100",
description => "What the default replay rate factor applied to 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'event' streams at their
native rate, i.e. as close to real-time as possible. However if
you have long events it is often convenient to replay them at a
faster rate for review. This option lets you specify what the
default replay rate will be. It is expressed as a percentage so
100 is normal rate, 200 is double speed etc.
"),
type => {
db_type =>"integer",
hint =>"25|50|100|150|200|400|1000|2500|5000|10000",
pattern =>qr|^(\d+)$|, format=>q( $1 )
},
category => "lowband",
},
{
name => "ZM_WEB_L_VIDEO_BITRATE",
default => "25000",
description => "What the bitrate of the video encoded stream should be set to",
help => qqq("
When encoding real video via the ffmpeg library a bit rate can
be specified which roughly corresponds to the available
bandwidth used for the stream. This setting effectively
corresponds to a 'quality' setting for the video. A low value
will result in a blocky image whereas a high value will produce
a clearer view. Note that this setting does not control the
frame rate of the video however the quality of the video
produced is affected both by this setting and the frame rate
that the video is produced at. A higher frame rate at a
particular bit rate result in individual frames being at a
lower quality.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_L_VIDEO_MAXFPS",
default => "5",
description => "What the maximum frame rate for streamed video should be",
help => qqq("
When using streamed video the main control is the bitrate which
determines how much data can be transmitted. However a lower
bitrate at high frame rates results in a lower quality image.
This option allows you to limit the maximum frame rate to
ensure that video quality is maintained. An additional
advantage is that encoding video at high frame rates is a
processor intensive task when for the most part a very high
frame rate offers little perceptible improvement over one that
has a more manageable resource requirement. Note, this option
is implemented as a cap beyond which binary reduction takes
place. So if you have a device capturing at 15fps and set this
option to 10fps then the video is not produced at 10fps, but
rather at 7.5fps (15 divided by 2) as the final frame rate must
be the original divided by a power of 2.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_L_SCALE_THUMBS",
default => "yes",
description => "Scale thumbnails in events, bandwidth versus cpu in rescaling",
help => qqq("
If unset, this option sends the whole image to the browser
which resizes it in the window. If set the image is scaled down
on the server before sending a reduced size image to the
browser to conserve bandwidth at the cost of cpu on the server.
Note that ZM can only perform the resizing if the appropriate
PHP graphics functionality is installed. This is usually
available in the php-gd package.
"),
type => $types{boolean},
category => "lowband",
},
{
name => "ZM_WEB_L_EVENTS_VIEW",
default => "events",
description => "What the default view of multiple events should be.",
help => qqq("
Stored events can be viewed in either an events list format or
in a timeline based one. This option sets the default view that
will be used. Choosing one view here does not prevent the other
view being used as it will always be selectable from whichever
view is currently being used.
"),
type => {
db_type =>"string",
hint =>"events|timeline",
pattern =>qr|^([lt])|i,
format =>q( $1 =~ /^e/ ? "events" : "timeline" )
},
category => "lowband",
},
{
name => "ZM_WEB_L_SHOW_PROGRESS",
default => "no",
description => "Show the progress of replay in event view.",
help => qqq("
When viewing events an event navigation panel and progress bar
is shown below the event itself. This allows you to jump to
specific points in the event, but can can also dynamically
update to display the current progress of the event replay
itself. This progress is calculated from the actual event
duration and is not directly linked to the replay itself, so on
limited bandwidth connections may be out of step with the
replay. This option allows you to turn off the progress
display, whilst still keeping the navigation aspect, where
bandwidth prevents it functioning effectively.
"),
type => $types{boolean},
category => "lowband",
},
{
name => "ZM_WEB_L_AJAX_TIMEOUT",
default => "10000",
description => "How long to wait for Ajax request responses (ms)",
help => qqq("
The newer versions of the live feed and event views use Ajax to
request information from the server and populate the views
dynamically. This option allows you to specify a timeout if
required after which requests are abandoned. A timeout may be
necessary if requests would overwise hang such as on a slow
connection. This would tend to consume a lot of browser memory
and make the interface unresponsive. Ordinarily no requests
should timeout so this setting should be set to a value greater
than the slowest expected response. This value is in
milliseconds but if set to zero then no timeout will be used.
"),
type => $types{integer},
category => "lowband",
},
{
name => "ZM_WEB_P_CAN_STREAM",
default => "auto",
description => "Override the automatic detection of browser streaming capability",
help => qqq("
If you know that your browser can handle image streams of the
type 'multipart/x-mixed-replace' but ZoneMinder does not detect
this correctly you can set this option to ensure that the
stream is delivered with or without the use of the Cambozola
plugin. Selecting 'yes' will tell ZoneMinder that your browser
can handle the streams natively, 'no' means that it can't and
so the plugin will be used while 'auto' lets ZoneMinder decide.
"),
type => $types{tristate},
category => "phoneband",
},
{
name => "ZM_WEB_P_STREAM_METHOD",
default => "jpeg",
description => "Which method should be used to send video streams to your browser.",
help => qqq("
ZoneMinder can be configured to use either mpeg encoded video
or a series or still jpeg images when sending video streams.
This option defines which is used. If you choose mpeg you
should ensure that you have the appropriate plugins available
on your browser whereas choosing jpeg will work natively on
Mozilla and related browsers and with a Java applet on Internet
Explorer
"),
type => {
db_type =>"string",
hint =>"mpeg|jpeg",
pattern =>qr|^([mj])|i,
format =>q( $1 =~ /^m/ ? "mpeg" : "jpeg" )
},
category => "phoneband",
},
{
name => "ZM_WEB_P_DEFAULT_SCALE",
default => "100",
description => "What the default scaling factor applied to 'live' or 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'live' or 'event' streams in
their native size. However if you have monitors with large
dimensions or a slow link you may prefer to reduce this size,
alternatively for small monitors you can enlarge it. This
options lets you specify what the default scaling factor will
be. It is expressed as a percentage so 100 is normal size, 200
is double size etc.
"),
type => {
db_type =>"integer",
hint =>"25|33|50|75|100|150|200|300|400",
pattern =>qr|^(\d+)$|, format=>q( $1 )
},
category => "phoneband",
},
{
name => "ZM_WEB_P_DEFAULT_RATE",
default => "100",
description => "What the default replay rate factor applied to 'event' views is (%)",
help => qqq("
Normally ZoneMinder will display 'event' streams at their
native rate, i.e. as close to real-time as possible. However if
you have long events it is often convenient to replay them at a
faster rate for review. This option lets you specify what the
default replay rate will be. It is expressed as a percentage so
100 is normal rate, 200 is double speed etc.
"),
type => {
db_type =>"integer",
hint =>"25|50|100|150|200|400|1000|2500|5000|10000",
pattern =>qr|^(\d+)$|,
format =>q( $1 )
},
category => "phoneband",
},
{
name => "ZM_WEB_P_VIDEO_BITRATE",
default => "8000",
description => "What the bitrate of the video encoded stream should be set to",
help => qqq("
When encoding real video via the ffmpeg library a bit rate can
be specified which roughly corresponds to the available
bandwidth used for the stream. This setting effectively
corresponds to a 'quality' setting for the video. A low value
will result in a blocky image whereas a high value will produce
a clearer view. Note that this setting does not control the
frame rate of the video however the quality of the video
produced is affected both by this setting and the frame rate
that the video is produced at. A higher frame rate at a
particular bit rate result in individual frames being at a
lower quality.
"),
type => $types{integer},
category => "phoneband",
},
{
name => "ZM_WEB_P_VIDEO_MAXFPS",
default => "5",
description => "What the maximum frame rate for streamed video should be",
help => qqq("
When using streamed video the main control is the bitrate which
determines how much data can be transmitted. However a lower
bitrate at high frame rates results in a lower quality image.
This option allows you to limit the maximum frame rate to
ensure that video quality is maintained. An additional
advantage is that encoding video at high frame rates is a
processor intensive task when for the most part a very high
frame rate offers little perceptible improvement over one that
has a more manageable resource requirement. Note, this option
is implemented as a cap beyond which binary reduction takes
place. So if you have a device capturing at 15fps and set this
option to 10fps then the video is not produced at 10fps, but
rather at 7.5fps (15 divided by 2) as the final frame rate must
be the original divided by a power of 2.
"),
type => $types{integer},
category => "phoneband",
},
{
name => "ZM_WEB_P_SCALE_THUMBS",
default => "yes",
description => "Scale thumbnails in events, bandwidth versus cpu in rescaling",
help => qqq("
If unset, this option sends the whole image to the browser
which resizes it in the window. If set the image is scaled down
on the server before sending a reduced size image to the
browser to conserve bandwidth at the cost of cpu on the server.
Note that ZM can only perform the resizing if the appropriate
PHP graphics functionality is installed. This is usually
available in the php-gd package.
"),
type => $types{boolean},
category => "phoneband",
},
{
name => "ZM_WEB_P_AJAX_TIMEOUT",
default => "10000",
description => "How long to wait for Ajax request responses (ms)",
help => qqq("
The newer versions of the live feed and event views use Ajax to
request information from the server and populate the views
dynamically. This option allows you to specify a timeout if
required after which requests are abandoned. A timeout may be
necessary if requests would overwise hang such as on a slow
connection. This would tend to consume a lot of browser memory
and make the interface unresponsive. Ordinarily no requests
should timeout so this setting should be set to a value greater
than the slowest expected response. This value is in
milliseconds but if set to zero then no timeout will be used.
"),
type => $types{integer},
category => "phoneband",
},
{
name => "ZM_DYN_LAST_VERSION",
default => "",
description => "What the last version of ZoneMinder recorded from zoneminder.com is",
help => "",
type => $types{string},
readonly => 1,
category => "dynamic",
},
{
name => "ZM_DYN_CURR_VERSION",
default => "1.29.0",
description => qqq("
What the effective current version of ZoneMinder is, might be
different from actual if versions ignored
"),
help => "",
type => $types{string},
readonly => 1,
category => "dynamic",
},
{
name => "ZM_DYN_DB_VERSION",
default => "1.29.0",
description => "What the version of the database is, from zmupdate",
help => "",
type => $types{string},
readonly => 1,
category => "dynamic",
},
{
name => "ZM_DYN_LAST_CHECK",
default => "",
description => "When the last check for version from zoneminder.com was",
help => "",
type => $types{integer},
readonly => 1,
category => "dynamic",
},
{
name => "ZM_DYN_NEXT_REMINDER",
default => "",
description => "When the earliest time to remind about versions will be",
help => "",
type => $types{string},
readonly => 1,
category => "dynamic",
},
{
name => "ZM_DYN_DONATE_REMINDER_TIME",
default => 0,
description => "When the earliest time to remind about donations will be",
help => "",
type => $types{integer},
readonly => 1,
category => "dynamic",
},
{
name => "ZM_DYN_SHOW_DONATE_REMINDER",
default => "yes",
description => "Remind about donations or not",
help => "",
type => $types{boolean},
readonly => 1,
category => "dynamic",
},
{
name => "ZM_EYEZM_DEBUG",
default => "no",
description => "Switch additional debugging on for eyeZm Plugin",
help => qqq("
Enable or Disable extra debugging from the eyeZm Plugin. Extra
debugging information will be displayed in it's own file
(EYEZM_LOG_TO_FILE is set), or your Apache error log
"),
type => $types{boolean},
category => "eyeZm",
},
{
name => "ZM_EYEZM_LOG_TO_FILE",
default => "yes",
description => "When eyeZm Debugging is enabled, enabling this logs output to it's own file",
help => qqq("
When EYEZM_DEBUG is on and EYEZM_LOG_TO_FILE is on, output
generated from the eyeZm Plugin will go to it's own file.
Otherwise it will go to the apache error log.
"),
type => $types{boolean},
category => "eyeZm",
},
{
name => "ZM_EYEZM_LOG_FILE",
default => "/var/log/zm/zm_xml.log",
description => "Default filename to use when logging eyeZm Output and EYEZM_LOG_TO_FILE is enabled",
help => qqq("
This file will contain it's own output from the eyeZm Plugin
when EYEZM_LOG_TO_FILE and EYEZM_DEBUG are both enabled
"),
type => $types{string},
category => "eyeZm",
},
{
name => "ZM_EYEZM_EVENT_VCODEC",
default => "mpeg4",
description => "Default video-codec to use for encoding events",
help => qqq("
The eyeZm Plugin calls FFMPEG externally to encode the captured
images. If your FFMPEG is not built with support for H264,
change this to MPEG-4. If using H264, please check
http://www.eyezm.com for H264 requirements and that your eyeZm
version supports H264 (v1.2+).
"),
type => {
db_type =>"string",
hint =>"mpeg4|h264",
pattern =>qr|^([mh])|i,
format =>q( $1 =~ /^m/ ? "mpeg4" : "h264" )
},
category => "eyeZm",
},
{
name => "ZM_EYEZM_FEED_VCODEC",
default => "mjpeg",
description => "Default video-codec to use for streaming the live feed",
help => qqq("
Determines whether the live stream is generated using native
MJPEG streaming with ZoneMinder, or H264 using FFMPEG and
HTML-5 streaming. If using H264, please check
http://www.eyezm.com for H264 requirements and that your eyeZm
version supports H264 (v1.2+). This is just a default
parameter, and can be overridden with eyeZm.
"),
type => {
db_type =>"string",
hint =>"mjpeg|h264",
pattern =>qr|^([mh])|i,
format =>q( $1 =~ /^m/ ? "mjpeg" : "h264" )
},
category => "eyeZm",
},
{
name => "ZM_EYEZM_H264_DEFAULT_BR",
default => "96k",
description => "Default bit-rate to use with FFMPEG for H264 streaming",
help => qqq("
When using the eyeZm Plugin to stream H264 data, FFMPEG
requires a bitrate to control the quality and bandwidth of the
video. This should be specified in a format acceptable to
FFMPEG. The default value is sufficient for most installations.
This is just a default parameter, and can be overridden with
eyeZm.
"),
type => $types{string},
category => "eyeZm",
},
{
name => "ZM_EYEZM_H264_DEFAULT_EVBR",
default => "128k",
description => "Default bit-rate to use with FFMPEG for H264 event viewing",
help => qqq("
When using the eyeZm Plugin to view events in H264, FFMPEG
requires a bitrate to control the quality and bandwidth of the
video. This should be specified in a format acceptable to
FFMPEG. The default value is sufficient for most installations.
This is just a default parameter, and can be overridden with
eyeZm.
"),
type => $types{string},
category => "eyeZm",
},
{
name => "ZM_EYEZM_H264_TIMEOUT",
default => "20",
description => "Timeout (sec) to wait for H264 stream to start before terminating",
help => qqq("
The eyeZm Plugin will attempt to spawn an H264 stream when
requested, and require that it complete within the timeout
specified. If you have a slow system or find through the logs
that the H264 stream is not starting because the timeout is
expiring, even though FFMPEG is running, try increasing this
value. If you have a fast system, decreasing this value can
improve the responsiveness when there are issues starting H264
streams
"),
type => $types{string},
category => "eyeZm",
},
{
name => "ZM_EYEZM_SEG_DURATION",
default => "3",
description => "Segment duration used for streaming using HTTP-5 Streaming protocol",
help => qqq("
The HTTP-5 Live Streaming Protocol segments the input video
stream into small chunks of a duration specified by this
parameter. Increasing the segment duration will help with
choppy connections on the other end, but will increase the
latency in starting a stream.
"),
type => $types{string},
category => "eyeZm",
},
);
our %options_hash = map { ( $_->{name}, $_ ) } @options;
# This function should never need to be called explicitly, except if
# this module is 'require'd rather than 'use'd. See zmconfgen.pl.
sub initialiseConfig
{
return if ( $configInitialised );
# Do some initial data munging to finish the data structures
# Create option ids
my $option_id = 0;
foreach my $option ( @options )
{
if ( defined($option->{default}) )
{
$option->{value} = $option->{default}
}
else
{
$option->{value} = '';
}
#next if ( $option->{category} eq 'hidden' );
$option->{id} = $option_id++;
}
$configInitialised = 1;
}
1;
__END__
=head1 NAME
ZoneMinder::ConfigData - ZoneMinder Configuration Data module
=head1 SYNOPSIS
use ZoneMinder::ConfigData;
use ZoneMinder::ConfigData qw(:all);
loadConfigFromDB();
saveConfigToDB();
=head1 DESCRIPTION
The ZoneMinder:ConfigData module contains the master definition of the
ZoneMinder configuration options as well as helper methods. This module is
intended for specialist confguration management and would not normally be
used by end users.
The configuration held in this module, which was previously in zmconfig.pl,
includes the name, default value, description, help text, type and category
for each option, as well as a number of additional fields in a small number
of cases.
=head1 METHODS
=over 4
=item loadConfigFromDB ();
Loads existing configuration from the database (if any) and merges it with
the definitions held in this module. This results in the merging of any new
configuration and the removal of any deprecated configuration while
preserving the existing values of every else.
=item saveConfigToDB ();
Saves configuration held in memory to the database. The act of loading and
saving configuration is a convenient way to ensure that the configuration
held in the database corresponds with the most recent definitions and that
all components are using the same set of configuration.
=back
=head2 EXPORT
None by default.
The :data tag will export the various configuration data structures
The :functions tag will export the helper functions.
The :all tag will export all above symbols.
=head1 SEE ALSO
http://www.zoneminder.com
=head1 AUTHOR
Philip Coombes, E<lt>philip.coombes@zoneminder.comE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2001-2008 Philip Coombes
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.3 or,
at your option, any later version of Perl 5 you may have available.
=cut
|