ftpmd5back Files

Notes about ftpmd5back release 0.1.7
------------------------------------

With release 0.1.7, ftpmd5back is out of beta phase: now is stable.

Current limits:
- can't upload UTF8 filename (planned to fix in next release)
- you can backup a single local folder (with all subdirectories)
- to specify single files to backup you NEED to use ftpmd5back.conf (command line don't support single file name but a single local folder)

Please contact me for bugs and suggestions at:
markbass72 at gmail dot com


Releases
--------
ftpmd5back_win_x32.7z        windows platform, 32 bit OS
ftpmd5back_win_x64.7z        windows platform, 64 bit OS
ftpmd5back_linux_armv6l.gz   for armv6, compiled and tested on raspberry pi
ftpmd5back_linux_x64.zip     linux platform, 64 bit OS



==================================================================
README
==================================================================

ftpmd5back rel 0.1.7

What is?
--------
ftpmd5back is a tool to make a backup of a local folder to a remote ftp 
server folder.


Note about this release
-----------------------
With release 0.1.7 ftpmd5back is out of beta phase. 


How it works?
-------------
ftpmd5backup, as the name suggests, is a tool that is used to make 
backups of your files to an ftp server .
In order to minimize resources necessary for this operation, a file 
will be uploaded only if:
1) on the ftp server there is no copy of the local file
2) on the ftp server there is a copy of the local file, but it is not 
the same as the local version .

To determine if the remote copy (the one on the ftp server ) is 
identical to the current local file, ftpmd5back perform 2 tests:
1 ) ftpmd5back compares the size of the files ( local and remote ): if 
the sizes do not match then the local file will be uploaded
2 ) in the case that the sizes are identical, ftpmd5back will perform 
the md5 test between the 2 files: only when there isn't a md5 match, the 
file will be uploaded

To calculate md5 on remote copy, it uses the XMD5 ftp protocol command. 
This means that not all ftp servers can be used with ftpmd5back but 
probably your favorite ftp server already implements this command.




How do I know if my ftp server implements the command XMD5?
-----------------------------------------------------------
of course you can use your favourite ftp client but...
ftpmd5back implements a test that lets you know if an ftp server can 
answer to XMD5 command, requesting directly to the server.

launching such

user@host /llab/ftpbackup $ ./ftpmd5back -util testftp -s ftp.remotehostname.it -u ftpuser -p secret_2_login

we get a ftp test, follow the results

Host:          	ftp.remotehostname.it
User:          	ftpuser
Pass:          	secret_2_login
Port:          	21
MultiFolder:   	FALSE
Util:          	TESTFTP

Testing ftp server...
         0	Test start
         0	send login request to ftp server
      1039	Logged in
      1039	change to remote folder
      1088	remote folder found
          	request ftp capabilities
          	214-Supported Commands : (* unimplemented)
          	 ABOR  DELE  MKD   PWD   SIZE  USER
          	 ACCT* EPRT  MODE  QUIT  SMNT* XMD5
          	 ALLO  EPSV  NLST  REIN  SSCN  XMKD
          	 APPE  FEAT  NOOP  REST  STAT  XPWD
          	 CCC   HELP  PASS  RETR  STOR  XRMD
          	 CDUP  LIST  PASV  RMD   STOU  XSHA1
          	 CLNT  MDTM  PBSZ  RNFR  STRU  XCRC
          	 CPSV  MFCT  PORT  RNTO  SYST  XCUP
          	 CWD   MFMT  PROT  SITE  TYPE  XDEL
          	 
          	 SITE HELP
          	 SITE PSWD
          	 SITE ZONE
          	214 End.
          	EUREKA: XMD5 command is implemented by this server: you can use ftpmd5back!
      1138	send logout request to ftp server
      1188	logged out!
      1188	Test end
Time:	1 seconds 188 milliseconds


We can test the login to the FTP server and get, at the same time (using 
the ftp HELP command), the list of commands implemented on the server.
Usually if a command is not implemented will be displayed followed by a 
star ('*').
Find XMD5 (and not 'XMD5 *') means that the command works and that we 
can use ftpmd5back with this server.


Config File
-----------
ftpmd5back can be used both from the command line or with a 
configuration file.
Not all features of ftpmd5back are usable from the command line but 
only the following:
- copy of a local folder (including all subfolders) on a remote folder

Instead using the configuration file, you can:
- copy of a local folder (including all subfolders) on a remote folder
- copy one or more files to various local folders on a remote folder


Parameters
----------
Usage: ftpmd5back [-util {testftp|createconf}] -s ftpserver [-t port] -u username -p password -l localfolder -r remotefolder
Parameters:
	-s	ftp server name or IP address
	-t	optional, port to connect to ftp server, if omitted default value is 21
	-u	user name needed to login to ftp server
	-p	password
	-l	local folder, source of backup
	-r	remote folder, destination of backup, the folder MUST exists
	-v	verbose mode
		   0 - verbose disabled (errors displayed)
		   1 - show processed files (default)
		   2 - show processed files and local/remote size/time/md5 
		   9 - debug verbose mode
	-util  use ftpmd5back utility
		   testftp    - test ftp connection
		   createconf - creates a configuration file using other parameters

Example 1: backup on linux
----------------------------
ftpmd5back -s ftp.remotehost.org -t 21 -u username -p password -l "/home/username/Desktop/COMPITI DI MATEMATICA" -r /ftp.remotehost.org/backup/USERNAME


Example 2: backup on Windows
----------------------------
ftpmd5back.exe -s ftp.remotehost.org -t 21 -u username -p password -l "C:\Users\USERNAME\Desktop\COMPITI DI MATEMATICA" -r /ftp.remotehost.org/backup/USERNAME




Credits
-------
http://synapse.ararat.cz/doku.php/start


License
-------
this is a open source tool


Author
------
nomorelogic
markbass72 at gmail dot com