Update packages

mostafa · mostafa · commit bad2ab1372ed · 2024-04-16T11:21:56.000+02:00
Update docs
Update timestamps
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -78,7 +78,7 @@ GEM
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.7)
     builder (3.2.4)
     colorator (1.1.0)
     concurrent-ruby (1.2.3)
@@ -149,7 +149,7 @@ GEM
       jekyll (>= 3.7, < 5.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
-    just-the-docs (0.8.1)
+    just-the-docs (0.8.2)
       jekyll (>= 3.8.5)
       jekyll-include-cache
       jekyll-seo-tag (>= 2.0)
@@ -177,7 +177,7 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.22.2)
+    minitest (5.22.3)
     multi_xml (0.6.0)
     mutex_m (0.2.0)
     net-http (0.4.1)
@@ -189,12 +189,12 @@ GEM
       net-protocol
     net-protocol (0.2.2)
       timeout
-    net-smtp (0.4.0.1)
+    net-smtp (0.5.0)
       net-protocol
-    nio4r (2.7.0)
-    nokogiri (1.16.2-arm64-darwin)
+    nio4r (2.7.1)
+    nokogiri (1.16.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.2-x86_64-linux)
+    nokogiri (1.16.4-x86_64-linux)
       racc (~> 1.4)
     octokit (8.1.0)
       base64
@@ -205,9 +205,9 @@ GEM
     posix-spawn (0.3.15)
     psych (5.1.2)
       stringio
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     racc (1.7.3)
-    rack (3.0.9.1)
+    rack (3.0.10)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -244,21 +244,20 @@ GEM
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
       zeitwerk (~> 2.6)
-    rake (13.1.0)
+    rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rdoc (6.6.2)
+    rdoc (6.6.3.1)
       psych (>= 4.0.0)
-    reline (0.4.3)
+    reline (0.5.1)
       io-console (~> 0.5)
     rexml (3.2.6)
-    rouge (4.2.0)
+    rouge (4.2.1)
     safe_yaml (1.0.5)
-    sass-embedded (1.71.1-arm64-darwin)
-      google-protobuf (~> 3.25)
-    sass-embedded (1.71.1-x86_64-linux-gnu)
-      google-protobuf (~> 3.25)
+    sass-embedded (1.69.5)
+      google-protobuf (~> 3.23)
+      rake (>= 13.0.0)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
diff --git a/developing-plugins/grpc-api-reference.md b/developing-plugins/grpc-api-reference.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: gRPC API Reference
 description: GatewayD exposes a gRPC API that can be used to interact with the GatewayD plugin system. This API can be used by the GatewayD plugins and is available in the GatewayD SDK.
diff --git a/developing-plugins/index.md b/developing-plugins/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Developing Plugins
 nav_order: 4
diff --git a/developing-plugins/plugin-developers-guide.md b/developing-plugins/plugin-developers-guide.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Plugin Developers Guide
 description: Plugin developers' guide of GatewayD
diff --git a/developing-plugins/sdk-reference.md b/developing-plugins/sdk-reference.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: SDK Reference
 description: The GatewayD plugin SDK provides a number of interfaces, structs and methods to help you build your plugin.
diff --git a/developing-plugins/template-projects.md b/developing-plugins/template-projects.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Template Projects
 description: Template projects can be used to quickly get started with developing plugins.
diff --git a/getting-started/index.md b/getting-started/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Getting Started
 nav_order: 1
diff --git a/getting-started/installation.md b/getting-started/installation.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Installation
 description: How to install GatewayD and its plugins on different platforms and how to build it from source.
diff --git a/getting-started/running-gatewayd.md b/getting-started/running-gatewayd.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Running GatewayD
 description: How to run GatewayD and test it with psql
diff --git a/getting-started/welcome.md b/getting-started/welcome.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 09:17:27
 layout: default
 title: Welcome
 description: Introduction to GatewayD and its key features
@@ -18,9 +18,9 @@ This documentation will help you go from a beginner to an advanced user and deve
 
 ## What is GatewayD
 
-GatewayD is a free and open-source cloud-native database gateway and framework for building data-driven applications. It sits between your database servers and clients and proxies all their communication. It is like API gateways, but for databases.
+GatewayD is a free and open-source cloud-native database gateway and framework for building data-driven applications. It is a middleware that sits between your database servers and clients and proxies all their communication. It is like API gateways in system design, but instead is used for proxying database traffic, rather than HTTP traffic.
 
-GatewayD is an [L4](https://en.wikipedia.org/wiki/Transport_layer) proxy for SQL databases and clients. You can either write your own plugins or make use of our built-in, community and enterprise plugins.
+GatewayD is an [L4](https://en.wikipedia.org/wiki/Transport_layer) proxy for SQL, and eventually NoSQL, databases and clients. The core is database-protocol-agnotic, and the plugins encode, decode and add value to the database traffic flow, hence it can technically support all databases. You can either write your own plugins or make use of our built-in, community and enterprise plugins.
 
 Using GatewayD, you can see through the queries and the data passing between your database server and clients, and take action. For example, you can cache the result of SQL SELECT queries or detect and prevent SQL injection attacks.
 
@@ -42,19 +42,27 @@ GatewayD users are typically developers, DBAs, DBREs, security engineers, compli
 
 - **L4 database gateway**
 
-    GatewayD is optimized for proxying SQL databases and clients.
+    GatewayD is optimized for proxying SQL databases and clients, but proxying is not the main use case, rather an enabler. GatewayD can be used as a database gateway for SQL databases and clients. It can be used to monitor, cache, detect and prevent SQL injection attacks, and more.
 
 - **Caching results of queries**
 
     The [gatewayd-plugin-cache](/plugins/gatewayd-plugin-cache) is a free and open-source plugin that parses PostgreSQL database traffic, extracts the SELECT query and caches its response with a TTL. Further queries will be served from the cached results. TTL, Upsert, delete, alter and drop statements invalidate cached results.
 
-- **Advanced caching** (WIP)
+- **Run JavaScript code to manipulate traffic**
+
+    The [`gatewayd-plugin-js`](/plugins/gatewayd-plugin-js) is a free and open-source plugin that allows you to run JavaScript functions as hooks. It is a great way to get started with manipulating traffic in GatewayD.
+
+- **Detect and prevent SQL injection attacks**
+
+    The `gatewayd-plugin-sql-ids-ips` is an enterprise plugin that uses a deep-learning model trained with lots of SQL injection attack patterns. It can detect SQL injection attacks and take immediate and preventive actions to stop attackers from compromising your database and your precious data. It differs from WAFs in that it works with database traffic and not just user input, meaning that it has access to the entirety of the query and other messages, thus it can detect and prevent attacks that WAFs can't.
+
+- **Advanced caching using Write-Ahead-Log** (WIP)
 
     The `gatewayd-plugin-cache-advanced` is an enterprise plugin that works like its free and open-source counterpart, except it monitors the Write-Ahead-Log (WAL) of PostgreSQL for invalidating cached results. Even if a client accesses the database directly and changes something, the plugin checks the WAL and invalidates all the matching cached results immediately.
 
-- **SQL injection detection and prevention** (WIP)
+- **Change data capture** (WIP)
 
-    The `gatewayd-plugin-sql-ids-ips` is an enterprise plugin that uses a deep-learning model trained with lots of SQL injection attack patterns. It can detect SQL injection attacks and take immediate and preventive actions to stop attackers from compromising your database and your precious data.
+    The `gatewayd-plugin-cdc` is an enterprise plugin that captures changes happening in the database and sends them to another database or message broker like Kafka. It can be used for seamless logical replication and building real-time data pipelines, data warehousing, and more.
 
 These are just a few examples and the list is not exhaustive, as new plugins are constantly developed.
 
@@ -64,6 +72,6 @@ GatewayD is not a silver bullet and won't solve all your database problems overn
 
 You still have to design and normalize your database schema, take and test backups, secure your database and do whatever you used to do before GatewayD. GatewayD came into existence to fix the black box mentality that surrounds databases to this very day.
 
-Over time many plugins will be developed either by us or the community that will try to solve different issues arose from utilizing databases.
+Over time many plugins will be developed either by us or the community that will try to solve many of the problems that you face with databases.
 
 GatewayD is originally designed to be database-neutral, and proxy traffic to and from SQL and NoSQL databases. However, for practicality reasons, we focused on PostgreSQL at the moment. We will be working towards adding support for other SQL and NoSQL databases in the future.
diff --git a/miscellaneous/glossary.md b/miscellaneous/glossary.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Glossary
 description: Glossary of GatewayD terms
diff --git a/miscellaneous/index.md b/miscellaneous/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Miscellaneous
 nav_order: 6
diff --git a/miscellaneous/telemetry-and-usage-report.md b/miscellaneous/telemetry-and-usage-report.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Telemetry and Usage Report
 description: Telemetry and usage report of GatewayD
diff --git a/plugins/gatewayd-plugin-cache.md b/plugins/gatewayd-plugin-cache.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: gatewayd-plugin-cache
 description: GatewayD plugin for caching query results in Redis.
diff --git a/plugins/gatewayd-plugin-js.md b/plugins/gatewayd-plugin-js.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: gatewayd-plugin-js
 description: GatewayD plugin for running JS functions as hooks.
diff --git a/plugins/index.md b/plugins/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Plugins
 nav_order: 5
diff --git a/using-gatewayd/API.md b/using-gatewayd/API.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: API
 description: GatewayD exposes a gRPC API with an HTTP gateway for querying and managing the `gatewayd` process and its plugins.
diff --git a/using-gatewayd/Act.md b/using-gatewayd/Act.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-21 22:50:22
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Act
 description: Act is a policy engine that supports signals, policies and actions. It is used to automate the execution of business rules.
diff --git a/using-gatewayd/CLI.md b/using-gatewayd/CLI.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: CLI
 description: GatewayD is a CLI application that runs on Windows, Linux-based distributions and macOS.
diff --git a/using-gatewayd/clients.md b/using-gatewayd/clients.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Clients
 description: Client object is a client that can connect to the database servers over TCP, UDP and Unix Domain Socket.
diff --git a/using-gatewayd/configuration.md b/using-gatewayd/configuration.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Configuration
 description: GatewayD is fully configurable via various sources, including default values, YAML config files, environment variables, CLI flags and plugins.
diff --git a/using-gatewayd/connection-lifecycle.md b/using-gatewayd/connection-lifecycle.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Connection Lifecycle
 description: Connection Lifecycle of GatewayD
diff --git a/using-gatewayd/global-configuration/api.md b/using-gatewayd/global-configuration/api.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: API
 description: GatewayD gRPC API configuration
diff --git a/using-gatewayd/global-configuration/clients.md b/using-gatewayd/global-configuration/clients.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Clients
 description: GatewayD client configuration
diff --git a/using-gatewayd/global-configuration/index.md b/using-gatewayd/global-configuration/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Global Configuration
 nav_order: 2
diff --git a/using-gatewayd/global-configuration/loggers.md b/using-gatewayd/global-configuration/loggers.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Loggers
 description: GatewayD logger configuration
diff --git a/using-gatewayd/global-configuration/metrics.md b/using-gatewayd/global-configuration/metrics.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Metrics
 description: GatewayD metrics configuration
diff --git a/using-gatewayd/global-configuration/pools.md b/using-gatewayd/global-configuration/pools.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Pools
 description: GatewayD pool configuration
diff --git a/using-gatewayd/global-configuration/proxies.md b/using-gatewayd/global-configuration/proxies.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Proxies
 description: GatewayD proxy configuration
diff --git a/using-gatewayd/global-configuration/servers.md b/using-gatewayd/global-configuration/servers.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Servers
 description: GatewayD server configuration
diff --git a/using-gatewayd/index.md b/using-gatewayd/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Using GatewayD
 nav_order: 2
diff --git a/using-gatewayd/observability.md b/using-gatewayd/observability.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Observability
 description: Observability is a first-class citizen of GatewayD. It generates logs, metrics and traces to make it easier to see what is going on inside.
diff --git a/using-gatewayd/plugins-configuration/general-configurations.md b/using-gatewayd/plugins-configuration/general-configurations.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-21 22:49:26
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: General configurations
 description: General configurations for plugins
diff --git a/using-gatewayd/plugins-configuration/index.md b/using-gatewayd/plugins-configuration/index.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Plugins Configuration
 nav_order: 3
diff --git a/using-gatewayd/plugins-configuration/plugins-configuration.md b/using-gatewayd/plugins-configuration/plugins-configuration.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Plugins configuration
 description: GatewayD plugins configuration
diff --git a/using-gatewayd/pools.md b/using-gatewayd/pools.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Pools
 description: GatewayD has a generic internal pool object that is used to manage plugins and connections.
diff --git a/using-gatewayd/protocols.md b/using-gatewayd/protocols.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Protocols
 description: GatewayD is application layer protocol-agnostic. This means that GatewayD *can* practically support any protocol in the application layer, or L7.
diff --git a/using-gatewayd/proxies.md b/using-gatewayd/proxies.md
@@ -1,5 +1,5 @@
 ---
-last_modified_date: 2024-03-10 23:57:06
+last_modified_date: 2024-04-16 08:43:06
 layout: default
 title: Proxies
 description: Proxy object is used to create a binding between incoming connections from the database clients to the database servers.
diff --git a/using-gatewayd/servers.md b/using-gatewayd/servers.md
diff --git a/using-plugins/hook-registry.md b/using-plugins/hook-registry.md
diff --git a/using-plugins/hooks.md b/using-plugins/hooks.md
diff --git a/using-plugins/index.md b/using-plugins/index.md
diff --git a/using-plugins/plugin-registry.md b/using-plugins/plugin-registry.md
diff --git a/using-plugins/plugin-types.md b/using-plugins/plugin-types.md
diff --git a/using-plugins/plugins.md b/using-plugins/plugins.md
diff --git a/using-plugins/proposals.md b/using-plugins/proposals.md
