Update README.md

Author: shadab-mohammad-oracle

README.md

@@ -2,30 +2,22 @@
 
 This project is a secure, lightweight SaaS-like database latency testing tool with a Mobile GUI, along with REST API.
 
-
-
 https://github.com/user-attachments/assets/74497e35-a85b-4051-bee0-99a3c1ed67d0
 
-
-
 Built with ❤️ using FastAPI.  
 
-
 ## 1. Clone Repository ##
 ```bash
 git clone https://github.com/oracle-quickstart/db-endpoint-latency-testing-ammeter.git && cd db-endpoint-latency-testing-ammeter/
 ```
-
 ## 2. Set `APP_ADMIN_PASS` environment variable ##
 ```bash
 export APP_ADMIN_PASS='abcd1234'
 ```
-
 ## 3. Quick Build with One-Command ##
 ```bash
  bash build.sh
 ```
-
 ## 4. Launch the Web App; Only required when you restart the App ##
 ```bash
 uvicorn app.main:app --host 0.0.0.0 --port 8000
@@ -55,9 +47,6 @@ curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
   -d period=10 \
   | jq .
 ```
-
-
-
 ## 7. Custom User SQL : API Usage via Curl/CLI MySQL Example ##
 
 To test with a custom SQL query from the command line, simply add a -d custom_sql="YOUR SQL HERE" parameter to your curl command, like this:
@@ -76,7 +65,6 @@ curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
   -d custom_sql="select count(*) from WIN2019SNAREDC_SNARE_IA;" \
   | jq .
 ```
-
 - If `custom_sql` is included (and not empty), that query is used for measuring latency (instead of `SELECT 1`).
 
 - All other parameters stay the same as before.
@@ -126,12 +114,10 @@ Stop the Delta App
 ```bash
 bash stop.sh
 ```
-
 Start the Delta App
 ```bash
 bash start.sh
 ```
-
 ## Windows Build File (Beta: Not tested)
 
 Yes, you must first download (clone or extract) the GitHub repo to your Windows machine.
@@ -145,22 +131,20 @@ __Instructions:__
      - Open Command Prompt or PowerShell.
      - Run:
 
-     ```javascript
+    ```javascript
       git clone https://github.com/oracle-quickstart/db-endpoint-latency-testing-ammeter.git
       cd db-endpoint-latency-testing-ammeter
      ```
-
    - Or download the zip from the GitHub releases or code page, and extract all files to a folder.
 
 2. __Run the Build Script__
 
    - In Command Prompt (NOT PowerShell), navigate to the project folder.
    - Run:
 
-   ```javascript
+  ```javascript
     build_windows.bat
    ```
-
    - This script will:
 
      - Create a virtual environment
@@ -175,6 +159,134 @@ __Requirements on Windows:__
 
 You do not need to manually install anything except Python and openssl; the script handles the rest.
 
+---
+
+# Testing Remote Databases Over SSH Tunnel and API
+
+This section shows how to set up SSH tunnels to connect to remote databases from your local machine, and how to test each supported database type using the REST API or the GUI.
+
+## SSH Tunnel Setup
+
+### Oracle Autonomous Database (ADB) SSH Tunnel
+```bash
+ssh -fNT -v -L 1522:10.180.2.238:1521 opc@168.138.10.135 -i "/Users/shadab/Downloads/OracleContent/Keys/mydemo_vcn.priv"
+```
+### Local Oracle DB SSH Tunnel
+```bash
+ssh -fNT -v -L 1521:10.180.2.158:1521 opc@168.138.10.135 -i "/Users/shadab/Downloads/OracleContent/Keys/mydemo_vcn.priv"
+```
+### PostgreSQL SSH Tunnel
+```bash
+ssh -fNT -v -L 5432:10.180.2.205:5432 opc@168.138.10.135 -i "/Users/shadab/Downloads/OracleContent/Keys/mydemo_vcn.priv"
+```
+### MySQL SSH Tunnel
+```bash
+ssh -fNT -v -L 3306:10.180.2.30:3306 opc@168.138.10.135 -i "/Users/shadab/Downloads/OracleContent/Keys/mydemo_vcn.priv"
+```
+## API Usage Examples
+
+### 1. PostgreSQL
+
+#### CLI
+```bash
+curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
+  -k \
+  -d dbtype=postgresql \
+  -d host=localhost \
+  -d port=5432 \
+  -d username=ggadmin \
+  -d password="RAbbithole1234##" \
+  -d database=dvdrental \
+  -d interval=1 \
+  -d period=5 \
+  | jq .
+```
+#### GUI
+<img width="458" alt="Screenshot 2025-07-05 at 11 02 13 PM" src="https://github.com/user-attachments/assets/528fe2d5-6f2f-45bd-bcf6-7ee1309fc51e" />
+
+
+---
+
+### 2. MySQL
+
+#### CLI
+```bash
+curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
+  -k \
+  -d dbtype=mysql \
+  -d host=localhost \
+  -d port=3306 \
+  -d username=admin \
+  -d password="RAbbithole1234##" \
+  -d database=dvdrental \
+  -d interval=1 \
+  -d period=5 \
+  | jq .
+```
+#### GUI
+<img width="458" alt="Screenshot 2025-07-05 at 11 02 20 PM" src="https://github.com/user-attachments/assets/d8895bcf-617c-447a-86d5-9ec65dba7476" />
+
+
+---
+
+### 3. Oracle (Standard/On-Premise)
+
+#### CLI
+```bash
+curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
+  -k \
+  -d dbtype=oracle \
+  -d host=localhost \
+  -d port=1521 \
+  -d username=mpos \
+  -d password="abcdABCD1234##" \
+  -d database=T1DB04 \
+  -d interval=1 \
+  -d period=5 \
+  | jq .
+```
+#### GUI
+<img width="376" alt="Screenshot 2025-07-05 at 11 42 13 PM" src="https://github.com/user-attachments/assets/880f58f8-3e09-40f1-9282-43341c7227a1" />
+
+
+---
+
+### 4. Oracle ADB (TLS/TCPS Connection)
+
+#### CLI
+```bash
+curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
+  -k \
+  -d dbtype=oracle \
+  -d host="(description= (retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=localhost))(connect_data=(service_name=g9b8049aad9c64c_spotlightdemo_high.adb.oraclecloud.com))(security=(ssl_server_dn_match=no)))" \
+  -d username=dvdrental \
+  -d password="RAbbithole1234##" \
+  -d interval=1 \
+  -d period=5 \
+  | jq .
+```
+#### GUI
+<img width="376" alt="Screenshot 2025-07-05 at 11 33 13 PM" src="https://github.com/user-attachments/assets/351897b5-2c8b-482b-8310-c6a0401d58d6" />
+
+---
+
+### 5. URL (HTTP/HTTPS Endpoint)
+
+#### CLI
+```bash
+curl -u admin:abcd1234 -X POST https://localhost:8000/api/test-latency \
+  -k \
+  -d dbtype=url \
+  -d url="https://google.com" \
+  -d interval=1 \
+  -d period=5 \
+  | jq .
+```
+#### GUI
+<img width="458" alt="Screenshot 2025-07-05 at 11 03 00 PM" src="https://github.com/user-attachments/assets/d97ee854-b7ff-4ee6-af5f-7c1fe127a281" />
+
+
+---
 
 ## Contributing