Finish up and move out
[matthijs/upstream/backupninja.git] / man / backupninja.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH BACKUPNINJA 1 "October 10, 2005" "riseup" "backupninja package"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 BACKUPNINJA \- A lightweight, extensible meta-backup system
20 .br
21 .I
22 "a silent flower blossom death strike to lost data."
23 .SH SYNOPSIS
24 .B "backupninja [ \-h ] [ \-d ] [ \-n ] [ \-t ] [ \-f filename ] [ \-\-run filename ]"
25 .br
26 .SH DESCRIPTION
27 .B Backupninja 
28 allows you to coordinate system backups by dropping a few
29 simple configuration files into /etc/backup.d/. Most programs you
30 might use for making backups don't have their own configuration file
31 format. Backupninja provides a centralized way to configure and
32 coordinate many different backup utilities.
33 .PP
34
35 .SH FEATURES
36 .IP - 2
37 easy to read ini style configuration files.
38 .IP -
39 you can drop in scripts to handle new types of backups.
40 .IP -
41 backup actions can be scheduled.
42 .IP -
43 you can choose when status report emails are mailed to you (always, on warning, on error, never).
44 .IP -
45 console-based wizard (ninjahelper) makes it easy to create backup action configuration files.
46 .IP -
47 passwords are never sent via the command line to helper programs.
48 .IP -
49 in order to backup a db or sql database, you cannot simply copy database files. backupninja helps you safely export the data to a format which you can backup.
50 .IP -
51 works with Linux-Vservers. 
52
53 .B Backup types include:
54 .IP - 2
55 secure, remote, incremental filesytem backup (via rdiff-backup). incremental data is compressed. permissions are retained even with an unpriviledged backup user.
56 .IP -
57 basic system and hardware information.
58 .IP -
59 encrypted remote backups (via duplicity).
60 .IP -
61 safe backup of MySQL, PostgreSQL, OpenLDAP, and subversion databases.
62 .IP -
63 burn CD/DVDs or create ISOs. 
64          
65 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
66 .\" \fI<whatever>\fP escape sequences to invoke bold face and italics, 
67 .\" respectively.
68
69 .SH OPTIONS
70 .TP
71 .B \-h, \-\-help           
72 Show summary of options
73 .TP
74 .B \-d, \-\-debug          
75 Run in debug mode, where all log messages are output to the current shell.
76 .TP
77 .B \-f, \-\-conffile CONF_FILE  
78 Use CONF_FILE for the main configuration instead of /etc/backupninja.conf
79 .TP
80 .B \-t, \-\-test           
81 Run in test mode, no actions are actually taken.
82 .TP
83 .B \-n, \-\-now            
84 Perform actions now, instead of when they might be scheduled.
85 .TP
86 .B \-\-run ACTION_FILE
87 Runs the action configuration ACTION_FILE and exits.
88
89 .SH CONFIGURATION
90
91 General settings are configured in /etc/backupninja.conf. In this file you
92 can set the log level and change the default directory locations. See \fBbackupnina.conf(5)\fP.
93
94 To preform the actual backup actions, backupninja processes each action configuration file in
95 /etc/backup.d according to the file's suffix. See \fBbackup.d(5)\fP.
96
97 .SH EXAMPLE USAGE
98 .TP
99 Backupninja can be used to impliment whatever backup strategy you choose. It is intended, however, to be used like so:
100 .TP
101 First, databases are safely copied or exported to /var/backups.  Often, you cannot make a file backup of a database while it is in use, hence the need to use special tools to make a safe copy or export into /var/backups.
102 .TP
103 Then, vital parts of the file system, including /var/backups, are nightly pushed to a remote, off-site, hard disk (using rdiff-backup). The local user is root, but the remote user is not privileged. Hopefully, the remote filesystem is encrypted.
104 .TP
105 In order for this to work (ie for diff-backup to run unattended), you must create ssh keys on the source server and copy the public key to the remote user's authorized keys file. For example:
106 .br
107 root@srchost# ssh-keygen -t dsa
108 .br
109 root@srchost# ssh-copy-id -i /root/.ssh/id_dsa.pub backup@desthost
110 .TP
111 Now, you should be able to ssh from user 'root' on srchost to user 'backup' on desthost without specifying a password. When prompted for a password by ssh-keygen, just leave it blank by hitting return. The "wizard" \fBninjahelper(1)\fP will walk you through these steps.
112
113 .SH FILES
114 .PD 0
115 \fB/usr/sbin/backupninja\fP        main script
116 .br
117 \fB/etc/backupninja.conf\fP        main configuration file; general options
118 .br
119 \fB/etc/cron.d/backupninja\fP      runs main script hourly
120 .br
121 \fB/etc/logrotate.d/backupninja\fP rotates backupninja.log
122 .br
123 \fB/etc/backup.d\fP                directory for configuration files
124 .br
125 \fB/usr/share/backupninja\fP       directory for handler scripts
126 .br
127 \fB/usr/share/doc/backupninja/examples\fP       example action configuration files.
128 .br
129 .PD
130
131 .SH SEE ALSO
132 .BR ninjahelper (1), 
133 .BR backupninja.conf (5), 
134 .BR backup.d (5), 
135 .br
136 .SH AUTHOR
137 BACKUPNINJA was written by the riseup.net collective.