updated documentation to give instructions on adding databases

README.md

@@ -18,6 +18,12 @@ CHT sync has been specifically designed to work in both local development enviro
 
 The local environment setup involves starting Logstash, PostgreSQL, PostgREST, DBT, and CouchDB. This configuration facilitates data synchronization, transformation, and storage for local development and testing. Fake data is generated for CouchDB. The required environment variables can be found in the `env.template` file, which should be customized accordingly for the specific deployment needs.
 
+1. Provide the databases you want to sync in the `.env` file:
+
+```
+COUCHDB_DBS=<dbs-to-sync> # space sperated list of databases you want to sync e.g "medic medic_sentinel"
+```
+
 ```sh
 # starts: logstash, superset, postgres, postgrest,  data-generator, couchdb and dbt
 npm install
@@ -34,6 +40,8 @@ The gamma environment setup involves starting Logstash, PostgreSQL, PostgREST, a
 # project wide: optional
 COMPOSE_PROJECT_NAME=pipeline
 
+COUCHDB_DBS=<dbs-to-sync> # space sperated list of databases you want to sync e.g "medic medic_sentinel"
+
 # couchdb and logstash: required environment variables for 'gamma', 'prod' and 'local'
 COUCHDB_PASSWORD=<your-couchdb-password>
 COUCHDB_SECURE=false
@@ -56,6 +64,8 @@ The production environment setup involves starting Logstash, PostgREST, and DBT.
 # project wide: optional
 COMPOSE_PROJECT_NAME=pipeline
 
+COUCHDB_DBS=<dbs-to-sync> # space sperated list of databases you want to sync e.g "medic medic_sentinel"
+
 # postgrest and pogresql: required environment variables for 'gamma', prod and 'local'
 POSTGRES_USER=<your-postgres-user>
 POSTGRES_PASSWORD=<your-postgres-password>

env.template

@@ -17,7 +17,7 @@ CHT_PIPELINE_BRANCH_URL=https://github.com/medic/cht-pipeline.git#main
 # couchdb and logstash: required environment variables for 'gamma', 'prod' and 'local'
 COUCHDB_USER=test
 COUCHDB_PASSWORD=test
-COUCHDB_DBS="medic medic_sentinel"
+COUCHDB_DBS="medic medic_sentinel" # space sperated list of databases you want to sync e.g "medic medic_sentinel"
 COUCHDB_HOST=couchdb
 COUCHDB_PORT=5984
 COUCHDB_SECURE=false