Skip to content

Commit ef1c89c

Browse files
committed
updated README.md
1 parent f0a2281 commit ef1c89c

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,18 @@ Because I haven't found any good and easy-to-use backup scripts that fit my need
1010
The aim is to provide an easy-to-use script for all operating systems that backups both data from webspace and SQL Databases altogether. That is what most people need.
1111

1212
# Current features
13-
* download all files and folders from an remote directory.
14-
* log failed downloads to a log file. After the backup the failed downloads could be repeated manually.
15-
* readable outputs
13+
* download of all files and folders from a remote directory to a local directory
14+
* logging of failed downloads to a local file. After the backup the failed downloads could be repeated manually
15+
* user-friendly outputs to the console
1616
* text file with statistics like number of folders, number of files, start date, end date, duration of the backup
17+
* compression of the backup folder to an (password encrypted) zip file
1718

1819
# Planed features
19-
* more logging
20-
* Input credentials at the start as an alternative to permanently store it to the config.json
21-
* compression of backups
22-
* configurable lifespan of backups
23-
* backup of SQL databases
20+
* input credentials at the start as an alternative to permanently store it to the config.json
2421
* SSH support
25-
22+
* backup of SQL databases
23+
* configurable lifespan of backups
24+
* more logging
2625

2726
# Usage
2827
1. download the release for your operating system.
@@ -34,22 +33,30 @@ The aim is to provide an easy-to-use script for all operating systems that backu
3433

3534
## Configuration
3635
{
37-
"version": "1.0.0",
38-
"server": {
39-
"host": "example_host",
40-
"user": "user",
41-
"password": "password",
42-
"port": 21,
43-
"protocol": "ftps" <- (or "ftp"),
44-
"verbose": false,
45-
"timeout": 30 <- (unit: seconds)
46-
},
47-
"backup": {
48-
"root": "/", <- the path mus start end end with /.
49-
"downloadPath": "" <- let this empty to donwload next to the script.
36+
"version": "1.0.0",
37+
"server": {
38+
"host": "example.com",
39+
"user": "user",
40+
"password": "password",
41+
"port": 21,
42+
"protocol": "ftps" | "ftp",
43+
"timeout": 30,
44+
"verbose": false
45+
},
46+
"backup": {
47+
"root": "/",
48+
"downloadPath": "",
49+
"zip": {
50+
"enabled": false,
51+
"password": ""
5052
}
53+
},
54+
"console": {
55+
"tty": false
56+
}
5157
}
5258

59+
5360
# Development
5461

5562
## Installation

0 commit comments

Comments
 (0)