Skip to content

Commit

Permalink
add readme warning
Browse files Browse the repository at this point in the history
  • Loading branch information
PiyushRaj927 committed Sep 3, 2023
1 parent 504b0d3 commit 0dfe584
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@ terraform destroy -target module.warpsql-containers

### AWS
WarpSQL provides a streamlined approach to deploying and managing PostgreSQL databases on AWS EC2 instances, complete with a disaster recovery solution powered by Barman.
> **Warning**
WarpSQL is a work in progress, and the current setup allows public SSH access to instances, which might not be secure.

To get started, ensure you have your AWS credentials set up and Terraform installed.

To launch WarpSQL with Barman, run:
Expand All @@ -133,6 +136,8 @@ During any subsequent launches of the WarpSQL instance, the data is recovered fr

To specify the size of each instance's disk, provide the desired size in gigabytes to the respective variables: `warpsql_disk_size`, `ansible_disk_size`, and `barman_disk_size` in the terraform script.

You can also set the password for the Postgres instance by using the `warpsql_password` variable in the Terraform script.

The Barman images are based on [ubc/barman-docker](https://github.com/ubc/barman-docker). By default, Barman performs a base backup according to the cron schedule `0 4 * * *`. If you need to modify this schedule, refer to the environment variables documentation at https://github.com/ubc/barman-docker#environment-variables.

## Contribution
Expand Down

0 comments on commit 0dfe584

Please sign in to comment.