4be2428d8df8b01572adbcd351f4e7586a73fcb2
[matthijs/upstream/backupninja.git] / etc / backup.d / example.mysql
1 ## backupninja mysql config file ##
2
3 dbhost      = localhost
4 databases   = all
5 backupdir   = /var/backups/mysql
6 hotcopy     = yes
7 sqldump     = no
8 compress    = yes
9
10 ## authentication ##
11
12 configfile = /etc/mysql/debian.cnf
13
14 # or...
15 # dbusername  = <dbuser>
16 # dbpassword  = <dbpassword>
17
18 # or...
19 # user = root
20
21 ## notes ##
22
23 # configfile = < path/to/file > (default = /etc/mysql/debian.cnf)
24 # The config file is passed to mysql with --defaults-file.
25 # On debian, this default will allow backupninja to make backups
26 # of mysql without configuring any additional options. 
27 # (this option is not compatible with "user" or "dbusername").
28 #
29 # user = <user> (default = root)
30 # Run mysql commands as 'user'. A valid .my.cnf must exist with a 
31 # database username and password in the user's home directory.
32 # (this option is not compatible with "configfile" or "dbusername").
33 #
34 # dbusername = <dbuser> (no default)
35 # The user must have access to the databases specified later.
36 # (this option is not compatible with "configfile" or "user").
37 #
38 # dbpassword = <dbpass> (no default)
39 # The password used with dbusername. this password will NOT be passed 
40 # on the command line and is not readable using "ps aux".
41 #
42 # dbhost = <host> (default = localhost)
43 # only localhost works right now.
44 #
45 # databases = < all | db1 db2 db3 > (default = all)
46 # which databases to backup. should either be the word 'all' or a 
47 # space separated list of database names.
48 #
49 # backupdir = < path/to/destination > (default = /var/backups/mysql)
50 # where to dump the backups. hotcopy backups will be in a subdirectory 'hotcopy' and
51 # sqldump backups will be in a subdirectory 'sqldump'
52 #
53 # hotcopy = < yes | no > (default = yes)
54 # make a backup of the actual database binary files using mysqlhotcopy.
55 #
56 # sqldump = < yes | no > (default = no)
57 # make a backup using mysqldump. this creates text files with sql commands
58 # sufficient to recontruct the database.
59 #
60 # compress = < yes | no > (default = yes)
61 # if yes, compress the sqldump output. 
62 #
63 # vsname = <vserver> (no default)
64 # what vserver to operate on, only used if vserver = yes in /etc/backupninja.conf
65 # if you do not specify a vsname the host will be operated on
66