ninjahelper(1) [debian man page]

NINJAHELPER(1)							backupninja package						    NINJAHELPER(1)

NAME

       NINJAHELPER - A menu driven curses-based interface to walk you through backupninja configuration.

SYNOPSIS

       ninjahelper

DESCRIPTION

       Ninjahelper  is	an helper script to walk you through configuration of the backup tasks for backupninja. It is a curses based "wizard" with
       an intuitive menu-driven interface.

ADDING NEW HELPERS

       To add an additional 'wizard' to ninjahelper, follow these steps:

       (1)    create a file in the handlers directory (eg. /usr/share/backupninja) using the .helper extension. For example, if you wish to create
	      a helper for the handler "blue", create the file /usr/share/backupninja/blue.helper.

       (2)    next,  add  your	helper	to  the  global HELPERS variable and define the main function for your helper (the function name is always
	      <helper>_wizard). To use the blue.helper as an example: HELPERS="$HELPERS blue:description_of_this_helper"
		     blue_wizard() {
		       ... do work here ...
		     }

       (3)    look at the existing helpers to see how they are written. Try to re-use functions, such as the dialog functions that are defined	in
	      easydialog.sh, or the vserver functions defined in lib/vserver.

       (4)    test,  re-test, and test again. Try to break the helper by going backwards, try to think like someone who has no idea how to config-
	      ure your handler would think, try to make your helper as simple as possible. Walk like a cat, become your  shadow,  don't  let  your
	      senses betray you.

SEE ALSO

       backupninja(1), backupninja.conf(5), backup.d(5),

AUTHOR

       BACKUPNINJA was written by the riseup.net collective.

riseup								 january 19, 2006						    NINJAHELPER(1)

BACKUPNINJA.CONF(5)						backupninja package					       BACKUPNINJA.CONF(5)

NAME

       BACKUPNINJA.CONF - Configuration file(s) for backupninja (1).

SYNOPSIS

       /etc/backupninja.conf

DESCRIPTION

       backupninja.conf is the general configuration file. In this file you can set the log level and change the default directory locations.  You
       can force a different general configuration file with "backupninja -f /path/to/conf".

OPTIONS

       loglevel
	      How verbose to make the logs.
	      5 = Debugging messages
	      4 = Informational messages
	      3 = Warnings
	      2 = Errors
	      1 = Fatal errors

       reportemail
	      Send a summary of the backup status to this email address

       reportsuccess
	      If set to 'yes', a report email will be generated even if all modules reported success.

       reportwarning
	      If set to 'yes', a report email will be generated even if there was no error.

       logfile
	      The path of the logfile.

       configdirectory
	      The directory where all the backup action configuration files live.

       scriptdirectory
	      Where backupninja handler scripts are found

       usecolors
	      If set to 'yes', use colors in the log file and debug output.

       when   When to process each configuration file. The value used here will be applied for each configuration file. It is possibile  to  over-
	      ride this "when" in each each configuration file, see also section "Scheduling" in backup.d(5).

	      For example:

		when = sundays at 02:00
		when = 30th at 22
		when = 30 at 22:00
		when = everyday at 01		 <-- the default
		when = Tuesday at 05:00

	      These values for 'when' are equivalent:

		when = tuesday at 05:30
		when = TUESDAYS at 05

	      These values for 'when' are invalid:

		when = tuesday at 2am
		when = tuesday at 2
		when = tues at 02

       vservers
	      If you are using Linux-Vservers (http://linux-vserver.org), there are some special capabilities that different handlers have to make
	      vserver backups easier.  See the example configuration files for each handler to configure the vserver specific variables.

DEFAULTS

       loglevel = 4
       reportemail = root
       reportsuccess = yes
       reportwarning = yes
       logfile = /var/log/backupninja.log
       configdirectory = /etc/backup.d
       scriptdirectory = /usr/share/backupninja
       usecolors = yes
       when = everyday at 01:00
       vservers = no

SEE ALSO

       backupninja(1), ninjahelper(1), backup.d(5),

AUTHOR

       BACKUPNINJA was written by the riseup.net collective.

riseup								 November 19, 2005					       BACKUPNINJA.CONF(5)