This file is indexed.

/usr/share/doc/backup-manager-doc/user-guide.html/ch-configuration.html is in backup-manager-doc 0.7.12-4.

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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">

<html>

<head>

<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">

<title>Backup Manager 0.7.7 User Guide - Configuration files</title>

<link href="index.html" rel="start">
<link href="ch-about.html" rel="prev">
<link href="ch-using.html" rel="next">
<link href="index.html#contents" rel="contents">
<link href="index.html#copyright" rel="copyright">
<link href="ch-about.html" rel="chapter" title="1 About this manual">
<link href="ch-configuration.html" rel="chapter" title="2 Configuration files">
<link href="ch-using.html" rel="chapter" title="3 Using Backup Manager">
<link href="ch-about.html#s-about-scope" rel="section" title="1.1 Scope">
<link href="ch-about.html#s-about-version" rel="section" title="1.2 Version">
<link href="ch-about.html#s-about-authors" rel="section" title="1.3 Authors">
<link href="ch-configuration.html#s-design" rel="section" title="2.1 Repository and Archives">
<link href="ch-configuration.html#s-methods" rel="section" title="2.2 Backup Methods">
<link href="ch-configuration.html#s-uploads" rel="section" title="2.3 Upload Methods">
<link href="ch-configuration.html#s-exports" rel="section" title="2.4 Exports">
<link href="ch-configuration.html#s-advanced" rel="section" title="2.5 Advanced features">
<link href="ch-using.html#s-command" rel="section" title="3.1 Command line">
<link href="ch-using.html#s-cron" rel="section" title="3.2 CRON integration">
<link href="ch-configuration.html#s-archive-repo" rel="subsection" title="2.1.1 The Repository">
<link href="ch-configuration.html#s-BM_REPOSITORY_ROOT" rel="subsection" title="2.1.1.1 BM_REPOSITORY_ROOT">
<link href="ch-configuration.html#s-BM_REPOSITORY_SECURE" rel="subsection" title="2.1.1.2 BM_REPOSITORY_SECURE">
<link href="ch-configuration.html#s-encryption" rel="subsection" title="2.1.2 Encryption">
<link href="ch-configuration.html#s-BM_ENCRYPTION_METHOD" rel="subsection" title="2.1.2.1 BM_ENCRYPTION_METHOD">
<link href="ch-configuration.html#s-BM_ENCRYPTION_RECIPIENT" rel="subsection" title="2.1.2.2 BM_ENCRYPTION_RECIPIENT">
<link href="ch-configuration.html#s-archives" rel="subsection" title="2.1.3 Archives">
<link href="ch-configuration.html#s-BM_ARCHIVE_STRICTPURGE" rel="subsection" title="2.1.3.1 BM_ARCHIVE_STRICTPURGE">
<link href="ch-configuration.html#s-BM_ARCHIVE_NICE_LEVEL" rel="subsection" title="2.1.3.2 BM_ARCHIVE_NICE_LEVEL">
<link href="ch-configuration.html#s-BM_ARCHIVE_PURGEDUPS" rel="subsection" title="2.1.3.3 BM_ARCHIVE_PURGEDUPS">
<link href="ch-configuration.html#s-BM_ARCHIVE_TTL" rel="subsection" title="2.1.3.4 BM_ARCHIVE_TTL">
<link href="ch-configuration.html#s-BM_REPOSITORY_RECURSIVEPURGE" rel="subsection" title="2.1.3.5 BM_REPOSITORY_RECURSIVEPURGE">
<link href="ch-configuration.html#s-BM_ARCHIVE_PREFIX" rel="subsection" title="2.1.3.6 BM_ARCHIVE_PREFIX">
<link href="ch-configuration.html#s-tarball" rel="subsection" title="2.2.1 Tarballs">
<link href="ch-configuration.html#s-tarball-desc" rel="subsection" title="2.2.1.1 Description">
<link href="ch-configuration.html#s-BM_TARBALL_NAMEFORMAT" rel="subsection" title="2.2.1.2 BM_TARBALL_NAMEFORMAT">
<link href="ch-configuration.html#s-BM_TARBALL_FILETYPE" rel="subsection" title="2.2.1.3 BM_TARBALL_FILETYPE">
<link href="ch-configuration.html#s-BM_TARBALL_SLICESIZE" rel="subsection" title="2.2.1.4 BM_TARBALL_SLICESIZE">
<link href="ch-configuration.html#s-BM_TARBALL_EXTRA_OPTIONS" rel="subsection" title="2.2.1.5 BM_TARBALL_EXTRA_OPTIONS">
<link href="ch-configuration.html#s-BM_TARBALL_DUMPSYMLINKS" rel="subsection" title="2.2.1.6 BM_TARBALL_DUMPSYMLINKS">
<link href="ch-configuration.html#s-BM_TARBALL_DIRECTORIES" rel="subsection" title="2.2.1.7 BM_TARBALL_DIRECTORIES">
<link href="ch-configuration.html#s-BM_TARBALL_TARGETS" rel="subsection" title="2.2.1.8 BM_TARBALL_TARGETS">
<link href="ch-configuration.html#s-BM_TARBALL_BLACKLIST" rel="subsection" title="2.2.1.9 BM_TARBALL_BLACKLIST">
<link href="ch-configuration.html#s-BM_TARBALL_OVER_SSH" rel="subsection" title="2.2.1.10 BM_TARBALL_OVER_SSH">
<link href="ch-configuration.html#s-tarballinc" rel="subsection" title="2.2.2 Incremental tarballs">
<link href="ch-configuration.html#s-tarballinc-desc" rel="subsection" title="2.2.2.1 Description">
<link href="ch-configuration.html#s-BM_TARBALLINC_MASTERDATETYPE" rel="subsection" title="2.2.2.2 BM_TARBALLINC_MASTERDATETYPE">
<link href="ch-configuration.html#s-BM_TARBALLINC_MASTERDATEVALUE" rel="subsection" title="2.2.2.3 BM_TARBALLINC_MASTERDATEVALUE">
<link href="ch-configuration.html#s-mysql" rel="subsection" title="2.2.3 MySQL databases">
<link href="ch-configuration.html#s-mysql-desc" rel="subsection" title="2.2.3.1 Description">
<link href="ch-configuration.html#s-BM_MYSQL_DATABASES" rel="subsection" title="2.2.3.2 BM_MYSQL_DATABASES">
<link href="ch-configuration.html#s-BM_MYSQL_SAFEDUMPS" rel="subsection" title="2.2.3.3 BM_MYSQL_SAFEDUMPS">
<link href="ch-configuration.html#s-BM_MYSQL_ADMINLOGIN" rel="subsection" title="2.2.3.4 BM_MYSQL_ADMINLOGIN">
<link href="ch-configuration.html#s-BM_MYSQL_ADMINPASS" rel="subsection" title="2.2.3.5 BM_MYSQL_ADMINPASS">
<link href="ch-configuration.html#s-BM_MYSQL_HOST" rel="subsection" title="2.2.3.6 BM_MYSQL_HOST">
<link href="ch-configuration.html#s-BM_MYSQL_PORT" rel="subsection" title="2.2.3.7 BM_MYSQL_PORT">
<link href="ch-configuration.html#s-BM_MYSQL_FILETYPE" rel="subsection" title="2.2.3.8 BM_MYSQL_FILETYPE">
<link href="ch-configuration.html#s-svn" rel="subsection" title="2.2.4 Subversion repositories">
<link href="ch-configuration.html#s-svn-desc" rel="subsection" title="2.2.4.1 Description">
<link href="ch-configuration.html#s-BM_SVN_REPOSITORIES" rel="subsection" title="2.2.4.2 BM_SVN_REPOSITORIES">
<link href="ch-configuration.html#s-BM_SVN_COMPRESSWITH" rel="subsection" title="2.2.4.3 BM_SVN_COMPRESSWITH">
<link href="ch-configuration.html#s-pipe" rel="subsection" title="2.2.5 Generic methods">
<link href="ch-configuration.html#s-pipe-desc" rel="subsection" title="2.2.5.1 Description">
<link href="ch-configuration.html#s-pipe-example" rel="subsection" title="2.2.5.2 Example">
<link href="ch-configuration.html#s-uploads-desc" rel="subsection" title="2.3.1 Description">
<link href="ch-configuration.html#s-uploads-global" rel="subsection" title="2.3.2 Global configuration keys">
<link href="ch-configuration.html#s-BM_UPLOAD_HOSTS" rel="subsection" title="2.3.2.1 BM_UPLOAD_HOSTS">
<link href="ch-configuration.html#s-BM_UPLOAD_DESTINATION" rel="subsection" title="2.3.2.2 BM_UPLOAD_DESTINATION">
<link href="ch-configuration.html#s-upload-ssh" rel="subsection" title="2.3.3 SSH uploads">
<link href="ch-configuration.html#s-uploads-ssh-desc" rel="subsection" title="2.3.3.1 Description">
<link href="ch-configuration.html#s-BM_UPLOAD_SSH_USER" rel="subsection" title="2.3.3.2 BM_UPLOAD_SSH_USER">
<link href="ch-configuration.html#s-BM_UPLOAD_SSH_KEY" rel="subsection" title="2.3.3.3 BM_UPLOAD_SSH_KEY">
<link href="ch-configuration.html#s-BM_UPLOAD_SSH_PORT" rel="subsection" title="2.3.3.4 BM_UPLOAD_SSH_PORT">
<link href="ch-configuration.html#s-BM_UPLOAD_SSH_HOSTS" rel="subsection" title="2.3.3.5 BM_UPLOAD_SSH_HOSTS">
<link href="ch-configuration.html#s-BM_UPLOAD_SSH_PURGE" rel="subsection" title="2.3.3.6 BM_UPLOAD_SSH_PURGE">
<link href="ch-configuration.html#s-BM_UPLOAD_SSH_DESTINATION" rel="subsection" title="2.3.3.7 BM_UPLOAD_SSH_DESTINATION">
<link href="ch-configuration.html#s-upload-ssh-gpg" rel="subsection" title="2.3.4 Encrypted SSH uploads">
<link href="ch-configuration.html#s-upload-ssh-gpg-desc" rel="subsection" title="2.3.4.1 Description">
<link href="ch-configuration.html#s-BM_UPLOAD_SSH_GPG_RECIPIENT" rel="subsection" title="2.3.4.2 BM_UPLOAD_SSH_GPG_RECIPIENT">
<link href="ch-configuration.html#s-upload-ftp" rel="subsection" title="2.3.5 FTP uploads">
<link href="ch-configuration.html#s-uploads-ftp-desc" rel="subsection" title="2.3.5.1 Description">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_SECURE" rel="subsection" title="2.3.5.2 BM_UPLOAD_FTP_SECURE">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_PASSIVE" rel="subsection" title="2.3.5.3 BM_UPLOAD_FTP_PASSIVE">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_TTL" rel="subsection" title="2.3.5.4 BM_UPLOAD_FTP_TTL">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_USER" rel="subsection" title="2.3.5.5 BM_UPLOAD_FTP_USER">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_PASSWORD" rel="subsection" title="2.3.5.6 BM_UPLOAD_FTP_PASSWORD">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_HOSTS" rel="subsection" title="2.3.5.7 BM_UPLOAD_FTP_HOSTS">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_DESTINATION" rel="subsection" title="2.3.5.8 BM_UPLOAD_FTP_DESTINATION">
<link href="ch-configuration.html#s-BM_UPLOAD_FTP_PURGE" rel="subsection" title="2.3.5.9 BM_UPLOAD_FTP_PURGE">
<link href="ch-configuration.html#s-upload-s3" rel="subsection" title="2.3.6 Amazon S3 uploads">
<link href="ch-configuration.html#s-uploads-s3-desc" rel="subsection" title="2.3.6.1 Description">
<link href="ch-configuration.html#s-BM_UPLOAD_S3_DESTINATION" rel="subsection" title="2.3.6.2 BM_UPLOAD_S3_DESTINATION">
<link href="ch-configuration.html#s-BM_UPLOAD_S3_ACCESS_KEY" rel="subsection" title="2.3.6.3 BM_UPLOAD_S3_ACCESS_KEY">
<link href="ch-configuration.html#s-BM_UPLOAD_S3_SECRET_KEY" rel="subsection" title="2.3.6.4 BM_UPLOAD_S3_SECRET_KEY">
<link href="ch-configuration.html#s-BM_UPLOAD_S3_PURGE" rel="subsection" title="2.3.6.5 BM_UPLOAD_S3_PURGE">
<link href="ch-configuration.html#s-BM_UPLOAD_S3_TTL" rel="subsection" title="2.3.6.6 BM_UPLOAD_S3_TTL">
<link href="ch-configuration.html#s-upload-rsync" rel="subsection" title="2.3.7 RSYNC uploads">
<link href="ch-configuration.html#s-upload-rsync-desc" rel="subsection" title="2.3.7.1 Description">
<link href="ch-configuration.html#s-BM_UPLOAD_RSYNC_DIRECTORIES" rel="subsection" title="2.3.7.2 BM_UPLOAD_RSYNC_DIRECTORIES">
<link href="ch-configuration.html#s-BM_UPLOAD_RSYNC_HOSTS" rel="subsection" title="2.3.7.3 BM_UPLOAD_RSYNC_HOSTS">
<link href="ch-configuration.html#s-BM_UPLOAD_RSYNC_DESTINATION" rel="subsection" title="2.3.7.4 BM_UPLOAD_RSYNC_DESTINATION">
<link href="ch-configuration.html#s-BM_UPLOAD_RSYNC_DUMPSYMLINKS" rel="subsection" title="2.3.7.5 BM_UPLOAD_RSYNC_DUMPSYMLINKS">
<link href="ch-configuration.html#s-exports-burning" rel="subsection" title="2.4.1 Burning CDR/DVD media">
<link href="ch-configuration.html#s-BM_BURNING_METHOD" rel="subsection" title="2.4.1.1 BM_BURNING_METHOD">
<link href="ch-configuration.html#s-BM_BURNING_DEVICE" rel="subsection" title="2.4.1.2 BM_BURNING_DEVICE">
<link href="ch-configuration.html#s-BM_BURNING_DEVFORCED" rel="subsection" title="2.4.1.3 BM_BURNING_DEVFORCED">
<link href="ch-configuration.html#s-BM_BURNING_ISO_FLAGS" rel="subsection" title="2.4.1.4 BM_BURNING_ISO_FLAGS">
<link href="ch-configuration.html#s-BM_BURNING_MAXSIZE" rel="subsection" title="2.4.1.5 BM_BURNING_MAXSIZE">
<link href="ch-configuration.html#s-BM_BURNING_CHKMD5" rel="subsection" title="2.4.1.6 BM_BURNING_CHKMD5">
<link href="ch-configuration.html#s-BM_TEMP_DIR" rel="subsection" title="2.5.1 BM_TEMP_DIR">
<link href="ch-configuration.html#s-advanced-logger" rel="subsection" title="2.5.2 Logging to syslog">
<link href="ch-configuration.html#s-BM_LOGGER" rel="subsection" title="2.5.2.1 BM_LOGGER">
<link href="ch-configuration.html#s-BM_LOGGER_FACILITY" rel="subsection" title="2.5.2.2 BM_LOGGER_FACILITY">
<link href="ch-configuration.html#s-advanced-externals" rel="subsection" title="2.5.3 Writing external hooks">
<link href="ch-configuration.html#s-BM_PRE_BACKUP_COMMAND" rel="subsection" title="2.5.3.1 BM_PRE_BACKUP_COMMAND">
<link href="ch-configuration.html#s-BM_POST_BACKUP_COMMAND" rel="subsection" title="2.5.3.2 BM_POST_BACKUP_COMMAND">
<link href="ch-using.html#s-command-desc" rel="subsection" title="3.1.1 Restrictions">
<link href="ch-using.html#s-command-switched" rel="subsection" title="3.1.2 Options">
<link href="ch-using.html#s-version" rel="subsection" title="3.1.2.1 --version">
<link href="ch-using.html#s-verbose" rel="subsection" title="3.1.2.2 --verbose or -v">
<link href="ch-using.html#s-no-warnings" rel="subsection" title="3.1.2.3 --no-warnings">
<link href="ch-using.html#s-conffile" rel="subsection" title="3.1.2.4 --conffile or -c">
<link href="ch-using.html#s-force" rel="subsection" title="3.1.2.5 --force">
<link href="ch-using.html#s-upload" rel="subsection" title="3.1.2.6 --upload or -u">
<link href="ch-using.html#s-burn" rel="subsection" title="3.1.2.7 --burn or -b [&lt;DATE&gt;]">
<link href="ch-using.html#s-md5check" rel="subsection" title="3.1.2.8 --md5check or -m">
<link href="ch-using.html#s-purge" rel="subsection" title="3.1.2.9 --purge or -p">
<link href="ch-using.html#s-no-upload" rel="subsection" title="3.1.2.10 --no-upload or -p">
<link href="ch-using.html#s-no-burn" rel="subsection" title="3.1.2.11 --no-burn">
<link href="ch-using.html#s-no-purge" rel="subsection" title="3.1.2.12 --no-purge or -p">

</head>

<body>

<p><a name="ch-configuration"></a></p>
<hr>

<p>
[ <a href="ch-about.html">previous</a> ]
[ <a href="index.html#contents">Contents</a> ]
[ <a href="ch-about.html">1</a> ]
[ 2 ]
[ <a href="ch-using.html">3</a> ]
[ <a href="ch-using.html">next</a> ]
</p>

<hr>

<h1>
Backup Manager 0.7.7 User Guide
<br>Chapter 2 - Configuration files
</h1>

<hr>

<p>
<em>Backup Manager's behaviour is defined in configuration files.  You can run
Backup Manager with different configuration files (at the same time or not).
This chapter will cover all the configuration keys supported in version 0.7.7
and will explain their meaning.</em>
</p>

<hr>

<h2 id="s-design">2.1 Repository and Archives</h2>

<p>
Backup Manager stores <em>archives</em> it builds in a <em>repository</em>.
<em>Archives</em> are built by using a <em>backup method</em>.
</p>

<hr>

<h3 id="s-archive-repo">2.1.1 The Repository</h3>

<hr>

<h4 id="s-BM_REPOSITORY_ROOT">2.1.1.1 <samp>BM_REPOSITORY_ROOT</samp></h4>

<p>
<em>Type: string, default: <samp>/var/archives</samp>.</em>
</p>

<p>
The repository is the place in your filesystem where all archives are stored.
This is a particular place for Backup Manager, it will be cleaned during backup
sessions: archives older than the authorized lifetime will be purged.  If the
repository does not exist, it will be created at runtime.
</p>

<p>
Isolating the repository on a dedicated partition is a good idea.  This can
prevent the repository from eating all the disk space of the partition.  With a
bad configuration file, backup sessions can lead to huge archives, for many
reasons, so take care.
</p>

<p>
Example:
</p>

<pre>
     export BM_REPOSITORY_ROOT=&quot;/var/archives&quot;
</pre>

<hr>

<h4 id="s-BM_REPOSITORY_SECURE">2.1.1.2 <samp>BM_REPOSITORY_SECURE</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp>.</em>
</p>

<p>
For security reasons, the repository can be accessible by a specific user/group
pair.  This will prevent the archives from being readable (and writable) by any
user in the system.  This mode is enabled by default (owned by
<samp>root:root</samp>).
</p>

<p>
To enable this mode, set the configuration key
<samp>BM_REPOSITORY_SECURE</samp> to <samp>yes</samp>, then update
<samp>BM_REPOSITORY_USER</samp> and <samp>BM_REPOSITORY_GROUP</samp> to your
needs.
</p>

<p>
You can also change the permission of the repository and the archives, that is
possible with two configuration variables: <samp>BM_REPOSITORY_CHMOD</samp> and
<samp>BM_ARCHIVE_CHMOD</samp>.
</p>

<p>
Example:
</p>

<pre>
     export BM_REPOSITORY_SECURE=&quot;true&quot;
     export BM_REPOSITORY_USER=&quot;root&quot;
     export BM_REPOSITORY_GROUP=&quot;root&quot;
     export BM_REPOSITORY_CHMOD=&quot;770&quot;
     export BM_ARCHIVE_CHMOD=&quot;660&quot;
</pre>

<hr>

<h3 id="s-encryption">2.1.2 Encryption</h3>

<p>
<em>If you cannot trust the place where you store your archives, you can choose
to encrypt them so you are the only one who can read their content.  That's a
very good idea for archives you plan to upload to some remote place, or even
for the archives you want to daily export on removable media.</em>
</p>

<hr>

<h4 id="s-BM_ENCRYPTION_METHOD">2.1.2.1 <samp>BM_ENCRYPTION_METHOD</samp></h4>

<p>
<em>Type: string, default: undefined.</em>
</p>

<p>
For Backup Manager, encryption is defined in one place in the configuration
file.  If the variable &quot;<samp>BM_ENCRYPTION_METHOD</samp>&quot; is not
defined, no encryption occurs during the archive build process, if a method is
defined there, then any archive built are encrypted through a pipeline with
that method.
</p>

<p>
Be aware that encryption is supported for the methods &quot;mysql&quot;,
&quot;pipe&quot;, &quot;tarball&quot; and &quot;tarball-incremental&quot; but
only for those file types: tar, tar.gz, tar.bz2.
</p>

<p>
The only valid method supported for encrypting archives is &quot;gpg&quot;.
</p>

<p>
Backup Manager will encrypt your archive through a pipeline in order not to
write any byte of unencrypted data on the physical media.  The encryption will
be performed with a command line like the following:
</p>

<pre>
     &lt;command&gt; | gpg -r &quot;$BM_ENCRYPTION_RECIPIENT&quot; -e &gt; archive.gpg
</pre>

<p>
To decrypt an archive built with GPG encryption, you have to be the owner of
the private GPG key for which the encryption was made.  Then issue the
following:
</p>

<pre>
     $ gpg -d &lt;archive.gpg&gt; &gt; archive
</pre>

<p>
GPG will then prompt you for the private key passphrase and will decrypt the
content of the archive if the passphrase is valid.
</p>

<p>
Refer to the GPG documentation for more details of encryption.
</p>

<hr>

<h4 id="s-BM_ENCRYPTION_RECIPIENT">2.1.2.2 <samp>BM_ENCRYPTION_RECIPIENT</samp></h4>

<p>
<em>Type: string, default: undefined.</em>
</p>

<p>
As explained in the previous section, that variable should contain the GPG
recipient for the encryption, eg: your GPG ID.
</p>

<p>
Examples of valid GPG ID:
</p>

<pre>
     export BM_ENCRYPTION_RECIPIENT=&quot;0x1EE5DD34&quot;
     export BM_ENCRYPTION_RECIPIENT=&quot;Alexis Sukrieh&quot;
     export BM_ENCRYPTION_RECIPIENT=&quot;sukria@sukria.net&quot;
</pre>

<hr>

<h3 id="s-archives">2.1.3 Archives</h3>

<p>
<em>Archives are produced by backup methods, they can be virtually anything,
but will always be named like the following:
<samp>prefix-name-date.filetype</samp>.  An archive is a file that contains
data, it can be compressed or not, in a binary form or not.</em>
</p>

<hr>

<h4 id="s-BM_ARCHIVE_STRICTPURGE">2.1.3.1 <samp>BM_ARCHIVE_STRICTPURGE</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp>.</em>
</p>

<p>
As explained in the BM_REPOSITORY_ROOT section, every archive built by Backup
Manager will be purged when their lifetime expires.  In versions prior to
0.7.6, any archive were purged.
</p>

<p>
You can now choose to purge only the archive built in the scope of the
configuration file, that is: archives prefixed with BM_ARCHIVE_PREFIX.
</p>

<p>
This is useful if you share the same BM_REPOSITORY_ROOT with different
instances of Backup Manager that have different purging rules (eg: a
BM_REPOSITORY_ROOT shared over NFS for multiple Backup Manager configuration).
</p>

<p>
Example:
</p>

<pre>
     export BM_ARCHIVE_STRICTPURGE=&quot;true&quot;
</pre>

<hr>

<h4 id="s-BM_ARCHIVE_NICE_LEVEL">2.1.3.2 <samp>BM_ARCHIVE_NICE_LEVEL</samp></h4>

<p>
<em>Type: string, default: <samp>10</samp>.</em>
</p>

<p>
Backup Manager does handle several archive methods, which can use a lot of
ressources (mostly CPU); although this can be acceptable if Backup Manager is
run at night, on a always-running server, it can seriously slow-down a desktop
computer.  Indeed, most of the time, desktop users use anacron to run
backup-manager when possible, and most of time this is when the desktop is
actually used.
</p>

<p>
To enhance the desktop-experience when archives are built, you can adjust the
niceness used for archive creation with this configuration variable.
</p>

<p>
To set a low priority to the archive creation processes, use a high number
(max: 19).  See the manpage of nice for details.
</p>

<p>
Example:
</p>

<pre>
     export BM_ARCHIVE_NICE_LEVEL=&quot;19&quot; # recommanded for desktop users.
</pre>

<hr>

<h4 id="s-BM_ARCHIVE_PURGEDUPS">2.1.3.3 <samp>BM_ARCHIVE_PURGEDUPS</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp>.</em>
</p>

<p>
If disk usage matters in your backup strategy, you might find useful to use
Backup Manager's duplicates purging feature.  When an archive is generated,
Backup Manager looks at the previous versions of this archive.  If it finds
that a previous archive is the same file as the one it has just built, the
previous one is replaced by a symlink to the new one.  This is useful if you
don't want to have the same archive twice in the repository.
</p>

<p>
Example:
</p>

<pre>
     export BM_ARCHIVE_PURGEDUPS=&quot;true&quot;
     
     host-etc.20051115.tar.gz
     host-etc.20051116.tar.gz -&gt; /var/archives/host-etc.20051117.tar.gz
     host-etc.20051117.tar.gz
</pre>

<hr>

<h4 id="s-BM_ARCHIVE_TTL">2.1.3.4 <samp>BM_ARCHIVE_TTL</samp></h4>

<p>
<em>Type: integer, default: <samp>5</samp>.</em>
</p>

<p>
One of the main concepts behind the handling of the repository is to purge
deprecated archives automatically.  The purge session is always performed when
you launch Backup Manager.  During this phase, all archives older than the
authorized lifetime are dropped.
</p>

<p>
Since version 0.7.3, Backup Manager purges only files it has created whereas in
previous versions, it used to purge also other files within the repository.
</p>

<p>
Note that when using the incremental method for building archives, Backup
Manager will handle differently master backups and incremental ones.  The
incremental backups will be purged like any other archives (when exceeding the
authorized lifetime).  On the ohter hand, deprecated master backups won't be
purged unless there is a younger master backup in the repository.  Then, even
with a lifetime set to three days, a master backup will live more than three
days, until a newer master backup is built.
</p>

<p>
Example:
</p>

<pre>
     export BM_ARCHIVE_TTL=&quot;5&quot;
</pre>

<hr>

<h4 id="s-BM_REPOSITORY_RECURSIVEPURGE">2.1.3.5 <samp>BM_REPOSITORY_RECURSIVEPURGE</samp></h4>

<p>
<em>Type: boolean, default: <samp>false</samp>.</em>
</p>

<p>
On most setups, all the archives are stored in the top-level directory
specified by the configuration key <samp>BM_REPOSITORY_ROOT</samp>.  But it can
make sense to have subdirectories, for instance to store archives uploaded from
other hosts running Backup Manager.  In this case, it is possible to ask Backup
Manager to purge those directories too, by setting
<samp>BM_REPOSITORY_RECURSIVEPURGE</samp> to <samp>true</samp>.
</p>

<p>
Please note that the <samp>BM_ARCHIVE_TTL</samp> value is global, so if you
want to have different lifetimes for some archives, this is not the way to go.
In this case you should save them outside <samp>BM_REPOSITORY_ROOT</samp> and
write a cron job to do the purge (possibly calling <samp>backup-manager
--purge</samp> with an alternate configuration file).
</p>

<p>
Example:
</p>

<pre>
     export BM_REPOSITORY_RECURSIVEPURGE=&quot;false&quot;
</pre>

<hr>

<h4 id="s-BM_ARCHIVE_PREFIX">2.1.3.6 <samp>BM_ARCHIVE_PREFIX</samp></h4>

<p>
<em>Type: string, default: <samp>$HOSTNAME</samp>.</em>
</p>

<p>
This is the prefix used for naming archives.
</p>

<p>
Example:
</p>

<pre>
     export BM_ARCHIVE_PREFIX=&quot;$HOSTNAME&quot;
     
     # echo $HOSTNAME
     ouranos
     # ls /var/archives
     ouranos-20051123.md5 
     ouranos-usr-local-src.20051123.tar.gz
     ouranos-etc.20051123.tar.gz
</pre>

<hr>

<h2 id="s-methods">2.2 Backup Methods</h2>

<p>
The core feature of Backup Manager is to make archives, for doing this, a
<em>method</em> is used.  Each method can require a set of configuration keys.
We will describe here every method supported in the version 0.7.7.
</p>

<p>
The method you choose must be defined in the configuration key
<samp>BM_ARCHIVE_METHOD</samp>.  You can put here a list of all the different
methods you want to use.  Take care to put every configuration key needed by
all the methods you choose.  Note that you can also choose none of the proposed
methods, if you don't want to build archives with this configuration file, then
just put <samp>none</samp>.
</p>

<p>
A couple of other configuration keys may be needed depending on the method you
choose.
</p>

<p>
Example:
</p>

<pre>
     export BM_ARCHIVE_METHOD=&quot;tarball-incremental mysql&quot;
</pre>

<hr>

<h3 id="s-tarball">2.2.1 Tarballs</h3>

<hr>

<h4 id="s-tarball-desc">2.2.1.1 Description</h4>

<p>
<em>Method name: <samp>tarball</samp>, configuration key prefix:
<samp>BM_TARBALL</samp>.</em>
</p>

<p>
If all you want to do is to handle a couple of tarballs of your file system,
you can use this method.  This method takes a list of directories and builds
the corresponding tarballs.  This method is the default one, this is the
easiest to use, it just builds tarballs as you could do with your own tar
script.  Its main drawback is to eat a lot of disk space: archives can be big
from a day to another, even if there are no changes in their content.  See the
<samp>tarball-incremental</samp> method if you want to optimize archives' size.
</p>

<p>
When building full backups (when not building incremental ones), Backup Manager
will append the keyword &quot;master&quot; to the name of the archive.  This is
very useful when using the <samp>tarball-incremental</samp> method for seeing
where the full backups are quickly.
</p>

<p>
A couple of options are available: the name format of the archive, the
compression type (gzip, zip, bzip2, none) and the facility to dereference
symlinks when building the tarball.
</p>

<hr>

<h4 id="s-BM_TARBALL_NAMEFORMAT">2.2.1.2 <samp>BM_TARBALL_NAMEFORMAT</samp></h4>

<p>
This configuration key defines how to perform the naming of the archive.  Two
values are possible:
</p>
<ul>
<li>
<p>
<samp>long</samp>: the name will be made with the absolute path of the
directory (eg: <samp>var-log-apache</samp> for <samp>/var/log/apache</samp>).
</p>
</li>
</ul>
<ul>
<li>
<p>
<samp>short</samp>: the name will just contain the directory (eg:
<samp>apache</samp> for <samp>/var/log/apache</samp>).
</p>
</li>
</ul>

<p>
Suggested value: <samp>long</samp>.
</p>

<hr>

<h4 id="s-BM_TARBALL_FILETYPE">2.2.1.3 <samp>BM_TARBALL_FILETYPE</samp></h4>

<p>
<em>Type: enum(tar, tar.gz, tar.bz2, tar.lz, zip, dar), default:
<samp>tar.gz</samp>.</em>
</p>

<p>
Basically, this configuration key defines the filetype of the resulting
archive.  In a way, it defines which compressor to use (zip, gzip, dar or
bzip2).  Here are the supported values: <samp>tar</samp>, <samp>tar.gz</samp>,
<samp>tar.bz2</samp>, <samp>zip</samp> and <samp>dar</samp>.  Note that
depending on the filetype you choose, you will have to make sure you have the
corresponding compressor installed.
</p>

<p>
For the best compression rate, choose <samp>tar.bz2</samp> or
<samp>tar.lz</samp>.
</p>

<p>
Since version 0.7.1, Backup Manager supports <em>dar</em> archives.  This
archiver provides some interesting features like the archive slicing.
</p>

<p>
Since version 0.7.5, Backup Manager supports <em>lzma</em> archives.
</p>

<p>
Make sure to statisfy dependencies according to the filetype you choose:
</p>
<ul>
<li>
<p>
tar.bz2 : needs &quot;bzip2&quot;.
</p>
</li>
</ul>
<ul>
<li>
<p>
tar.lz : needs &quot;lzma&quot;.
</p>
</li>
</ul>
<ul>
<li>
<p>
dar : needs &quot;dar&quot;.
</p>
</li>
</ul>
<ul>
<li>
<p>
zip : needs &quot;zip&quot;.
</p>
</li>
</ul>

<hr>

<h4 id="s-BM_TARBALL_SLICESIZE">2.2.1.4 <samp>BM_TARBALL_SLICESIZE</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
If you want to make sure your archives won't exceed a given size (for instance
2 GB) you can use that configuration variable, but only if you are using the
<samp>dar</samp> <samp>BM_TARBALL_FILETYPE</samp>.  Indeed this feature is only
supported by dar.
</p>

<p>
If you want to limit your archives size to 1 giga byte, use such a statement:
</p>

<pre>
     BM_TARBALL_SLICESIZE=&quot;1000M&quot;
</pre>

<p>
Refer to the dar manpage for details about slices.
</p>

<hr>

<h4 id="s-BM_TARBALL_EXTRA_OPTIONS">2.2.1.5 <samp>BM_TARBALL_EXTRA_OPTIONS</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
If you want to provide extra options to &quot;tar&quot; or &quot;dar&quot; you
may do so here.  Leave blank unless you know what you are doing.
</p>

<p>
Example: to enable verbosity with tar (which would appeard in the logfiles),
use this:
</p>

<pre>
     BM_TARBALL_EXTRA_OPTIONS=&quot;-v&quot;
</pre>

<hr>

<h4 id="s-BM_TARBALL_DUMPSYMLINKS">2.2.1.6 <samp>BM_TARBALL_DUMPSYMLINKS</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp>.</em>
</p>

<p>
It is possible, when generating the tarball (or the zip file) to dereference
the symlinks.  If you enable this feature, every symbolic link in the file
system will be replaced in the archive by the file it points to.  Use this
feature with care, it can quickly lead to huge archives, or even worse: if you
have a circular symlink somewhere, this will lead to an infinite archive!
</p>

<p>
In most of the cases, you should not use this feature.
</p>

<hr>

<h4 id="s-BM_TARBALL_DIRECTORIES">2.2.1.7 <samp>BM_TARBALL_DIRECTORIES</samp></h4>

<p>
<em>Type: space-separated list, default: <samp>null</samp>.</em>
</p>

<p>
Since version 0.7.3, this variable is replaced by the array
BM_TARBALL_TARGETS[], it's still supported for backward compatibility though.
You can use this variable for defining the locations to backup, but you must
not use this variable if one or more of the paths you want to archive contain a
space.
</p>

<p>
If you want to backup some targets that have spaces in their name (eg
&quot;Program Files&quot;), you must not use this variable, but the array
BM_TARBALL_TARGETS[] instead.
</p>

<p>
Example:
</p>

<pre>
     export BM_TARBALL_DIRECTORIES=&quot;/etc /home /var/log/apache&quot;
</pre>

<hr>

<h4 id="s-BM_TARBALL_TARGETS">2.2.1.8 <samp>BM_TARBALL_TARGETS</samp></h4>

<p>
<em>Type: array, default: <samp>&quot;/etc&quot;,
&quot;/boot&quot;</samp>.</em>
</p>

<p>
This variable holds every place you want to backup.  This is the recommanded
variable to use for defining your backup targets
(<samp>BM_TARBALL_DIRECTORIES</samp> is deprecated since version 0.7.3).
</p>

<p>
You can safely put items that contain spaces (eg: &quot;Program Files&quot;)
whereas you can't with <samp>BM_TARBALL_DIRECTORIES</samp>.
</p>

<p>
You can also put Bash patterns in BM_TARBALL_TARGETS[], it will be expanded at
runtime to find the resulting targets.  For instance :
BM_TARBALL_TARGETS[0]=&quot;/home/*&quot; will lead to backup every home's
sub-directory.
</p>

<p>
Example
</p>

<pre>
     BM_TARBALL_TARGETS[0]=&quot;/etc&quot;
     BM_TARBALL_TARGETS[1]=&quot;/home/*&quot;
     BM_TARBALL_TARGETS[2]=&quot;/boot&quot;
     BM_TARBALL_TARGETS[3]=&quot;/mnt/win/Program Files&quot;
</pre>

<hr>

<h4 id="s-BM_TARBALL_BLACKLIST">2.2.1.9 <samp>BM_TARBALL_BLACKLIST</samp></h4>

<p>
<em>Type: space-separated list, default: <samp>&quot;/proc /dev /sys
/tmp&quot;</samp>.</em>
</p>

<p>
It can be very useful to prevent some locations of your filesytem from being
included in the archives.  This is really useful when you use wildcards in
BM_TARBALL_DIRECTORIES.  Indeed, you may want to backup every top-level
directory of your filesystem (<samp>/*</samp>) but without volatile locations
like <samp>/tmp</samp>, <samp>/dev</samp> and <samp>/proc</samp>.
</p>

<p>
You can also use this variable for excluding every files of a given extension,
like for instance mp3 or mpg files.
</p>

<p>
Example:
</p>

<pre>
     export BM_TARBALL_BLACKLIST=&quot;/tmp /dev /proc *.mp3 *.mpg&quot;
</pre>

<hr>

<h4 id="s-BM_TARBALL_OVER_SSH">2.2.1.10 <samp>BM_TARBALL_OVER_SSH</samp></h4>

<p>
<em>Type: boolean, default: <samp>false</samp>.</em>
</p>

<p>
<strong>Dependency: <samp>BM_UPLOAD_SSH</samp></strong>
</p>

<p>
If you want to archive some remote locations from a server where Backup Manager
is insalled, you can choose to build archives over SSH.  This is useful if you
don't want to install Backup Manager every where and setup some upload methods
from all thoses servers to a central data storage server.  This way, Backup
Manager will build some archives directly over SSH and will store the resulting
tarballs locally, as if it was built like any other archive.  The resulting
archive will be prefixed with the remote hostname instead of
<samp>BM_ARCHIVE_PREFIX</samp>.
</p>

<p>
This feature requires that the following variables are set in the BM_UPLOAD_SSH
section:
</p>
<ul>
<li>
<p>
<samp>BM_UPLOAD_SSH_USER</samp>: the user to use for connecting to the remote
server.  Note that this user will run tar remotely, so take care to archive
something this user can read!
</p>
</li>
</ul>
<ul>
<li>
<p>
<samp>BM_UPLOAD_SSH_KEY</samp>: as usal, the path to the private key to use for
establishing the connection.
</p>
</li>
</ul>
<ul>
<li>
<p>
<samp>BM_UPLOAD_SSH_HOSTS</samp>: A list of hosts where to run the tarball
builds.
</p>
</li>
</ul>

<p>
If you enable this feature, note that the resulting configuration file will
have the following restrictions:
</p>
<ul>
<li>
<p>
Remote tarball build only works with the <samp>tarball</samp> method, it will
silently behaves the same with <samp>tarball-incremental</samp>.
</p>
</li>
</ul>
<ul>
<li>
<p>
You cannot use the remote build and the local one in the same configuration
file.  If you want to do both, use two configuration files.
</p>
</li>
</ul>

<p>
Example: You have three hosts: host01, host02 and host03.  You want to set up
host01 as a data storage server, it has a big /var/archives partition.  You
want to archive &quot;/etc&quot;, &quot;/home&quot; and &quot;/var/log&quot; on
box02 and box03 and store the archives on host01.
</p>

<pre>
     [...]
     export BM_ARCHIVE_METHOD=&quot;tarball&quot;
     
     export BM_TARBALL_OVER_SSH=&quot;true&quot;
     export BM_TARBALL_FILETYPE=&quot;tar.bz2&quot;
     export BM_TARBALL_DIRECTORIES=&quot;/etc /home /var/log&quot;
     
     export BM_UPLOAD_SSH_USER=&quot;bamuser&quot;
     export BM_UPLOAD_SSH_KEY=&quot;/home/bamuser/.ssh/id_dsa&quot;
     export BM_UPLOAD_SSH_HOSTS=&quot;box02 box03&quot;
</pre>

<p>
Of course, for this to work correctly, <samp>`bamuser'</samp> should be a valid
user on box02 and box03; it must be allowed to connect to them with SSH key
autentication and has to be able to read those directories.
</p>

<hr>

<h3 id="s-tarballinc">2.2.2 Incremental tarballs</h3>

<hr>

<h4 id="s-tarballinc-desc">2.2.2.1 Description</h4>

<p>
<em>Method name: <samp>tarball-incremental</samp>, configuration key prefix:
<samp>BM_TARBALLINC</samp>.</em>
</p>

<p>
If you want to handle tarballs without wasting disk space, you should use this
method.  The concept of this method is simple: You choose a frequency when a
full backup is made (exactly like the one made by the tarball mehod).  All the
days between two full backups, archives contain only the files that have
changed from the previous archive.
</p>

<p>
For instance, let's say you want to backup /home with this method.  Your /home
directory is composed by two sub-directories: /home/foo and /home/bar.  You
choose a weekly frequency and say that monday will be the
&quot;fullbackup&quot; day.  Obviously, you will have a full tarball of /home
on monday.  Then, if a file changed inside /home/foo and if /home/bar remains
unchanged, tuesday's archive will only contain the modified files of /home/foo.
Using this method will save a lot of disk space.
</p>

<p>
To build incremental tarballs, Backup Manager uses tar's switch
<samp>--listed-incremental</samp>.  This will create a file for each target
which will contain some statistics used by tar to figure out if a file should
be backed up or not.  When Backup Manager is run for the first time, this file
doesn't exist, so the first tarballs made are always master backups.  If the
<em>incremental list</em> files get removed, the next backups won't be
incremental.
</p>

<p>
Since version 0.7.3, it's possible to see at the first glance if a backup is a
master or an incremental one: master backup have the keyword
<samp>master</samp> appended to the date.  When purging the repository, the
master backups are not removed as the incremental ones.  Backup Manager always
keep a master backup that is older than incremental archives.
</p>

<p>
This method uses all the tarball's configuration keys and adds two more.  One
to define the kind of frequency, the other to choose on which day the full
backups should be done.
</p>

<hr>

<h4 id="s-BM_TARBALLINC_MASTERDATETYPE">2.2.2.2 <samp>BM_TARBALLINC_MASTERDATETYPE</samp></h4>

<p>
<em>Type: enum(weekly, monthly), default: <samp>weekly</samp>.</em>
</p>

<p>
This is the type of frequency you want to use.  If you choose
<samp>weekly</samp>, you'll have to choose a day number between 0 and 6 for the
BM_TARBALLINC_MASTERDATEVALUE configuration key, if you choose
<samp>monthly</samp>, the day number will be between 1 and 31.
</p>

<hr>

<h4 id="s-BM_TARBALLINC_MASTERDATEVALUE">2.2.2.3 <samp>BM_TARBALLINC_MASTERDATEVALUE</samp></h4>

<p>
<em>Type: integer, default: <samp>1</samp>.</em>
</p>

<p>
The number of the day when making full backups.  Note that its meaning directly
depends on the <samp>BM_TARBALLINC_MASTERDATETYPE</samp>.  For instance, 1
means <em>&quot;monday&quot;</em> if you choose a weekly frequency, but it
means <em>&quot;the first day of the month&quot;</em> if you choose a monthly
frequency.
</p>

<hr>

<h3 id="s-mysql">2.2.3 MySQL databases</h3>

<hr>

<h4 id="s-mysql-desc">2.2.3.1 Description</h4>

<p>
<em>Method name: <samp>mysql</samp>, configuration keys prefix:
<samp>BM_MYSQL</samp>.</em>
</p>

<p>
This method provides a way to archive MySQL databases, the archives are made
with mysqldump (SQL text files) and can be compressed.
</p>

<p>
In versions prior to 0.7.6, Backup Manager used to pass the MySQL client's
password through the command line.  As explained by the MySQL manual, that's a
security issue as the password is then readable for a short time in the /proc
directory (or using the ps command).
</p>

<p>
To close that vulnerability, the MySQL client password is not passed through
the command line anymore, it is written in a configuration file located in the
home directory of the user running Backup Manager : <samp>~/.my.cnf</samp>.
</p>

<p>
If that file doesn't exist at runtime, Backup Manager will create it and will
then write the password provided in <samp>BM_MYSQL_ADMINPASS</samp> inside.
</p>

<hr>

<h4 id="s-BM_MYSQL_DATABASES">2.2.3.2 <samp>BM_MYSQL_DATABASES</samp></h4>

<p>
<em>Type: space-separated list, default: <samp>__ALL__</samp>.</em>
</p>

<p>
This is the list of databases you want to archive.  You can put the keyword
<samp>__ALL__</samp> if you like to backup every database without having to
list them.
</p>

<p>
Example:
</p>

<pre>
     export BM_MYSQL_DATABASES=&quot;mysql mybase wordpress dotclear phpbb2&quot;
</pre>

<hr>

<h4 id="s-BM_MYSQL_SAFEDUMPS">2.2.3.3 <samp>BM_MYSQL_SAFEDUMPS</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp>.</em>
</p>

<p>
The best way to produce MySQL dumps is done by using mysqldump's
<samp>--opt</samp> switch.  This makes the dump directly usable with mysql
(adds the drop table statements), locks tables during the dump generation and
other cool things (see <samp>mysqldump</samp>).  This is recommended for
full-clean-safe backups, but needs a privileged user (for the lock
permissions).
</p>

<p>
Example:
</p>

<pre>
     export BM_MYSQL_SAFEDUMPS=&quot;true&quot;
</pre>

<hr>

<h4 id="s-BM_MYSQL_ADMINLOGIN">2.2.3.4 <samp>BM_MYSQL_ADMINLOGIN</samp></h4>

<p>
<em>Type: string, default: <samp>root</samp>.</em>
</p>

<p>
The MySQL login you want to use for connecting to the database.  Make sure this
login can read all the databases you've set in <samp>BM_MYSQL_DATABASES</samp>.
</p>

<p>
Example:
</p>

<pre>
     export BM_MYSQL_ADMINLOGIN=&quot;root&quot;
</pre>

<hr>

<h4 id="s-BM_MYSQL_ADMINPASS">2.2.3.5 <samp>BM_MYSQL_ADMINPASS</samp></h4>

<p>
<em>Type: string, default: <samp>undefined</samp>.</em>
</p>

<p>
The MySQL client password.
</p>

<p>
If you have already made your own ~/.my.cnf configuration file, you don't have
to set that variable.
</p>

<p>
If you don't know what is the <samp>~/.my.cnf</samp> configuration file, set
the password, then Backup Manager will take care of creating the MySQL client
configuration file.
</p>

<p>
Example:
</p>

<pre>
     export BM_MYSQL_ADMINPASS=&quot;MySecretPass&quot;
</pre>

<hr>

<h4 id="s-BM_MYSQL_HOST">2.2.3.6 <samp>BM_MYSQL_HOST</samp></h4>

<p>
<em>Type: string, default: <samp>localhost</samp>.</em>
</p>

<p>
The database host where the databases are.
</p>

<p>
Example:
</p>

<pre>
     export BM_MYSQL_HOST=&quot;localhost&quot;
</pre>

<hr>

<h4 id="s-BM_MYSQL_PORT">2.2.3.7 <samp>BM_MYSQL_PORT</samp></h4>

<p>
<em>Type: string, default: <samp>3306</samp>.</em>
</p>

<p>
The port on <samp>BM_MYSQL_HOST</samp> where the mysql server is listening.
</p>

<p>
Example:
</p>

<pre>
     export BM_MYSQL_PORT=&quot;3306&quot;
</pre>

<hr>

<h4 id="s-BM_MYSQL_FILETYPE">2.2.3.8 <samp>BM_MYSQL_FILETYPE</samp></h4>

<p>
<em>Type: enum(gzip, bzip2), default: <samp>bzip2</samp>.</em>
</p>

<p>
The archive is made with mysqldump which renders SQL lines; the resulting text
file can be compressed.  If you want to compress the file, choose the
compressor you want.  Leave it blank if you want pure SQL files.
</p>

<p>
Example:
</p>

<pre>
     export BM_MYSQL_FILETYPE=&quot;bzip2&quot;
</pre>

<hr>

<h3 id="s-svn">2.2.4 Subversion repositories</h3>

<hr>

<h4 id="s-svn-desc">2.2.4.1 Description</h4>

<p>
You can archive Subversion repositories with this method.  The archive will be
made with <samp>svnadmin</samp> and will contain XML data (text files).  Like
the mysql method, you can choose to compress it.
</p>

<hr>

<h4 id="s-BM_SVN_REPOSITORIES">2.2.4.2 <samp>BM_SVN_REPOSITORIES</samp></h4>

<p>
<em>Type: space-separated list</em>
</p>

<p>
This is the list of absolute paths to the SVN repositories to archive.
</p>

<p>
Example:
</p>

<pre>
     export BM_SVN_REPOSITORIES=&quot;/srv/svnroot/repo1 /srv/svnroot/repo2&quot;
</pre>

<hr>

<h4 id="s-BM_SVN_COMPRESSWITH">2.2.4.3 <samp>BM_SVN_COMPRESSWITH</samp></h4>

<p>
<em>Type: enum(gzip, bzip2), default: <samp>bzip2</samp>.</em>
</p>

<p>
If you want to compress the resulting XML files, choose a compressor here.
Leave this blank if you don't want any compression.
</p>

<p>
Example:
</p>

<pre>
     export BM_SVN_COMPRESSWITH=&quot;gzip&quot;
</pre>

<hr>

<h3 id="s-pipe">2.2.5 Generic methods</h3>

<hr>

<h4 id="s-pipe-desc">2.2.5.1 Description</h4>

<p>
Even if most of the common needs are covered by the existing methods, there is
always a case uncovered.  Backup Manager provides a way for backing up
anything, and can be used in such circumstances.
</p>

<p>
This method is called <samp>pipe</samp>, it is more complex to use but can
virtually backup anything.  The concept is simple, a pipe method is defined by
the following items:
</p>
<ul>
<li>
<p>
A name (for naming the archive)
</p>
</li>
</ul>
<ul>
<li>
<p>
A command (that produces content on stdout)
</p>
</li>
</ul>
<ul>
<li>
<p>
A file type (txt, sql, dump, ...)
</p>
</li>
</ul>
<ul>
<li>
<p>
A compressor (gzip, bzip2)
</p>
</li>
</ul>

<p>
Those configuration keys are arrays, so you can implement as many pipe methods
as you like.
</p>

<p>
For each pipe method defined, Backup Manager will launch the command given and
redirect the content sent to stdout by this command to a file named with the
name of the method and its filetype.  Then, if the method uses a compressor,
the file will be compressed.
</p>

<hr>

<h4 id="s-pipe-example">2.2.5.2 Example</h4>

<p>
Example for archiving a remote MySQL database through SSH:
</p>

<pre>
     BM_PIPE_COMMAND[0]=&quot;ssh host -c \&quot;mysqldump -ufoo -pbar base\&quot;&quot; 
     BM_PIPE_NAME[0]=&quot;base&quot; 
     BM_PIPE_FILETYPE[0]=&quot;sql&quot;
     BM_PIPE_COMPRESS[0]=&quot;gzip&quot;
</pre>

<p>
Imagine you have a second pipe method to implement, for instance building a
tarball trough SSH:
</p>

<pre>
     BM_PIPE_COMMAND[1]=&quot;ssh host -c \&quot;tar -c -z /home/user\&quot;&quot; 
     BM_PIPE_NAME[1]=&quot;host.home.user&quot; 
     BM_PIPE_FILETYPE[1]=&quot;tar.gz&quot;
     BM_PIPE_COMPRESS[1]=&quot;&quot;
</pre>

<p>
Note that we have incremented the array's index.
</p>

<hr>

<h2 id="s-uploads">2.3 Upload Methods</h2>

<hr>

<h3 id="s-uploads-desc">2.3.1 Description</h3>

<p>
<em>One of the most important thing to do when backing up file systems is to
store the archives on different places.  The more different physical spaces you
have, the better.  Backup Manager provides a way for achieving this goal : the
upload methods.</em>
</p>

<p>
There are different upload methods, each of them behaves differently and
provides particular features.  In Backup Manager 0.7.7 you can use FTP, SSH,
RSYNC or Amazon S3 uploads.
</p>

<p>
In the same manner as for backup methods, you can choose to use as many upload
methods as you like.  If you don't want to use this feature at all, just put
the keyword <samp>none</samp> in the configuration
<samp>BM_UPLOAD_METHOD</samp>.
</p>

<p>
Note that the FTP, SSH and S3 methods are dedicated to upload archives, using
those method depends on the use of at least one backup method.
</p>

<p>
On the opposite, the RSYNC method uploads a directory to remote locations, this
directory can be your repository or whatever other location of your file sytem.
</p>

<hr>

<h3 id="s-uploads-global">2.3.2 Global configuration keys</h3>

<p>
The following configuration keys are global in the upload section:
</p>

<hr>

<h4 id="s-BM_UPLOAD_HOSTS">2.3.2.1 <samp>BM_UPLOAD_HOSTS</samp></h4>

<p>
<em>Type: space-separated list</em>
</p>

<p>
Each of the hosts defined in that list is used by all the upload methods when
establishing connections.  For instance if you want to perform SSH uploads of
your archives and RSYNC upload of a location to the same host, put it in this
list.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_HOSTS=&quot;mirror1.lan.mysite.net mirror2.lan.mysite.net&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_DESTINATION">2.3.2.2 <samp>BM_UPLOAD_DESTINATION</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
This is the absolute path of the directory in the remote hosts where to put the
files uploaded.
</p>

<p>
If you have installed installed Backup Manager on the remote host, a good idea
is to choose a sub-directory of the repository.  Then, during the remote host
purge phase, your uploads will be cleaned at the same time.
</p>

<p>
You can also define a destination dedicated to your host:
<samp>BM_UPLOAD_DESTINATION=&quot;/var/archives/$HOSTNAME&quot;</samp>
</p>

<p>
Example:
</p>

<p>
Let's say you want that all your uploads are performed on the host
mirror2.lan.mysite.net, in the sub-directory /var/archives/uploads
</p>

<pre>
     export BM_UPLOAD_HOSTS=&quot;mirror2.lan.mysite.net&quot;
     export BM_UPLOAD_DESTINATION=&quot;/var/archives/uploads&quot;
</pre>

<hr>

<h3 id="s-upload-ssh">2.3.3 SSH uploads</h3>

<hr>

<h4 id="s-uploads-ssh-desc">2.3.3.1 Description</h4>

<p>
<em>Method name: <samp>ssh</samp>, goal: upload archives to remote hosts over
SSH.  This method depends on a backup method.</em>
</p>

<p>
If you want to upload your archives on remote locations, you can use the SSH
method.  This method is good if you like to use a secure tunnel between the two
points of the upload.
</p>

<p>
The call to <samp>scp</samp> will be done with the identity of the user
<samp>BM_UPLOAD_SSH_USER</samp>, thus, you have to make sure this user can have
access to the repository (take care to the secure mode).
</p>

<hr>

<h4 id="s-BM_UPLOAD_SSH_USER">2.3.3.2 <samp>BM_UPLOAD_SSH_USER</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
This is the user to use for performing the ssh connection.  Make sure this user
can access repository.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_SSH_USER=&quot;bmngr&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_SSH_KEY">2.3.3.3 <samp>BM_UPLOAD_SSH_KEY</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
This is the path to the private key of the user BM_UPLOAD_SSH_USER.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_SSH_KEY=&quot;/home/bmngr/.ssh/id_dsa&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_SSH_PORT">2.3.3.4 <samp>BM_UPLOAD_SSH_PORT</samp></h4>

<p>
<em>Type: integer</em>
</p>

<p>
You may want to connect to remote hosts with a specific port.  Use this
configuration key then.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_SSH_PORT=&quot;1352&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_SSH_HOSTS">2.3.3.5 <samp>BM_UPLOAD_SSH_HOSTS</samp></h4>

<p>
<em>Type: space-separated list</em>
</p>

<p>
Put here the list of hosts to use for SSH-only uploads.  Note that if you put
some hosts in <samp>BM_UPLOAD_HOSTS</samp>, they will be used as well.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_SSH_HOSTS=&quot;mirror3.lan.mysite.net&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_SSH_PURGE">2.3.3.6 <samp>BM_UPLOAD_SSH_PURGE</samp></h4>

<p>
<em>Type: boolean</em>
</p>

<p>
If you set this boolean to &quot;true&quot;, the remote archives will be purged
before the new ones are uploaded.  The purging rules are the same as the ones
Backup Manager uses for local purging.  If <samp>BM_UPLOAD_SSH_TTL</samp> is
defined, this time to live will be used, else <samp>BM_ARCHIVE_TTL</samp> will
be used.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_SSH_PURGE=&quot;true&quot;
     export BM_UPLOAD_SSH_TTL=&quot;10&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_SSH_DESTINATION">2.3.3.7 <samp>BM_UPLOAD_SSH_DESTINATION</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
Put here the destination for SSH-only uploads, this key overrides
<samp>BM_UPLOAD_DESTINATION</samp>.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_SSH_DESTINATION=&quot;/var/archives/scp-uploads&quot;
</pre>

<hr>

<h3 id="s-upload-ssh-gpg">2.3.4 Encrypted SSH uploads</h3>

<hr>

<h4 id="s-upload-ssh-gpg-desc">2.3.4.1 Description</h4>

<p>
<em>Method name: <samp>ssh-gpg</samp>, goal: encrypt arcives using public key
encryption and upload the result to untrusted remote hosts over SSH.  This
method depends on a backup method.</em>
</p>

<p>
The upload using SSH can also be combined with public key encryption provided
by <samp>gpg</samp>.  The archives will be encrypted using a public key prior
to sending them over the network, so on the remote server your files are
protected from inspection.
</p>

<p>
This method can be used to protect your data from inspection on untrusted
remote servers.  However, since the encrypted files are not signed, this does
not protect you from archive manipulation.  So the <em>md5</em> hases are still
needed.
</p>

<p>
This method uses all of the configuartion keys of the <em>ssh</em> method.  One
additional key is required.
</p>

<hr>

<h4 id="s-BM_UPLOAD_SSH_GPG_RECIPIENT">2.3.4.2 <samp>BM_UPLOAD_SSH_GPG_RECIPIENT</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
This parameter sets the recipient for which the archive is encrypted.  A valid
specification is a short or long key id, or a descriptive name, as explained in
the <samp>gpg</samp> man page.  The public key for this identity must be in the
key ring of the user running <samp>gpg</samp>, which is the same as specified
by <samp>BM_UPLOAD_SSH_USER</samp>.  To test this run the command <samp>gpg
--list-keys ID</samp> as that user, where <samp>ID</samp> is the ID as you give
it to this parameter.  If <samp>gpg</samp> displays exactly one key, then you
are fine.  Refer to the <samp>gpg</samp> man page for further details.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_SSH_GPG_RECIPIENT=&quot;email@address.com&quot;
     export BM_UPLOAD_SSH_GPG_RECIPIENT=&quot;ECE009856&quot;
</pre>

<hr>

<h3 id="s-upload-ftp">2.3.5 FTP uploads</h3>

<hr>

<h4 id="s-uploads-ftp-desc">2.3.5.1 Description</h4>

<p>
If security does not matter much on your lan (between the two points of the
upload) you can choose to use the FTP method.  One of the main pros of this
method is that it can perform purging independently.  You can safely use this
method for uploading files to a host where you just have an FTP account.
</p>

<hr>

<h4 id="s-BM_UPLOAD_FTP_SECURE">2.3.5.2 <samp>BM_UPLOAD_FTP_SECURE</samp></h4>

<p>
<em>Type: boolean, default: false.</em>
</p>

<p>
If this variable is set to true, all FTP transfers will be done over SSL.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_FTP_SECURE=&quot;true&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_FTP_PASSIVE">2.3.5.3 <samp>BM_UPLOAD_FTP_PASSIVE</samp></h4>

<p>
<em>Type: boolean, default: true.</em>
</p>

<p>
If this variable is set to true, FTP transfers will be performed in passive
mode, which is mandatory in NATed/firewalled environments.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_FTP_PASSIVE=&quot;true&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_FTP_TTL">2.3.5.4 <samp>BM_UPLOAD_FTP_TTL</samp></h4>

<p>
<em>Type: integer, default: $BM_ARCHIVE_TTL</em>
</p>

<p>
Using different <em>time to live</em> values for local and remote archives can
be useful in certain situations.  For instance, it's possible to install Backup
Manager locally, make it build archives, upload them to a remote FTP host and
then purge them locally (but not on the remote host).  Doing this is possible
with setting a null value to the local TTL (BM_ARCHIVE_TTL) and a non-null
value to BM_UPLOAD_FTP_TTL.
</p>

<p>
Example:
</p>

<pre>
     # in your main conffile -- /etc/backup-manager.conf
     export BM_ARCHIVE_TTL=&quot;0&quot;
     export BM_UPLOAD_FTP_TTL=&quot;5&quot;
     export BM_POST_BACKUP_COMMAND=&quot;/usr/sbin/backup-manager --purge&quot;
     
     # in your cron job:
     /usr/sbin/backup-manager
     /usr/sbin/backup-manager --purge
     
     (Don't put the post-command in the main conffile or you'll face an infinite loop.)
</pre>

<hr>

<h4 id="s-BM_UPLOAD_FTP_USER">2.3.5.5 <samp>BM_UPLOAD_FTP_USER</samp></h4>

<p>
<em>Type: string.</em>
</p>

<p>
Put here the FTP user to use for opening the connections.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_FTP_USER=&quot;bmngr&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_FTP_PASSWORD">2.3.5.6 <samp>BM_UPLOAD_FTP_PASSWORD</samp></h4>

<p>
<em>Type: string.</em>
</p>

<p>
Put here the password to use for authenticating the FTP session,(in plain
text).
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_FTP_PASSWORD=&quot;secret&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_FTP_HOSTS">2.3.5.7 <samp>BM_UPLOAD_FTP_HOSTS</samp></h4>

<p>
<em>Type: space-separated list</em>
</p>

<p>
Put here the list of hosts to use for FTP-only uploads.  Note that if you put
some hosts in <samp>BM_UPLOAD_HOSTS</samp>, they will be used as well.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_FTP_HOSTS=&quot;mirror4.lan.mysite.net&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_FTP_DESTINATION">2.3.5.8 <samp>BM_UPLOAD_FTP_DESTINATION</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
Put here the destination for FTP-only uploads, this key overrides
<samp>BM_UPLOAD_DESTINATION</samp>.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_FTP_DESTINATION=&quot;/var/archives/ftp-uploads&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_FTP_PURGE">2.3.5.9 <samp>BM_UPLOAD_FTP_PURGE</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp></em>
</p>

<p>
You can choose to purge deprecated archives before uploading new ones.  This
purge is done over FTP and uses the configuration key
<samp>BM_ARCHIVE_TTL</samp> in the same manner as the local purge behaves (the
FTP purge is not recursive though).
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_FTP_PURGE=&quot;true&quot;
</pre>

<hr>

<h3 id="s-upload-s3">2.3.6 Amazon S3 uploads</h3>

<hr>

<h4 id="s-uploads-s3-desc">2.3.6.1 Description</h4>

<p>
Amazon's new Simple Storage Service (S3) is an Internet &quot;web service&quot;
that permits you to store unlimited blocks of data on their replicated and
managed systems.  See http://aws.amazon.com for more information.  Registration
is free and the rates are quite reasonable.
</p>

<p>
Using the S3 upload method will permit your archives to be stored on Amazon's
S3 service.  You must allocate a &quot;bucket&quot; to the exclusive use of
Backup Manager.  Each of your created archives will be uploaded to S3 and
stored within this bucket in a key name that matches the name of the archive.
</p>

<p>
As with the other backup methods Backup Manager does not assist you in
restoring files from archives.  You must retrieve archives from S3 using other
mechanisms such as the S3Shell provided as an examle command line utility by
Amazon.
</p>

<p>
Note that when using this upload method, the <samp>BM_UPLOAD_HOSTS</samp>
variable is ignored as the only valid host for S3 uploads in
<samp>s3.amazon.com</samp>.
</p>

<hr>

<h4 id="s-BM_UPLOAD_S3_DESTINATION">2.3.6.2 <samp>BM_UPLOAD_S3_DESTINATION</samp></h4>

<p>
<em>Type: string.</em>
</p>

<p>
This option is required for the S3 upload method.  This specifies the bucket
used to store backup data.  If the bucket does not exist it will be created as
a private bucket.  This key overrides <samp>BM_UPLOAD_DESTINATION</samp>.  Note
that Amazon requires that bucket names be globally unique.  Be creative picking
one.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_S3_DESTINATION=&quot;my_backup_bucket&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_S3_ACCESS_KEY">2.3.6.3 <samp>BM_UPLOAD_S3_ACCESS_KEY</samp></h4>

<p>
<em>Type: string.</em>
</p>

<p>
This option is required for the S3 upload method.  After you have registered
Amazon will provide you an access key.  You must use this key to access your
storage on S3.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_S3_ACCESS_KEY=&quot;a9sabkz0342dasv&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_S3_SECRET_KEY">2.3.6.4 <samp>BM_UPLOAD_S3_SECRET_KEY</samp></h4>

<p>
<em>Type: string.</em>
</p>

<p>
This option is required for the S3 upload method.  After you have registered
Amazon will provide you a secret key.  You must use this key to write to your
storage on S3.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_S3_SECRET_KEY=&quot;lkj2341askj123sa&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_S3_PURGE">2.3.6.5 <samp>BM_UPLOAD_S3_PURGE</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp></em>
</p>

<p>
You can choose to purge deprecated archives before uploading new ones.  This
purge is done over S3 and uses the configuration key
<samp>BM_ARCHIVE_TTL</samp> in the same manner as the local purge behaves (the
S3 purge is not recursive though).
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_S3_PURGE=&quot;true&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_S3_TTL">2.3.6.6 <samp>BM_UPLOAD_S3_TTL</samp></h4>

<p>
<em>Type: integer, default: $BM_ARCHIVE_TTL</em>
</p>

<p>
Using different <em>time to live</em> values for local and remote archives can
be useful in certain situations.  For instance, it's possible to install Backup
Manager locally, make it build archives, upload them to S3 and then purge them
locally (but not on the remote host).  Doing this is possible with setting a
null value to the local TTL (BM_ARCHIVE_TTL) and a non-null value to
BM_UPLOAD_S3_TTL.
</p>

<hr>

<h3 id="s-upload-rsync">2.3.7 RSYNC uploads</h3>

<hr>

<h4 id="s-upload-rsync-desc">2.3.7.1 Description</h4>

<p>
You may want to upload some parts of your file system to some remote hosts.  In
these cases, archives are not needed, you just want to synchronize some
directories to remote places.  This is where the RSYNC upload method is useful.
</p>

<p>
RSYNC uploads need a SSH user/key pair to behave correctly, thus there is a
dependency against the keys <samp>BM_UPLOAD_SSH_USER</samp> and
<samp>BM_UPLOAD_SSH_KEY</samp>.
</p>

<hr>

<h4 id="s-BM_UPLOAD_RSYNC_DIRECTORIES">2.3.7.2 <samp>BM_UPLOAD_RSYNC_DIRECTORIES</samp></h4>

<p>
<em>Type: space-separated list</em>
</p>

<p>
Put here the list of local directories you want to upload with rsync.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_RSYNC_DIRECTORIES=&quot;/data/photos /data/videos /data/mp3&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_RSYNC_HOSTS">2.3.7.3 <samp>BM_UPLOAD_RSYNC_HOSTS</samp></h4>

<p>
<em>Type: space-separated list</em>
</p>

<p>
Put here the list of hosts to use for RSYNC-only uploads.  Note that if you put
some hosts in <samp>BM_UPLOAD_HOSTS</samp>, they will be used as well.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_RSYNC_HOSTS=&quot;mirror5.lan.mysite.net&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_RSYNC_DESTINATION">2.3.7.4 <samp>BM_UPLOAD_RSYNC_DESTINATION</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
Put here the destination for RSYNC-only uploads, this key overrides
<samp>BM_UPLOAD_DESTINATION</samp>.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_RSYNC_DESTINATION=&quot;/var/archives/rsync-snapshots&quot;
</pre>

<hr>

<h4 id="s-BM_UPLOAD_RSYNC_DUMPSYMLINKS">2.3.7.5 <samp>BM_UPLOAD_RSYNC_DUMPSYMLINKS</samp></h4>

<p>
<em>Type: boolean, default: <samp>false</samp>.</em>
</p>

<p>
You can choose to dereference files pointed by symlinks in your RSYNC
snapshots.  This feature should be used with care.
</p>

<p>
Example:
</p>

<pre>
     export BM_UPLOAD_RSYNC_DUMPSYMLINKS=&quot;false&quot;
</pre>

<hr>

<h2 id="s-exports">2.4 Exports</h2>

<p>
<em>Another way of storing your archives to a safe place is to use external
media.</em>
</p>

<p>
In version 0.7.7, only CDs and DVDs are supported as external media, so we will
discuss in this section only the <samp>BM_BURNING</samp> features.  Other
exports are expected to come in next versions though.
</p>

<hr>

<h3 id="s-exports-burning">2.4.1 Burning CDR/DVD media</h3>

<p>
In the version 0.7.7, Backup Manager supports four different kinds of media:
CDR, CDRW and DVD+R(W) and DVD-R(W).
</p>

<hr>

<h4 id="s-BM_BURNING_METHOD">2.4.1.1 <samp>BM_BURNING_METHOD</samp></h4>

<p>
Set the key <samp>BM_BURNING_METHOD</samp> to the method corresponding to the
media you want to burn:
</p>
<ul>
<li>
<p>
CDR
</p>
</li>
</ul>
<ul>
<li>
<p>
CDRW
</p>
</li>
</ul>
<ul>
<li>
<p>
DVD
</p>
</li>
</ul>
<ul>
<li>
<p>
DVD-RW
</p>
</li>
</ul>

<p>
In <em>non-interactive mode</em> (when backup-manager is not lauchned from a
terminal), any of these methods will try to put the whole archive repository in
the media, if it does not fit in the media, it will try to put only the
archives built on the day, if that's not possible, nothing will be burnt.
</p>

<p>
In <em>interactive mode</em> (when backup-manager is launched from a terminal),
the whole repository will be burnt into as many media as needed.  When a medium
is satured with archives, backup-manager will pause the process asking the user
to put a new media inside.
</p>

<p>
The <samp>CDRW</samp> and <samp>DVD-RW</samp> methods will first blank the
media, so you can safely use these methods if you want to use the same medium
several times.
</p>

<p>
The <samp>CDR</samp> and <samp>DVD</samp> medthods won't blank the medium first
(DVD+RW media doesn't need blanking, it's possible to re-burn data on-the-fly
over such media)..
</p>

<p>
DVD media are handled by the tool <samp>dvd+rw-tools</samp>, problems can occur
in CRON environment with <samp>dvd+rw-tools</samp> versions prior to
<samp>6.1</samp>, make sure to have <samp>6.1</samp> or later if you want to
burn DVD media with Backup Manager.
</p>

<p>
As usual, you can put <samp>none</samp> in order to disable the burning
process.
</p>

<p>
All those burning methods share the same configuration keys, so it's easy to
switch from a medium to another.
</p>

<hr>

<h4 id="s-BM_BURNING_DEVICE">2.4.1.2 <samp>BM_BURNING_DEVICE</samp></h4>

<p>
<em>Type: string, default: <samp>/dev/cdrom</samp>.</em>
</p>

<p>
This is mandatory for using the burning feature, it's the device to use for
mounting the media.  It's needed by backup manager for performing the MD5
checks and for other needs.
</p>

<p>
Example:
</p>

<pre>
     export BM_BURNING_DEVICE=&quot;/dev/cdrom&quot;
</pre>

<hr>

<h4 id="s-BM_BURNING_DEVFORCED">2.4.1.3 <samp>BM_BURNING_DEVFORCED</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
Backup Manager uses <samp>cdrecord</samp> for burning CDs.  If when you run
<samp>cdrecord -scanbus</samp> you don't see your burning device, that means
you will have to force the device in ATA mode.  To tell Backup Manager to do
so, just put here the path to your device, and a switch will be appended to the
cdrecord commandline like the following : <samp>cdrecrord ...
dev=$BM_BURNING_DEVFORCED ...</samp>.
</p>

<p>
Leave this configuration key blank if you see your device with <samp>cdrecord
-scanbus</samp>, in this case, Backup Manager will use the default cdrecord
device for burning CDR media.
</p>

<p>
Example:
</p>

<pre>
     export BM_BURNING_DEVFORCED=&quot;/dev/cdrom&quot;
</pre>

<hr>

<h4 id="s-BM_BURNING_ISO_FLAGS">2.4.1.4 <samp>BM_BURNING_ISO_FLAGS</samp></h4>

<p>
<em>Type: string, default: &quot;-R -J&quot;</em>
</p>

<p>
Media burned with Backup Manager will be made using a Joliet disc image.  The
flags defined in that variable will be appended to the mkisofs command lines in
order to specify wich media image to use.
</p>

<p>
The default value &quot;-R -J&quot; produces a Joliet image, if you want to
make non-Joliet disc images, you can change these flags.  Refer to the manpage
of mkisofs for details about possible disc images.
</p>

<p>
Don't change that variable if you don't know what you're doing.
</p>

<p>
Example:
</p>

<pre>
     export BM_BURNING_ISO_FLAGS=&quot;-R -J&quot;
</pre>

<hr>

<h4 id="s-BM_BURNING_MAXSIZE">2.4.1.5 <samp>BM_BURNING_MAXSIZE</samp></h4>

<p>
<em>Type: integer, default: <samp>700</samp>.</em>
</p>

<p>
This is where you define the maximum size (in megabytes) of the media you will
put in the device.  Here is the list of the common sizes:
</p>
<ul>
<li>
<p>
CDR/CDRW: 650, 700, 800
</p>
</li>
</ul>
<ul>
<li>
<p>
DVD: 4700
</p>
</li>
</ul>

<p>
When Backup Manager looks in the repository for burning data, it will try to
put the whole archive repository in the media.  If the summarized size of the
repository does not fit in <samp>BM_BURNING_MAXSIZE</samp>, Backup Manager will
then try to put only the archives of the day.
</p>

<p>
Example for a CD burner
</p>

<pre>
     export BM_BURNING_METHOD=&quot;CDRW&quot;
     export BM_BURNING_MAXSIZE=&quot;700&quot;
</pre>

<p>
Example for a DVD burner:
</p>

<pre>
     export BM_BURNING_METHOD=&quot;DVD&quot;
     export BM_BURNING_MAXSIZE=&quot;4700&quot;
</pre>

<hr>

<h4 id="s-BM_BURNING_CHKMD5">2.4.1.6 <samp>BM_BURNING_CHKMD5</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp>.</em>
</p>

<p>
If this boolean is set to a true value, every MD5 sum will be checked when the
media is burned in order to make sure everything is ok.
</p>

<p>
Note that you can choose to perform this checkup with the command switch
<samp>--md5check</samp>.
</p>

<p>
Example:
</p>

<pre>
     exports BM_BURNING_CHKMD5=&quot;true&quot;
</pre>

<hr>

<h2 id="s-advanced">2.5 Advanced features</h2>

<p>
<em>A couple of advanced features are provided, they will be covered in this
section.</em>
</p>

<hr>

<h3 id="s-BM_TEMP_DIR">2.5.1 <samp>BM_TEMP_DIR</samp></h3>

<p>
<em>Type: string, default: <samp>/tmp/backup-manager</samp>.</em>
</p>

<p>
This is the temporary directory where temporary files are created by Backup
Manager.
</p>

<p>
Example:
</p>

<pre>
     export BM_ARCHIVE_CHMOD=&quot;/tmp/backup-manager&quot;
</pre>

<hr>

<h3 id="s-advanced-logger">2.5.2 Logging to syslog</h3>

<p>
If you want to log Backup Manager actions to syslog, you can enable the
internal logger, this is done with the configuration key
<samp>BM_LOGGER</samp>.  You are also able to choose which syslog facility to
use thanks to the key <samp>BM_LOGGER_FACILITY</samp>.
</p>

<hr>

<h4 id="s-BM_LOGGER">2.5.2.1 <samp>BM_LOGGER</samp></h4>

<p>
<em>Type: boolean, default: <samp>true</samp>.</em>
</p>

<p>
If this boolean is set to true, Backup Manager will log everything to syslog.
</p>

<p>
Example:
</p>

<pre>
     exports BM_LOGGER=&quot;true&quot;
</pre>

<hr>

<h4 id="s-BM_LOGGER_FACILITY">2.5.2.2 <samp>BM_LOGGER_FACILITY</samp></h4>

<p>
<em>Type: string, default: <samp>user</samp>.</em>
</p>

<p>
You can specify here a syslog facility to use, this can be useful if you like
to filter messages from Backup Manager to a special syslog file.
</p>

<p>
Example:
</p>

<pre>
     exports BM_LOGGER_FACILITY=&quot;cron&quot;
</pre>

<hr>

<h3 id="s-advanced-externals">2.5.3 Writing external hooks</h3>

<p>
You have the availability to write your own hooks if you want to automate some
special beaviours within the Backup Manager process.  You may like to mount
over NFS your archive repository <em>before</em> the backup session and unmount
it after, or you may like to launch your own uploader script when the backup
session is finished.
</p>

<p>
In order to let you implement any solution you like, Backup Manager provides
two different hooks: the <em>pre-command</em> and <em>post-command</em> hooks.
</p>

<hr>

<h4 id="s-BM_PRE_BACKUP_COMMAND">2.5.3.1 <samp>BM_PRE_BACKUP_COMMAND</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
Put here the path to a program (or a shell command) to launch before the backup
session.  If the command fails (exits with non zero value, or prints the
keyword <samp>false</samp> on stdout) the backup session will stop.  If the
pre-command succeeds, the process can follow.
</p>

<p>
Example with a basic shell command:
</p>

<pre>
     export BM_PRE_BACKUP_COMMAND=&quot;mount -t nfs mirror.lan.net:/exports/backups /var/archives&quot;
</pre>

<p>
Example with a custom script:
</p>

<pre>
     export BM_PRE_BACKUP_COMMAND=&quot;/usr/local/bin/backup-prepare.pl $TODAY&quot;
</pre>

<hr>

<h4 id="s-BM_POST_BACKUP_COMMAND">2.5.3.2 <samp>BM_POST_BACKUP_COMMAND</samp></h4>

<p>
<em>Type: string</em>
</p>

<p>
Put here the path to a program (or a shell command) to launch after the backup
session.  If the command fails (exits with non zero value, or prints the
keyword <samp>false</samp> on stdout) Backup Manager will exit with an error
code (and will log to syslog the post-command failure if the logger is
enabled).
</p>

<p>
Example with a basic shell command:
</p>

<pre>
     export BM_POST_BACKUP_COMMAND=&quot;umount /var/archives&quot;
</pre>

<p>
Example with a custom script:
</p>

<pre>
     export BM_POST_BACKUP_COMMAND=&quot;/usr/local/bin/backup-cleanup.pl $TODAY&quot;
</pre>

<hr>

<p>
[ <a href="ch-about.html">previous</a> ]
[ <a href="index.html#contents">Contents</a> ]
[ <a href="ch-about.html">1</a> ]
[ 2 ]
[ <a href="ch-using.html">3</a> ]
[ <a href="ch-using.html">next</a> ]
</p>

<hr>

<p>
Backup Manager 0.7.7 User Guide
</p>

<address>
1.7 - 14 Apr, 2008<br>
<br>
Alexis Sukrieh<br>
<br>
</address>
<hr>

</body>

</html>