From d5991433e37d29f7d083f72af3fc636a8135a738 Mon Sep 17 00:00:00 2001 From: smitchell41 <42743287+smitchell41@users.noreply.github.com> Date: Mon, 9 Aug 2021 17:40:59 -0400 Subject: [PATCH] Update README.md Practicing technical writing. --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 433e5efa..394cc9ae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # High Availability Postgres on Fly -This is a ready to go HA Postgres app that runs on Fly. +This is a ready-to-go HA Postgres app that runs on Fly. ## Prepare your app @@ -8,12 +8,14 @@ This is a ready to go HA Postgres app that runs on Fly. Init gets you going with a Fly application and generates a config file. ### Set secrets -This app requires `SU_PASSWORD` and `REPL_PASSWORD` environment variables. +This app requires `SU_PASSWORD` and `REPL_PASSWORD` environment variables and gives users the option to create a "root" account on new database clusters using 'OPERATOR_PASSWORD'. -`SU_PASSWORD` is the PostgreSQL super user password, the username is `flypgadmin`. You can use this to administer the database once it's running. You should create less privileged users for your applications to use. +`SU_PASSWORD` is the PostgreSQL super user password, and the username is `flypgadmin`. You can use this to administer the database once it's running. You should create less privileged users for your applications to use. `REPL_PASSWORD` is used to replicate between instances. +'OPERATOR_PASSWORD' is used to create a "root" user when a cluster is initialized. + > `flyctl secrets set SU_PASSWORD= REPL_PASSWORD=` ## Deploy one instance @@ -29,4 +31,4 @@ This app requires `SU_PASSWORD` and `REPL_PASSWORD` environment variables. ## Add a replica in another region 1. `flyctl volumes create pg_data --region syd --size 10` -2. `flyctl scale count 2` \ No newline at end of file +2. `flyctl scale count 2`