Update (#34)

Add sftp support
Heavy code cleanup and commenting
Fixes multiple broken functions
Update download urls for dependencies

Author: Meliox

LICENCE

@@ -1,4 +1,4 @@
-Copyright (C) 2013-2018, Meliox
+Copyright (C) 2013-2024, Meliox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,21 +1,21 @@
 # FTPauto
 
-FTPauto is a simple, but highly advanced and configurable FTP-client wrap-around written in #Bash for Unix. It is based on [lftp](http://lftp.yar.ru/) and  helps to automate simple transfers - yet FTPauto allows much more.
+FTPauto is a simple, but highly advanced and configurable FTP-client wrap-around written in #Bash for Unix. It is based on [lftp](https://github.com/lavv17/lftp) and  helps to manage transfers.
 
 # Features
-* Send files easily with lftp (To and from FTP, and between serveres - FXP)
-* Highly customizable command line
-* Monitor free space or server status on FTP-server
+* Send files easily with lftp (To and from FTP(s), and between serveres - FXP, and SFTP)
+* Highly customizable command line optopns
+* Monitor free space or server status on the remote server (pre/post check)
 * Progressbar with estimated time of transferes
-* History (Transfer logs)
-* Queue system of transfers (failed transferes, queue)
+* History (Transfer logs, total transfered etc.)
+* Queue manager for failed, queued transfere
 * Packing/splitting directory/files into rar-files. Including sfv to verify files at end-server.
-* Multiple users (different configuration)
+* Multiple user support
 * Delay transfer to start at a specific time
 * Support pre/post transfer using external scripts
 * Sorting (regex-based or manually)
-* Exclution of files (regex-based)
-* Seamless unpack of rar-files in stored in store-mode using rarmount
+* Regex-based exclution of files or folders
+* Seamless read-content from rar files using rar2fs fuse
 * Send push notification to phones etc. with [Pushover](https://pushover.net/)
 * Automatic transfers with the use of [FlexGet](http://flexget.com/)
 
@@ -53,7 +53,7 @@ You should have User and sudo or root access to use and install, respectively.
 Script is mainly written to Debian/Ubuntu and is guaranteed to work under these!
 
 ## Installation
-There are several way to install FTPauto. Briefly summarized: The installer does just about everything for you. This is also the most stable version. You can also get the most recent version from git by pulling it.
+There are several way to install FTPauto. Sudo is necesary to install some dependent tools
 
 ### The installer (recommended)
 To get FTPauto, download and execute the installer: [download](https://raw.github.com/Meliox/FTPauto/master/install.sh)
@@ -64,6 +64,11 @@ mkdir FTPauto && cd FTPauto
 wget https://raw.github.com/Meliox/FTPauto/master/install.sh
 bash install.sh install
 ```
+and update
+```bash
+bash install.sh update
+```
+
 
 Follow the instructions to set up a user and then you're ready to use FTPauto! If you skipped user setup or need help go to [configuration](https://github.com/Meliox/FTPauto#configuration) to set up a user.
 
@@ -77,21 +82,11 @@ Run
 bash install.sh install
 ```
 
-### Manual install
-If you prefer to do everything manually, read the install.sh script.
-
-### Upgrading
-If you want to upgrade to newest version, simply run
-```bash
-bash install.sh update
-```
-
-The same almost goes for git
+and update
 ```bash
 git pull
 bash install.sh update
 ```
-NOTE: Running lastest version, doesn't mean it's 100% stable. 
 
 # Configuration
 First thing that need to be done is to create a user and edit the users settings. The setting that is to be edited is shown in [settings](https://github.com/Meliox/FTPauto#settings).
@@ -119,8 +114,8 @@ The most important setting is "transferetype".
 Depending on the solution you can FTPauto can do
 ```
 FTP	
-	SERVER --> client   : upftp
-	server <-- CLIENT   : downftp
+	SERVER --> client   : upftp(s) or upsftp
+	server <-- CLIENT   : downftp(s)
 FXP
 	SERVER <-> server   : fxp
 ```
@@ -198,7 +193,7 @@ Here's an overview as well
         --verbose          | Debugs to console
 ```
 ## Debugging
-If the script for some reason should fail, it is easy to debug. Debugging can either be permanently set if the error comes and goes. This setting can be in ftpauto.sh by  altering the line 3:
+If the script for some reason should fail, it is easy to debug. Debugging can either be permanently set if the error comes and goes. This setting can be in ftpauto.sh by altering the line 3:
 ```bash
 verbose="0" #0 Normal info | 1 debug console | 2 debug into logfile
 ```