NAME

SYNOPSIS

OPTIONS AND ARGUMENTS

--host server

Specify the FTP server to connect to

--ssl

Use SSL to secure the connection (requires Net::FTPSSL)

--user name

Define the username to authenticate with

--password pass

Set the password to authenticate with

--readpassword

Instead of specifying the password on the commandline, it can also be read from the standard input. This is preferable for obvious security reasons.

--dir

Specify the directory on the server the backups files are stored in.

--maxage n

Set the maximum number of days after which a backup is expired.

--profile name

Set the profile name to process. This is mandatory unless --all is supplied.

--all

When this is set, the expiration date is applied to alle files found on the server and identified as tartarus backups.

--truncate

This option enables replacing files with /dev/null on FTP server before deletion. Some FTP servers won't allow deleting files when the quota is reached, this flag enables a workaround.

--dry-run

This option prevents charon from actually deleting files.

--verbose

This option makes charon more verbose about the actions made

--help

This parameter shows a brief command reference.

EXAMPLE

    $ charon.ftp --host safehaven --user john --password SECRET --dir / --maxage 7 --profile home --verbose --dry-run

This command line will try to log into the server "safehaven" using the user name "john" and his password "SECRET" and remove backup file from the profile "home" with are more than 7 days old. Due to the command line switch "--dry-run", no files are actually deleted - the script will only explain its potential actions in its output.

Integration with Tartarus

    # Hook in Charon
    TARTARUS_POST_PROCESS_HOOK() {
        # pass configuration variables to charon
        # transmit the password through stdin to hide it from "ps ax"
        local CHARON="/usr/sbin/charon.ftp"
        local MAX_AGE_IN_DAYS="7"
        echo -n "$STORAGE_FTP_PASSWORD" | $CHARON \
            --host "$STORAGE_FTP_SERVER" --user "$STORAGE_FTP_USER" \
            --readpassword \
            --dir "$STORAGE_FTP_DIR" \
            --maxage "$MAX_AGE_IN_DAYS" \
            --profile "$NAME"
    }

TARTARUS_POST_PROCESS_HOOK will only be executed in case of a successfull backup, so there won't be any files removed if tartarus encounters an error during the new backup creation.

AUTHOR