Skip to content

Commit c065dfc

Browse files
committed
Updated
1 parent bd6dfbb commit c065dfc

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,20 @@ Automatic backups your web projects bases (MySQL/MariaDB) and files to the cloud
2222
- **MYSQL_PASS** - MySQL/MariaDB user password;
2323
- **CLOUD_USER** - login for your cloud (for WebDAV);
2424
- **CLOUD_PASS** - password for your cloud user (for WebDAV);
25-
- **CLOUD_PATH** - full path to cloud folder for WebDAV (ex.: `https://webdav.yandex.ru/Backups/`) or path to S3 spacename (ex.: `s3://myspacename`)
26-
- **CLOUD_PROTO** - cloud protocol (`webdav` or `s3` or `ssh`, default value is `webdav` if empty or undefined)
27-
- **CLOUD_SSH_HOST** - hostname/IP and port of backup server separated by colon (for ssh; ex.: `123.123.123.123`, `123.123.123.123:2222`, `hostname.com:4444`)
28-
- **CLOUD_SSH_HOST_USER** - system username of backup server (for ssh)
29-
- **CLOUD_SSH_HOST_PATH** - full path to backups dir on backups server (for ssh, projects dirs will be created automatically)
30-
- **TMP_PATH** - path for temporary files on server (ex.: `/tmp/`)
31-
- **GLOBAL_ARCHIVE_PASS** - global password for created archives (if project password set to `false` it will be used this password. if project password set to `false` and this password set to `false` password not set to project archive.)
32-
- **EXCLUDE** - spaces separated folders to exclude (supports wildcard in folders names, ex.: `EXCLUDE=".svn .git *cache*"`)
33-
- **EXCLUDE_RELATIVE** - relative folders paths to exclude separated by spaces (supports wildcard in paths to folders, ex.: `EXCLUDE_RELATIVE="wp-content/cache templates/*_temp"`)
34-
- **\<PERIOD\>_EXCLUDE** - spaces separated folders to exclude for specific backup period (ex.: `DAILY_EXCLUDE="uploads"`)
35-
- **\<PERIOD\>_EXCLUDE_RELATIVE** - relative folders paths to exclude separated by spaces for specific backup period (ex.: `WEEKLY_EXCLUDE_RELATIVE="wp-content/uploads"`)
36-
- **SPLIT** - size of archive parts (set `false` if you don't want split archives into parts); supports `b` (bytes), `k` (kilobytes) `m` (megabytes) `g` (gigabytes) (ex.: `SPLIT="500m"`)
37-
- **LAST_BACKUPS_PATH** - folder for lists of last backup files (script use its for deleting old files from cloud to avoid errors and unnecessary files with splitting archives into parts; folder create automatically; this folder is in the same folder as the main script with name `last_backups` if this var not set)
25+
- **CLOUD_PATH** - full path to cloud folder for WebDAV (ex.: `https://webdav.yandex.ru/Backups/`) or path to S3 spacename (ex.: `s3://myspacename`);
26+
- **CLOUD_PROTO** - cloud protocol (`webdav` or `s3` or `ssh`, default value is `webdav` if empty or undefined);
27+
- **CLOUD_SSH_HOST** - hostname/IP and port of backup server separated by colon (for ssh; ex.: `123.123.123.123`, `123.123.123.123:2222`, `hostname.com:4444`);
28+
- **CLOUD_SSH_HOST_USER** - system username of backup server (for ssh);
29+
- **CLOUD_SSH_HOST_PATH** - full path to backups dir on backups server (for ssh, projects dirs will be created automatically) ;
30+
- **TMP_PATH** - path for temporary files on server (ex.: `/tmp/`);
31+
- **GLOBAL_ARCHIVE_PASS** - global password for created archives (if project password set to `false` it will be used this password. if project password set to `false` and this password set to `false` password not set to project archive.);
32+
- **EXCLUDE** - spaces separated folders to exclude (supports wildcard in folders names, ex.: `EXCLUDE=".svn .git *cache*"`);
33+
- **EXCLUDE_RELATIVE** - relative folders paths to exclude separated by spaces (supports wildcard in paths to folders, ex.: `EXCLUDE_RELATIVE="wp-content/cache templates/*_temp"`);
34+
- **\<PERIOD\>_EXCLUDE** - spaces separated folders to exclude for specific backup period (ex.: `DAILY_EXCLUDE="uploads"`);
35+
- **\<PERIOD\>_EXCLUDE_RELATIVE** - relative folders paths to exclude separated by spaces for specific backup period (ex.: `WEEKLY_EXCLUDE_RELATIVE="wp-content/uploads"`);
36+
- **SPLIT** - size of archive parts (set `false` if you don't want split archives into parts); supports `b` (bytes), `k` (kilobytes) `m` (megabytes) `g` (gigabytes) (ex.: `SPLIT="500m"`);
37+
- **LAST_BACKUPS_PATH** - folder for lists of last backup files (script use its for deleting old files from cloud to avoid errors and unnecessary files with splitting archives into parts; folder create automatically; this folder is in the same folder as the main script with name `last_backups` if this var not set);
38+
- **SCRIPT_LOG_PATH** - full path for logs (directory must be exists and current user must be have permissions for write into it; logging disabled if path not setted).
3839

3940
Note: relative and not relative lists will be united if using ssh proto.
4041

@@ -171,9 +172,9 @@ If you want receive script result to email add below to the top of crontab list
171172
- [ ] add support for others database types backup
172173
- [x] ~~add support for partitioning archives into specified size~~
173174
- [x] ~~add automatically checking/creating folders in cloud~~
174-
- [ ] add logging with rotation
175+
- [x] ~~add logging with rotation~~
175176
- [ ] validating vars from config file
176-
- [ ] add full support for some special characters, spaces and non latin characters in file names and paths
177+
- [x] ~~add full support for some special characters, spaces and non latin characters in file names and paths~~
177178
- [ ] add ability to backup files and databases to own archive
178179
- [ ] add functionality for restore from backups
179180
- [ ] add support for local backup to mounted clouds disks
@@ -184,6 +185,7 @@ If you want receive script result to email add below to the top of crontab list
184185
Changelog
185186
---------
186187

188+
- 13.01.2024 - 1.8.0 - added support for logging, escaping values of sensitive vars, refactoring
187189
- 21.07.2023 - 1.7.0 - [added support for backups via rsync](https://github.com/zevilz/WebServerCloudBackups/releases/tag/1.7.0)
188190
- 14.03.2022 - 1.6.2 - [added new parameters to mysqldump command](https://github.com/zevilz/WebServerCloudBackups/releases/tag/1.6.2) + gzip compression
189191
- 17.12.2020 - 1.6.1 - fixed archive filename for hourly backup period

0 commit comments

Comments
 (0)