From 830d3959b71250dfef6a9379b74a57798d5ff712 Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Mon, 30 Mar 2020 13:08:55 +0530 Subject: [PATCH] docs: add info about backup command in readme --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 2a9e26d0..860ceaac 100644 --- a/README.md +++ b/README.md @@ -214,6 +214,9 @@ Environment Variables - `SITES` is list of sites separated by `:` colon to migrate. e.g. `SITES=site1.domain.com` or `SITES=site1.domain.com:site2.domain.com` By default all sites in bench will be backed up. - `WITH_FILES` if set to 1, it will backup user-uploaded files. +- By default `backup` takes mariadb dump and gzips it. Example file, `20200325_221230-test_localhost-database.sql.gz` +- If `WITH_FILES` is set then it will also backup public and private files of each site as uncompressed tarball. Example files, `20200325_221230-test_localhost-files.tar` and `20200325_221230-test_localhost-private-files.tar` +- All the files generated by backup are placed at volume location `sites/{site-name}/private/backups/*` ```sh docker exec -it \