setup on Mac

Signed-off-by: Alexander Diemand <[email protected]>

README.md

@@ -1,26 +1,20 @@
 # Cardano Queries
 
-## querying the Cardano blockchain data in PostgreSQL
+[![read the docs](docs/images/BCA_Queries_256x256.png)](https://blockchain-data-analytics.github.io/Cardano_Queries/)
 
-The data is derived using [Db-sync](https://github.com/IntersectMBO/cardano-db-sync) from Cardano's main chain.
+<< documentation >>
 
 
-![BCA Queries Docker setup](docs/images/BCA%20Queries%20Docker%20images%20setup.png)
-
-
-We provide you with a complete setup containing all credentials to connect to our high-availability PostgreSQL servers.
-
-Prerequisites: you need to have [Docker](https://www.docker.com/products/docker-desktop/) installed.
-
-Depending on your location you may choose to connect to either:
+## signup
 
 | location | sponsorship tier | link |
 |----|----|----|
 | Europe 🇪🇺 |  $29 per month  | [select EU servers](https://github.com/sponsors/Blockchain-Data-Analytics/sponsorships?pay_prorated=true&tier_id=406906) |
 | North America 🇺🇸  | $28 per month | [select US servers](https://github.com/sponsors/Blockchain-Data-Analytics/sponsorships?pay_prorated=true&tier_id=406907) |
 
-Payment of the selected sponsorship gives you the right to use the service for up to a month. Renewal of the sponsorship extends the service period. And, cancellation of your sponsorship will also terminate the service at the end of the paid period. Please understand that we cannot reimburse you.
+Payment of the selected sponsorship gives you the right to use the service for up to a month. Renewal of the sponsorship extends the service period. Cancellation of your sponsorship will also terminate the service at the end of the paid period. Please understand that we cannot reimburse you.
 
 We cannot provide you with a strict SLA. But, we promise to keep the services alive and fix technical problems asap. We have decent monitoring in place and will be able to react to service disruption.
 
-See our [main page](https://github.com/Blockchain-Data-Analytics) for contact details.
+See our [main page](https://github.com/Blockchain-Data-Analytics) for contact details.
+

docs/00_main.md

@@ -1,5 +1,40 @@
 # Cardano Queries
 
+![Cardano Queries icon](images/BCA_Queries_512x512.png)
+
+## Content
+
+- [Signup to this service](#signup-for-this-service)
+- [Data source](#data-source)
+- [Setup Cardano Queries on your machine](#setup-cardano-queries-on-your-machine)
+- [How to run queries through this service](#how-to-run-queries-through-this-service)
+
+
+## Signup for this service
+
+Depending on your location you may choose to connect to either:
+
+| location | sponsorship tier | link |
+|----|----|----|
+| Europe 🇪🇺 |  $29 per month  | [select EU servers](https://github.com/sponsors/Blockchain-Data-Analytics/sponsorships?pay_prorated=true&tier_id=406906) |
+| North America 🇺🇸  | $28 per month | [select US servers](https://github.com/sponsors/Blockchain-Data-Analytics/sponsorships?pay_prorated=true&tier_id=406907) |
+
+Payment of the selected sponsorship gives you the right to use the service for up to a month. Renewal of the sponsorship extends the service period. And, cancellation of your sponsorship will also terminate the service at the end of the paid period. Please understand that we cannot reimburse you.
+
+We cannot provide you with a strict SLA. But, we promise to keep the services alive and fix technical problems asap. We have decent monitoring in place and will be able to react to service disruption.
+
+See our [main page](https://github.com/Blockchain-Data-Analytics) for contact details.
+
+
+## Data source
+
+The data is derived using [Db-sync](https://github.com/IntersectMBO/cardano-db-sync) from Cardano's main chain.
+
+We provide you with a complete setup containing all credentials to connect to our high-availability PostgreSQL servers.
+
+Prerequisites: you need to have [Docker](https://www.docker.com/products/docker-desktop/) installed.
+
+
 ## Setup Cardano Queries on your machine
 
 ### Windows ![Windows](images/win.png)
@@ -20,10 +55,13 @@ e.g. FreeBSD
 
 [other setup](04_setup_other.md)
 
-## Running queries in _pgAdmin_
+
+## How to run queries through this service
+
+### Running queries in _pgAdmin_
 
 [using pgAdmin](10_use_pgadmin.md)
 
-## Sending queries directly to PostgreSQL
+### Sending queries directly to PostgreSQL
 
 [PostgreSQL connection](20_direct_pg.md)

docs/02_setup_mac.md

@@ -3,4 +3,20 @@
 
 # Setup on macOS
 
-_TODO_
+## 1. extract the downloaded zip container
+
+and open the folder in _Finder_
+
+![Finder showing the folder of the extracted zip container](images/mac_setup00.png)
+
+
+
+## 2. start the services with "start.command"
+
+![starting services from the extracted zip container in a folder](images/mac_setup01.png)
+
+
+
+## 3. at some point, stop the services with "stop.command"
+
+![stopping services](images/mac_setup02.png)

docs/30_technical.md

@@ -0,0 +1,16 @@
+￪ [bach to main](00_main.md)
+
+
+# Technical information
+
+## Docker setup
+
+![BCA Queries Docker setup](docs/images/BCA%20Queries%20Docker%20images%20setup.png)
+
+We use `docker-compose` to create a convenient setup that works on all major platforms. 
+
+The connection between your machine and our servers is protected by an encrypted VPN. On our end we run a proxy in front of high-availability databases. The proxy listens on port 25432 and forwards to the PostgreSQL servers. It would also do failover in case one of the databases is offline.
+
+At the other end of the VPN connection in your machine this port 25432 is forwarded to internally 35432 and then exposed on your machine as port 5432 (this can be [changed](31_port_change.md)).
+
+The tool _pgAdmin_ can be accessed on http://localhost:5480. For its usage see [pgAdmin](10_use_pgadmin.md).

docs/31_port_change.md

@@ -0,0 +1,3 @@
+￪ [bach to main](00_main.md)
+
+