Skip to content

Commit c4884ad

Browse files
committed
updated readme
1 parent b1b1b77 commit c4884ad

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414

1515
## Prerequisites
1616

17-
- Docker
18-
- Docker Compose
17+
- bash and sudo privilege
1918
- AWS S3 bucket and credentials
19+
- Rest will be installed at the runtime
2020

2121
## Installation
2222

@@ -45,18 +45,10 @@
4545
3. **Build and Run the Docker Container:**
4646

4747
```bash
48-
sudo ./init.sh /path/to/backup/volume
48+
chmod +x ./xbackup.sh
49+
sudo ./xbackup.sh start
4950
```
5051

51-
## Usage
52-
53-
The `init.sh` script sets up Docker, installs necessary packages, and configures the backup environment. It will:
54-
55-
1. Install Docker if it's not already installed.
56-
2. Configure the Docker repository and install Docker CE.
57-
3. Start and enable the Docker service.
58-
4. Launch the Docker Compose setup for `xbackup`.
59-
6052
### Backup Scheduling
6153

6254
Backups are managed using cron jobs defined in the `docker-compose.yml` file. Modify the cron job schedule as needed:
@@ -72,7 +64,11 @@ CRON_TIME="0 */3 * * *"
7264
To restore a backup, download the backup files from S3 and use `xtrabackup` to apply logs and restore the database:
7365

7466
```bash
75-
sudo docker exec xbackup /usr/local/bin/prepare.sh
67+
./xbackup.sh load # it'll download the backup from s3
68+
# check everything is correct and correctly downloaded/decompressed
69+
70+
# move the backup into the data dir
71+
./xbackup.sh apply
7672
```
7773

7874
## Contributing

0 commit comments

Comments
 (0)