Skip to content

Commit

Permalink
Update readme and config help, #18
Browse files Browse the repository at this point in the history
  • Loading branch information
Meliox committed Apr 10, 2017
1 parent 57bff1b commit 39c96ea
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
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.

# Features
* Send files easily with lftp
* 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
* Progressbar with estimated time of transferes
* Transfer logs
* Queue system of transfers
* History (Transfer logs)
* Queue system of transfers (failed transferes, queue)
* Packing/splitting directory/files into rar-files. Including sfv to verify files at end-server.
* Multiple users (different configuration)
* Delay transfer to start at a specific time
Expand Down Expand Up @@ -120,10 +120,9 @@ FTP
SERVER --> client : upftp
server <-- CLIENT : downftp
FXP
SERVER <-> client : upfxp
server <-> CLIENT : downfxp
SERVER <-> server : fxp
```
The capital letters state where FTPauto is executed and therefor giving the correct path is important. see [example](https://github.com/Meliox/FTPauto#transferetype-example)
The capital letters state where FTPauto is executed and therefor giving the correct path is important. For FXP transferes ftphost1 is SERVER. For example, see [example](https://github.com/Meliox/FTPauto#transferetype-example)

The rest of the settings should be selfexplanatory. The config can be found here: https://github.com/Meliox/FTPauto/blob/master/dependencies/help.sh#L90.

Expand Down
4 changes: 2 additions & 2 deletions dependencies/help.sh
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ function show_example {
echo "ftphost1=\"ip\" # ip address for ftp server"
echo "ftpport1=\"port\" # ftp port"
echo "ftpssl1=\"false\" # Set to true to use ftps else set it to false"
echo "ftpcustom1=\"\" # Enter settings separated by ';', eg. set cache:expire 1; set cache:size 2"
echo "ftpcustom1=\"\" # Enter settings separated by ';', eg. set cache:expire 1;set cache:size 2"
echo ""
echo "#### FXP MODE ####"
echo " # If you just want to send/receive items from one server to another, change these also!"
echo " # If you just want to send/receive items from one server to another, change these also! In FXP mode, ftphost1 is source and ftphost2 receiver"
echo "ftpuser2=\"user\" # username"
echo "ftppass2=\"pass\" # password"
echo "ftphost2=\"ip\" # ip address for ftp server"
Expand Down

0 comments on commit 39c96ea

Please sign in to comment.