docs review

Co-authored-by: Copilot <copilot@github.com>

Author: walterwanderley

README.md

@@ -28,6 +28,7 @@ HA is a highly available SQLite cluster powered by an embedded NATS JetStream se
 - 📝 **Read/Write Replicas**: Create live local read/write replicas with [go-ha database/sql driver](https://github.com/litesql/go-ha)
 - 📚 **Read Replicas**: Create live local read replicas with [ha-sync SQLite extension](https://github.com/litesql/ha-sync)
 - 🔄 **Change Data Capture (CDC)**: Supports CDC for real-time data streaming
+- 🔌 **Proxy**: Proxy and replicate PostgreSQL or MySQL databases to the edge
 - ⚙️ **Cluster Modes**: Configure leader-based or leaderless clusters with custom conflict resolution strategies
 - 📚 **Cross-Shard Queries**: Execute queries across shards using SQL hints like `/*+ db=DSN */`
 - 🔄 **Transaction Undo**: Supports undo operations on committed transactions, allowing rollback to previous states
@@ -182,6 +183,20 @@ PGPASSWORD=ha psql -h localhost -U ha -p 5432
 mysql -h localhost --port 3306 -u ha
 ```
 
+## Proxy and Replicate Other Databases
+
+HA can proxy connections to PostgreSQL and MySQL databases, replicating their data to achieve high availability and enable faster queries.
+
+![HA Proxy Architecture](ha_proxy.png)
+
+### Proxy and Replicate PostgreSQL
+
+[PostgreSQL Example](https://github.com/litesql/ha/tree/main/examples/proxy-postgresql)
+
+### Proxy and Replicate MySQL
+
+[MySQL Example](https://github.com/litesql/ha/tree/main/examples/proxy-mysql)
+
 ## API Documentation
 
 - **HTTP API**: [https://litesql.github.io/ha/#5](https://litesql.github.io/ha/#5)

docker-compose-leaderless.yml

@@ -73,9 +73,10 @@ ghcr.io/litesql/ha:latest
 ```
 #### Cluster example
 
-- [Docker compose cluster](https://github.com/litesql/ha/blob/main/docker-compose.yml) example
+- [Docker compose cluster](https://github.com/litesql/ha/blob/main/examples/leader-based/docker-compose.yml) example
 
 ```sh
+cd examples/leader-based
 docker compose up
 ```
 
@@ -506,7 +507,14 @@ DDL commands (such as CREATE, ALTER, and DROP) are not affected by undo operatio
 | --leader-static | HA_LEADER_STATIC |    | Address of a static leader. This will disable the leader election |
 | --mysql-port| HA_MYSQL_PORT|       | Port to MySQL Wire Protocol Server  |
 | --mysql-user| HA_MYSQL_USER| ha    | MySQL Auth user  |
-| --mysql-pass| HA_MYSQL_PASS|       | MySQL Auth password  | 
+| --mysql-pass| HA_MYSQL_PASS|       | MySQL Auth password  |
+| --mysql-proxied | HA_MYSQL_PROXIED | | DSN of a source MySQL database to replicate into the local HA instance |
+| --mysql-include | HA_MYSQL_INCLUDE | `^db.*` | Regexp to include tables from the proxied MySQL database replication; empty means include all |
+| --mysql-exclude | HA_MYSQL_EXCLUDE | | Regexp to exclude tables from the proxied MySQL database replication |
+| --mysql-dump-bin| HA_MYSQL_DUMP_BIN | | Filesystem path to the mysqldump executable used for proxied MySQL import. Example: /usr/bin/mysqldump |
+| --mysql-dump-db | HA_MYSQL_DUMP_DB | | Database name used for mysqldump when importing from the proxied MySQL source |
+| --mysql-dump-include | HA_MYSQL_DUMP_INCLUDE | |Table filter to pass to mysqldump during proxied MySQL import |
+| --mysql-proxy-id | HA_MYSQL_PROXY_ID | sqlite-ha | Identifier for this proxied MySQL connection, used in replication metadata |
 | --nats-logs | HA_NATS_LOGS | false | Enable embedded NATS Server logging |
 | --nats-port | HA_NATS_PORT | 4222 | Embedded NATS server port (0 to disable) |
 | --nats-store-dir | HA_NATS_STORE_DIR | /tmp/nats | Embedded NATS server store directory |
@@ -518,6 +526,12 @@ DDL commands (such as CREATE, ALTER, and DROP) are not affected by undo operatio
 | --pg-pass | HA_PG_PASS | ha   | PostgreSQL Auth password |
 | --pg-cert | HA_PG_CERT |      | Path to PostgreSQL TLS certificate file |
 | --pg-key  | HA_PG_KEY  |      | Path to PostgreSQL TLS key file |
+| --pg-proxied | HA_PG_PROXIED | |DSN of the source PostgreSQL database to replicate from and proxy to |
+| --pg-publication | HA_PG_PUBLICATION | ha_publication | Name of the publication in the source PostgreSQL database for logical replication (used only when --pg-proxied is specified) |
+| --pg-slot | HA_PG_SLOT | ha_slot | Name of the replication slot to create in the source PostgreSQL database (used only when --pg-proxied is specified) |
+| --proxy-local | HA_PROXY_LOCAL | ha.db | Path to the local SQLite database file that proxies the source database (used only when --pg-proxied or --mysql-proxied is set) |
+| --proxy-use-schema | HA_PROXY_USE_SCHEMA | false | Create local tables using the schema from the source database (used only when --pg-proxied or --mysql-proxied is set) |
+| --proxy-disable-redirect | HA_PROXY_DISABLE_REDIRECT | false | Disable redirecting queries to the source database; all queries will run on the local HA SQLite database (used only when --pg-proxied or --mysql-proxied is set) |
 | --concurrent-queries | HA_CONCURRENT_QUERIES | 50 | Number of concurrent queries (DB pool max) |
 | --extensions | HA_EXTENSIONS |  | Comma-separated list of SQLite extensions path to load |
 | --async-replication | HA_ASYNC_REPLICATION | false | Enables asynchronous replication message publishing |

docker-compose.yml

@@ -2,7 +2,7 @@ services:
   node1:
     image: ghcr.io/litesql/ha:latest
     volumes:
-      - ./testdata:/etc/nats
+      - ./conf:/etc/nats
       - node1_data:/data
     ports:
       - "3306:3306"
@@ -25,7 +25,7 @@ services:
   node2:
     image: ghcr.io/litesql/ha:latest
     volumes:
-      - ./testdata:/etc/nats
+      - ./conf:/etc/nats
       - node2_data:/data
     ports:
       - "3307:3306"
@@ -47,7 +47,7 @@ services:
   node3:
     image: ghcr.io/litesql/ha:latest
     volumes:
-      - ./testdata:/etc/nats
+      - ./conf:/etc/nats
       - node3_data:/data
     ports:
       - "3308:3306"

docs/index.markdown

@@ -0,0 +1,21 @@
+server_name=node1
+listen=4222
+
+accounts: {
+  $SYS: {
+    users: [{user: sys, password: sys}]
+  }
+}
+
+jetstream {
+  store_dir=/data/nats/n1
+}
+
+cluster {
+  name: HA
+  listen: 0.0.0.0:6222
+  routes: [
+    nats-route://node2:6222
+    nats-route://node3:6222
+  ]
+}

testdata/node1.cfg examples/leader-based/conf/node1.cfgtestdata/node1.cfg renamed to examples/leader-based/conf/node1.cfg

@@ -0,0 +1,21 @@
+server_name=node2
+listen=4222
+
+accounts: {
+  $SYS: {
+    users: [{user: sys, password: sys}]
+  }
+}
+
+jetstream {
+  store_dir=/data/nats/n2
+}
+
+cluster {
+  name: HA
+  listen: 0.0.0.0:6222
+  routes: [
+    nats-route://node1:6222
+    nats-route://node3:6222
+  ]
+}