diff --git a/connectors/aws-s3/README.md b/connectors/aws-s3/README.md index d11da2ab..324ac867 100644 --- a/connectors/aws-s3/README.md +++ b/connectors/aws-s3/README.md @@ -26,7 +26,7 @@ connections: access_key_id: {{YOUR_ACCESS_KEY}} secret_access_key: {{YOUR_SECRET_KEY}} region: {{YOUR_REGION}} - bucket_name: aws-s3-sample-stock-data-dozer + bucket_name: dozer-samples tables: - !Table name: stocks @@ -39,7 +39,7 @@ connections: 3. **Running Dozer**: Start Dozer by running the following command in the terminal: ```bash - dozer -c dozer-config.yaml + dozer run -c dozer-config.yaml ``` 4. **Querying the Dozer APIs**: Query the Dozer endpoints to get the results of your SQL queries. You can query the cache using gRPC or REST. @@ -74,7 +74,7 @@ dozer cloud deploy -s AWS_ACCESS_KEY=$AWS_ACCESS_KEY -s AWS_SECRET_KEY=$AWS_SECR ## Querying data ```bash -curl -H "X-Dozer-App-Id: " https://dataW.getdozer.io:443 ``` +curl -H "X-Dozer-App-Id: " https://data.getdozer.io:443 ``` ## Additional Information diff --git a/connectors/mongodb/README.md b/connectors/mongodb/README.md index 6126e435..514ed3c5 100644 --- a/connectors/mongodb/README.md +++ b/connectors/mongodb/README.md @@ -4,10 +4,12 @@ This README provides instructions for setting up a Mongo DB instance and loading ## Prerequisites -1. Log into MongoDB Atlas and create a new cluster. You can follow the instructions [here](https://docs.atlas.mongodb.com/tutorial/create-new-cluster/). -2. Load the sample data into the cluster. You can follow the instructions [here](https://www.mongodb.com/docs/atlas/sample-data/sample-analytics/). -3. Allow access to the cluster from anywhere. You can follow the instructions [here](https://docs.atlas.mongodb.com/security/ip-access-list/). -4. Setup Dozer with MongoDB enabled. You can follow the instructions +1. Create a MongoDB account by visiting the [MongoDB website](https://www.mongodb.com/cloud/atlas) and signing up for an account. +2. Once logged in, navigate to the MongoDB web interface to create a new project. +3. Load the sample data into the cluster. You can follow the instructions [here](https://www.mongodb.com/docs/atlas/sample-data/sample-analytics/). +4. Allow access to the cluster from anywhere. You can follow the instructions [here](https://docs.atlas.mongodb.com/security/ip-access-list/). +5. Grab the connection string from the cluster. You can follow the instructions [here](https://docs.atlas.mongodb.com/tutorial/connect-to-your-cluster/). +6. Setup Dozer with MongoDB enabled. You can follow the instructions ```bash cargo install --path dozer-cli --features mongodb --locked ``` @@ -16,6 +18,25 @@ cargo install --path dozer-cli --features mongodb --locked 1. Running dozer with the following command in the terminal: ```bash -dozer run --enable-progress +dozer run ``` +## Dozer Cloud + +### To validate your config file before deploying + +```bash +dozer build +``` + +### To deploy your config file + +```bash +dozer cloud`deploy -c dozer-config.yaml +``` + +### To use environment variables in the config file + +```bash +dozer cloud deploy -s MONGODB_CONNECTION_STRING +``` diff --git a/connectors/mysql/README.md b/connectors/mysql/README.md index 1ab41d6a..4bc45425 100644 --- a/connectors/mysql/README.md +++ b/connectors/mysql/README.md @@ -226,19 +226,23 @@ For more about gRPC in Dozer, see [Using gRPC APIs](https://getdozer.io/docs/que 2. Pass in the credentials in the config file 3. Run the following command to deploy the app on Dozer Cloud + + +### Validate the Config file before deploying + ```bash -dozer cloud deploy +dozer build ``` ### Deploy with environment variables ```bash - dozer cloud deploy -s EC2_INSTANCE_DNS=$EC2_INSTANCE_DNS + dozer cloud deploy -s MYSQL_URL ``` ## Query data on cloud ```bash -curl -H "X-Dozer-App-Id: " https://dataW.getdozer.io:443 +curl -H "X-Dozer-App-Id: " https://data.getdozer.io:443 ``` diff --git a/connectors/postgres/README.md b/connectors/postgres/README.md index 0233e75e..b8bad112 100644 --- a/connectors/postgres/README.md +++ b/connectors/postgres/README.md @@ -96,7 +96,16 @@ To deploy Dozer on the cloud, you can use the following steps: 3. Put the details in the `dozer-config.yaml` file 4. Run the following command to start Dozer: + +### Validate the Config file before deploying + +```bash +dozer build +``` + + To use environment variables while deploying + ```bash dozer cloud deploy -s POSTGRES_HOST=$POSTGRES_HOST -s POSTGRES_USER=$POSTGRES_USER -s POSTGRES_PASSWORD=$POSTGRES_PASSWORD -s POSTGRES_DATABASE=$POSTGRES_DATABASE ``` @@ -104,6 +113,5 @@ dozer cloud deploy -s POSTGRES_HOST=$POSTGRES_HOST -s POSTGRES_USER=$POSTGRES_US 4. To query the data ```bash -curl -H "X-Dozer-App-Id: " https://dataW.getdozer.io:443 -``` - +curl -H "X-Dozer-App-Id: " https://data.getdozer.io:443 +``` \ No newline at end of file diff --git a/connectors/snowflake/README.md b/connectors/snowflake/README.md index bd063221..2bbf5c64 100644 --- a/connectors/snowflake/README.md +++ b/connectors/snowflake/README.md @@ -14,6 +14,14 @@ export SN_ROLE= ## Dozer Cloud +### Validate the Config file before deploying + +```bash +dozer build +``` + +### To deploy + ```bash dozer cloud deploy ``` diff --git a/connectors/supabase/README.md b/connectors/supabase/README.md index a9321390..2a551093 100644 --- a/connectors/supabase/README.md +++ b/connectors/supabase/README.md @@ -26,8 +26,10 @@ That's all to it. This process will run `dozer app` and `dozer api` server separ 4. Run the following command to deploy the app on Dozer Cloud +### To validate your config file before deploying + ```bash -dozer cloud deploy +dozer build ``` ### Deploy with environment variables